Merge pull request #4330 from mheon/update_vol_create_docs

Add documentation on options to volume create manpage
This commit is contained in:
OpenShift Merge Robot 2019-10-24 15:12:51 +02:00 committed by GitHub
commit 43b1c2fa68
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -30,6 +30,13 @@ Set metadata for a volume (e.g., --label mykey=value).
**-o**, **--opt**=*option*
Set driver specific options.
For the default driver, `local`, this allows a volume to be configured to mount a filesystem on the host.
For the `local` driver the following options are supported: `type`, `device`, and `o`.
The `type` option sets the type of the filesystem to be mounted, and is equivalent to the `-t` flag to **mount(8)**.
The `device` option sets the device to be mounted, and is equivalent to the `device` argument to **mount(8)**.
The `o` option sets options for the mount, and is equivalent to the `-o` flag to **mount(8)** with two exceptions.
The `o` option supports `uid` and `gid` options to set the UID and GID of the created volume that are not normally supported by **mount(8)**.
Using volume options with the `local` driver requires root privileges.
## EXAMPLES
@ -40,11 +47,13 @@ $ podman volume create
$ podman volume create --label foo=bar myvol
$ podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=nodev,noexec myvol
# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=nodev,noexec myvol
# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=uid=1000,gid=1000 testvol
```
## SEE ALSO
podman-volume(1)
podman-volume(1), mount(8)
## HISTORY
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>