summaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/mount.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-02 06:02:04 -0600
committerEd Santiago <santiago@redhat.com>2022-08-03 06:53:33 -0600
commit56039cffd7923d682bd620e5a5a974aabc94dd1b (patch)
tree5459999ec2ecfc82f4565070eeb6bb2472ccadec /docs/source/markdown/options/mount.md
parent1139cd9b8142aa4f4efb0f930a398453d521c1d9 (diff)
downloadpodman-56039cffd7923d682bd620e5a5a974aabc94dd1b.tar.gz
podman-56039cffd7923d682bd620e5a5a974aabc94dd1b.tar.bz2
podman-56039cffd7923d682bd620e5a5a974aabc94dd1b.zip
Refactor common options in man pages
podman-create and -run have many options in common. To date, these are copy-pasted and haphazardly maintained. Solution: add an include mechanism, '@@option foo', such that multiple md source files can fetch from one common file. This is a Phase One commit, a very small subset of what's possible. Purpose of this commit is ease of review. If this passes review, much more (trickier stuff) will be forthcoming. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options/mount.md')
-rw-r--r--docs/source/markdown/options/mount.md77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/source/markdown/options/mount.md b/docs/source/markdown/options/mount.md
new file mode 100644
index 000000000..e81af539d
--- /dev/null
+++ b/docs/source/markdown/options/mount.md
@@ -0,0 +1,77 @@
+#### **--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]*
+
+Attach a filesystem mount to the container
+
+Current supported mount TYPEs are **bind**, **volume**, **image**, **tmpfs** and **devpts**. <sup>[[1]](#Footnote1)</sup>
+
+ e.g.
+
+ type=bind,source=/path/on/host,destination=/path/in/container
+
+ type=bind,src=/path/on/host,dst=/path/in/container,relabel=shared
+
+ type=bind,src=/path/on/host,dst=/path/in/container,relabel=shared,U=true
+
+ type=volume,source=vol1,destination=/path/in/container,ro=true
+
+ type=tmpfs,tmpfs-size=512M,destination=/path/in/container
+
+ type=image,source=fedora,destination=/fedora-image,rw=true
+
+ type=devpts,destination=/dev/pts
+
+ Common Options:
+
+ · src, source: mount source spec for bind and volume. Mandatory for bind.
+
+ · dst, destination, target: mount destination spec.
+
+ Options specific to volume:
+
+ · ro, readonly: true or false (default).
+
+ . U, chown: true or false (default). Change recursively the owner and group of the source volume based on the UID and GID of the container.
+
+ · idmap: true or false (default). If specified, create an idmapped mount to the target user namespace in the container.
+
+ Options specific to image:
+
+ · rw, readwrite: true or false (default).
+
+ Options specific to bind:
+
+ · ro, readonly: true or false (default).
+
+ · bind-propagation: shared, slave, private, unbindable, rshared, rslave, runbindable, or rprivate(default). See also mount(2).
+
+ . bind-nonrecursive: do not set up a recursive bind mount. By default it is recursive.
+
+ . relabel: shared, private.
+
+ · idmap: true or false (default). If specified, create an idmapped mount to the target user namespace in the container.
+
+ . U, chown: true or false (default). Change recursively the owner and group of the source volume based on the UID and GID of the container.
+
+ Options specific to tmpfs:
+
+ · ro, readonly: true or false (default).
+
+ · tmpfs-size: Size of the tmpfs mount in bytes. Unlimited by default in Linux.
+
+ · tmpfs-mode: File mode of the tmpfs in octal. (e.g. 700 or 0700.) Defaults to 1777 in Linux.
+
+ · tmpcopyup: Enable copyup from the image directory at the same location to the tmpfs. Used by default.
+
+ · notmpcopyup: Disable copying files from the image to the tmpfs.
+
+ . U, chown: true or false (default). Change recursively the owner and group of the source volume based on the UID and GID of the container.
+
+ Options specific to devpts:
+
+ · uid: UID of the file owner (default 0).
+
+ · gid: GID of the file owner (default 0).
+
+ · mode: permission mask for the file (default 600).
+
+ · max: maximum number of PTYs (default 1048576).