OpenShift Init Container

External

• https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
• https://docs.openshift.com/container-platform/latest/architecture/core_concepts/containers_and_images.html#init-containers

Internal

• OpenShift Pod Concepts

Overview

An init container is a specialized container that runs before the application containers, and can contain utilities or setup scripts not present in the application image. If a pod declares init containers, the application containers are only run after all init container complete successfully.

An init container always runs to completion, and if more than one init containers are declared, each one is executed sequentially and must complete successfully before the next one is started. This is the reason init containers do not support readiness probes: they must succeed. If an init container fails, Kubernetes will restart the Pod repeatedly until the init container succeeds, unless the pod has a "restartPolicy" of "Never".

Init containers support all the fields and the features of the application containers including resource limits, volumes and security settings. However, the resource requests and limits for an Init Container are handled slightly differently, as described in Resources below.

Init containers can be used to run utilities that do not belong in application application container images for security reasons. The can contain utilities for setup. The application image builder and deployer roles can work independently without the need to jointly build a single app image. Because they use Linux namespaces so that they have different filesystem views from application containers, they can be given access to Secrets that application containers should not be able to access.

Ultimately, they can be used to implement a dependency mechanism: they run to completion before any application containers start, whereas application containers run in parallel, so init containers provide an easy way to block or delay the startup of application containers until some set of preconditions are met.

Declaration

Declared within the context of a pod, under the "initContainers" field.

A simple example:

apiVersion: v1
kind: Pod
[...]
spec:
  containers:
  - name: app-container1
    [...]
  initContainers:
  - name: init-container1
    image: busybox
    command: ['sh', '-c', 'until nslookup myservice; do echo waiting for myservice; sleep 2; done;']