From 3c3fa6fac4d0f8e89181ea2d4e1fe0318d24b6f4 Mon Sep 17 00:00:00 2001 From: Brent Baude Date: Wed, 14 Jul 2021 16:03:55 -0500 Subject: implement init containers in podman this is the first pass at implementing init containers for podman pods. init containersare made popular by k8s as a way to run setup for pods before the pods standard containers run. unlike k8s, we support two styles of init containers: always and oneshot. always means the container stays in the pod and starts whenever a pod is started. this does not apply to pods restarting. oneshot means the container runs onetime when the pod starts and then is removed. Signed-off-by: Brent Baude --- docs/source/markdown/podman-create.1.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'docs') 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. -- cgit v1.2.3-54-g00ecf