diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2019-10-31 19:39:44 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-10-31 19:39:44 +0100 |
commit | ffe36ea9964242235571ad1d21a0c4d825ef5971 (patch) | |
tree | b38d2d9c492ab2b2ad951135fde7e90c37344711 /docs/source/markdown/podman-volume-create.1.md | |
parent | 3e2d9f8662663f2f703bf674408d5255e493e18e (diff) | |
parent | 486fcd4e1e6f00424f1016d8e331582523bd2c68 (diff) | |
download | podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.gz podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.bz2 podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.zip |
Merge pull request #4354 from baude/newdocsstruct
Restructure documentation dir
Diffstat (limited to 'docs/source/markdown/podman-volume-create.1.md')
-rw-r--r-- | docs/source/markdown/podman-volume-create.1.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md new file mode 100644 index 000000000..b354f396f --- /dev/null +++ b/docs/source/markdown/podman-volume-create.1.md @@ -0,0 +1,59 @@ +% podman-volume-create(1) + +## NAME +podman\-volume\-create - Create a new volume + +## SYNOPSIS +**podman volume create** [*options*] + +## DESCRIPTION + +Creates an empty volume and prepares it to be used by containers. The volume +can be created with a specific name, if a name is not given a random name is +generated. You can add metadata to the volume by using the **--label** flag and +driver options can be set using the **--opt** flag. + +## OPTIONS + +**--driver**=*driver* + +Specify the volume driver name (default local). + +**--help** + +Print usage statement + +**-l**, **-label**=*label* + +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 + +``` +$ podman volume create myvol + +$ 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=uid=1000,gid=1000 testvol +``` + +## SEE ALSO +podman-volume(1), mount(8) + +## HISTORY +November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> |