summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2018-09-21 06:29:18 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-09-21 21:33:41 +0000
commit52c1365f32398b8ba0321c159e739a5416cd9ab2 (patch)
tree8a700c6cc35d1955e973d18b3ed537c380290334 /docs
parent9e81f9daa4af9802088530a35a72814172430a36 (diff)
downloadpodman-52c1365f32398b8ba0321c159e739a5416cd9ab2.tar.gz
podman-52c1365f32398b8ba0321c159e739a5416cd9ab2.tar.bz2
podman-52c1365f32398b8ba0321c159e739a5416cd9ab2.zip
Add --mount option for `create` & `run` command
Signed-off-by: Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #1524 Approved by: mheon
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-create.1.md30
-rw-r--r--docs/podman-run.1.md38
2 files changed, 68 insertions, 0 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 01e072005..c42671b76 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -372,6 +372,36 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
+**--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]*
+
+Attach a filesystem mount to the container
+
+Current supported mount TYPES are bind, and tmpfs.
+
+ e.g.
+
+ type=bind,source=/path/on/host,destination=/path/in/container
+
+ type=tmpfs,tmpfs-size=512M,destination=/path/in/container
+
+ Common Options:
+
+ · src, source: mount source spec for bind and volume. Mandatory for bind.
+
+ · dst, destination, target: mount destination spec.
+
+ · ro, read-only: true or false (default).
+
+ Options specific to bind:
+
+ · bind-propagation: shared, slave, private, rshared, rslave, or rprivate(default). See also mount(2).
+
+ Options specific to tmpfs:
+
+ · 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.
+
**--name**=""
Assign a name to the container
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index a4c47f5de..fccebb7f7 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -655,6 +655,36 @@ Set the UTS mode for the container
**NOTE**: the host mode gives the container access to changing the host's hostname and is therefore considered insecure.
+**--mount**=*type=TYPE,TYPE-SPECIFIC-OPTION[,...]*
+
+Attach a filesystem mount to the container
+
+Current supported mount TYPES are bind, and tmpfs.
+
+ e.g.
+
+ type=bind,source=/path/on/host,destination=/path/in/container
+
+ type=tmpfs,tmpfs-size=512M,destination=/path/in/container
+
+ Common Options:
+
+ · src, source: mount source spec for bind and volume. Mandatory for bind.
+
+ · dst, destination, target: mount destination spec.
+
+ · ro, read-only: true or false (default).
+
+ Options specific to bind:
+
+ · bind-propagation: Z, z, shared, slave, private, rshared, rslave, or rprivate(default). See also mount(2).
+
+ Options specific to tmpfs:
+
+ · 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.
+
**-v**|**--volume**[=*[HOST-DIR:CONTAINER-DIR[:OPTIONS]]*]
Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, podman
@@ -931,6 +961,12 @@ colon:
$ podman run -v /var/db:/data1 -i -t fedora bash
```
+Using --mount flags, To mount a host directory as a container folder, specify
+the absolute path to the directory and the absolute path for the container
+directory:
+
+$ podman run --mount type=bind,src=/var/db,target=/data1 busybox sh
+
When using SELinux, be aware that the host has no knowledge of container SELinux
policy. Therefore, in the above example, if SELinux policy is enforced, the
`/var/db` directory is not writable to the container. A "Permission Denied"
@@ -1030,6 +1066,8 @@ $ podman run --uidmap 0:30000:7000 --gidmap 0:30000:7000 fedora echo hello
subgid(5), subuid(5), libpod.conf(5)
## HISTORY
+September 2018, updated by Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp>
+
October 2017, converted from Docker documentation to podman by Dan Walsh for podman <dwalsh@redhat.com>
November 2015, updated by Sally O'Malley <somalley@redhat.com>