summaryrefslogtreecommitdiff
path: root/docs/podman-pod-create.1.md
diff options
context:
space:
mode:
authorhaircommander <pehunt@redhat.com>2018-07-27 13:58:50 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-08-23 18:16:28 +0000
commitd5e690914dc78eca8664442e7677eb5004522bfd (patch)
tree3f7ed30e4302c871c16126a0032b8a3d51c46f98 /docs/podman-pod-create.1.md
parent63dd200e7e47261454c7e55fed2ad972144e147f (diff)
downloadpodman-d5e690914dc78eca8664442e7677eb5004522bfd.tar.gz
podman-d5e690914dc78eca8664442e7677eb5004522bfd.tar.bz2
podman-d5e690914dc78eca8664442e7677eb5004522bfd.zip
Added option to share kernel namespaces in libpod and podman
A pause container is added to the pod if the user opts in. The default pause image and command can be overridden. Pause containers are ignored in ps unless the -a option is present. Pod inspect and pod ps show shared namespaces and pause container. A pause container can't be removed with podman rm, and a pod can be removed if it only has a pause container. Signed-off-by: haircommander <pehunt@redhat.com> Closes: #1187 Approved by: mheon
Diffstat (limited to 'docs/podman-pod-create.1.md')
-rw-r--r--docs/podman-pod-create.1.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/podman-pod-create.1.md b/docs/podman-pod-create.1.md
index 495c6934a..063dbc918 100644
--- a/docs/podman-pod-create.1.md
+++ b/docs/podman-pod-create.1.md
@@ -39,6 +39,22 @@ Read in a line delimited file of labels
Assign a name to the pod
+**--pause**
+
+Create a pause container and associate it with the pod. A pause container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default: true
+
+**--pause-command**=""
+
+The command that will be run to start the pause container. Default: "/pause"
+
+**--pause-image**=""
+
+The image that will be created for the pause container. Default: "k8s.gcr.io/pause:3.1"
+
+**--share**=""
+
+A comma deliminated list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, user, uts.
+
The operator can identify a pod in three ways:
UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
UUID short identifier (“f78375b1c487”)
@@ -53,6 +69,10 @@ for it. The name is useful any place you need to identify a pod.
# podman pod create --name test
+# podman pod create --pause=false
+
+# podman pod create --pause-command /top
+
## SEE ALSO
podman-pod(1)