Skip to content

Commit

Permalink
document nfs usage
Browse files Browse the repository at this point in the history
  • Loading branch information
gautierdag committed Mar 26, 2024
1 parent 9f568c8 commit ab73ed1
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,23 @@ print(job.generate_yaml())
job.run()
```

#### NFS partition

You can mount an NFS partition to the Kubernetes Job by specifying the NFS server address, path, and mount options.

```python
from kubejobs.jobs import KubernetesJob

job = KubernetesJob(
...
volume_mounts={
"nfs": {"mountPath": "/nfs", "server": "10.24.1.255", "path": "/"}
},
)
```
Note that both `server` and `path` are required fields for the NFS volume mount.


### create_jobs_for_experiments

The create_jobs_for_experiments function allows you to create and run a series of Kubernetes Jobs for a list of commands. This can be helpful for running multiple experiments or tasks with different parameters in parallel.
Expand Down

0 comments on commit ab73ed1

Please sign in to comment.