summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-03-01 03:53:21 -0500
committerGitHub <noreply@github.com>2022-03-01 03:53:21 -0500
commit87d22e101465fa9e8d25653918328e768a92aa71 (patch)
treeda115e8d159200a765c5eff9f3abfa56f3e49094 /docs/source
parent86a057e6be434159e3e60add5a7a7d649e0b4ad5 (diff)
parent3dc1b8e83f2459a58d65f3bb918975cd6f1bb794 (diff)
downloadpodman-87d22e101465fa9e8d25653918328e768a92aa71.tar.gz
podman-87d22e101465fa9e8d25653918328e768a92aa71.tar.bz2
podman-87d22e101465fa9e8d25653918328e768a92aa71.zip
Merge pull request #13318 from rhatdan/volume
Add podman volume mount support
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-volume-mount.1.md28
-rw-r--r--docs/source/markdown/podman-volume-unmount.1.md27
-rw-r--r--docs/source/markdown/podman-volume.1.md2
3 files changed, 57 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-volume-mount.1.md b/docs/source/markdown/podman-volume-mount.1.md
new file mode 100644
index 000000000..a5f35a34d
--- /dev/null
+++ b/docs/source/markdown/podman-volume-mount.1.md
@@ -0,0 +1,28 @@
+% podman-volume-mount(1)
+
+## NAME
+podman\-volume\-mount - Mount a volume filesystem
+
+## SYNOPSIS
+**podman volume mount** [*volume* ...]
+
+## DESCRIPTION
+Mounts the specified volumes' file system in a location which can be
+accessed from the host, and returns its location.
+
+Rootless mode only supports mounting file volumes, unless you enter the user namespace
+via the `podman unshare` command. All other volume types will fail to mount.
+
+## RETURN VALUE
+The location of the mounted file system. On error an empty string and errno is
+returned.
+
+## EXAMPLE
+
+```
+podman volume mount foo
+/home/dwalsh/.local/share/containers/storage/volumes/foo/_data
+```
+
+## SEE ALSO
+**[podman(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**, **[podman-volume-unmount(1)](podman-volume-unmount.1.md)**, **[podman-unshare(1)](podman-unshare.1.md)**, **mount(8)**
diff --git a/docs/source/markdown/podman-volume-unmount.1.md b/docs/source/markdown/podman-volume-unmount.1.md
new file mode 100644
index 000000000..e2fcd425f
--- /dev/null
+++ b/docs/source/markdown/podman-volume-unmount.1.md
@@ -0,0 +1,27 @@
+% podman-volume-unmount(1)
+
+## NAME
+podman\-volume\-unmount - Unmount a volume
+
+## SYNOPSIS
+**podman volume unmount** *volume* [...]
+
+**podman volume umount** *volume* [...]
+
+## DESCRIPTION
+Unmounts the specified volume, if there are no other containers
+using it.
+
+Volume storage increments a mount counter each time a volume is mounted.
+When a volume is unmounted, the mount counter is decremented, and the
+volume's filesystem is physically unmounted only when the mount
+counter reaches zero indicating no other processes are using the mount.
+
+## EXAMPLE
+
+podman volume unmount volumeID
+
+podman volume unmount volumeID1 volumeID2 volumeID3
+
+## SEE ALSO
+**[podman(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**, **[podman-volume-mount(1)](podman-volume-mount.1.md)**
diff --git a/docs/source/markdown/podman-volume.1.md b/docs/source/markdown/podman-volume.1.md
index d8bc11aad..d05f007c8 100644
--- a/docs/source/markdown/podman-volume.1.md
+++ b/docs/source/markdown/podman-volume.1.md
@@ -19,8 +19,10 @@ podman volume is a set of subcommands that manage volumes.
| import | [podman-volume-import(1)](podman-volume-import.1.md) | Import tarball contents into a podman volume. |
| inspect | [podman-volume-inspect(1)](podman-volume-inspect.1.md) | Get detailed information on one or more volumes. |
| ls | [podman-volume-ls(1)](podman-volume-ls.1.md) | List all the available volumes. |
+| mount | [podman-volume-mount(1)](podman-volume-mount.1.md) | Mount a volume filesystem. |
| prune | [podman-volume-prune(1)](podman-volume-prune.1.md) | Remove all unused volumes. |
| rm | [podman-volume-rm(1)](podman-volume-rm.1.md) | Remove one or more volumes. |
+| unmount | [podman-volume-unmount(1)](podman-volume-unmount.1.md) | Unmount a volume. |
## SEE ALSO
**[podman(1)](podman.1.md)**