summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-10-24 15:12:51 +0200
committerGitHub <noreply@github.com>2019-10-24 15:12:51 +0200
commit43b1c2fa68d7a1d7197b2fc07b605573dc0ea960 (patch)
tree80262fe9c0bab8882cbe48273022dd7c1d93a78a
parent674dc2bc750161ab19db79417db1831af45b0c75 (diff)
parentdaadfe97448f041ee4cda0acbf3369ab9f0d5cd7 (diff)
downloadpodman-43b1c2fa68d7a1d7197b2fc07b605573dc0ea960.tar.gz
podman-43b1c2fa68d7a1d7197b2fc07b605573dc0ea960.tar.bz2
podman-43b1c2fa68d7a1d7197b2fc07b605573dc0ea960.zip
Merge pull request #4330 from mheon/update_vol_create_docs
Add documentation on options to volume create manpage
-rw-r--r--docs/podman-volume-create.1.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/podman-volume-create.1.md b/docs/podman-volume-create.1.md
index 6612b0ad2..b354f396f 100644
--- a/docs/podman-volume-create.1.md
+++ b/docs/podman-volume-create.1.md
@@ -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>