summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoropenshift-ci[bot] <75433959+openshift-ci[bot]@users.noreply.github.com>2021-08-05 13:52:15 +0000
committerGitHub <noreply@github.com>2021-08-05 13:52:15 +0000
commit1f0a24437d71f8fe2b2233a428202afcfe513666 (patch)
treee17f57dce6bf61d38a74fc6b8f011bffbb4082fa /docs
parent117583c293713f2baa920c4035e820ad59fe6622 (diff)
parent3c3fa6fac4d0f8e89181ea2d4e1fe0318d24b6f4 (diff)
downloadpodman-1f0a24437d71f8fe2b2233a428202afcfe513666.tar.gz
podman-1f0a24437d71f8fe2b2233a428202afcfe513666.tar.bz2
podman-1f0a24437d71f8fe2b2233a428202afcfe513666.zip
Merge pull request #11011 from baude/initcontainers
implement init containers in podman
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-create.1.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md
index 7f9cf0e75..b2f7260ae 100644
--- a/docs/source/markdown/podman-create.1.md
+++ b/docs/source/markdown/podman-create.1.md
@@ -447,6 +447,21 @@ content that disappears when the container is stopped.
Run an init inside the container that forwards signals and reaps processes.
+#### **--init-ctr**=*type* (pods only)
+
+When using pods, create an init style container, which is run after the infra container is started
+but before regular pod containers are started. Init containers are useful for running
+setup operations for the pod's applications.
+
+Valid values for `init-ctr` type are *always* or *oneshot*. The *always* value
+means the container will run with each and every `pod start`, whereas the *oneshot*
+value means is will ony run once when the pod is started and then the container is
+removed.
+
+Init containers are only run on pod `start`. Restarting a pod will not execute any init
+containers should they be present. Furthermore, init containers can only be created in a
+pod when that pod is not running.
+
#### **--init-path**=*path*
Path to the container-init binary.