feat: Add init containers

.github/workflows/ci.yaml

@@ -80,6 +80,7 @@ jobs:
           helm lint complex -f complex/testing-values/values-targetgroups.yaml
           helm lint complex -f complex/testing-values/values-configmap.yaml
           helm lint complex -f complex/testing-values/values-volume-mounts.yaml
+          helm lint complex -f complex/testing-values/values-initcontainers.yaml
 
   template-test:
     runs-on: ubuntu-latest
@@ -119,6 +120,7 @@ jobs:
           helm template test ./complex --debug -f complex/testing-values/values-security-context.yaml
           helm template test ./complex --debug -f complex/testing-values/values-rolling-update.yaml
           helm template test ./complex --debug -f complex/testing-values/values-pod-disruption-budget.yaml
+          helm template test ./complex --debug -f complex/testing-values/values-initcontainers.yaml
 
           # Test infrastructure configurations
           helm template test ./complex --debug -f complex/testing-values/values-ingress.yaml

complex/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: complex
 description: For deploying applications with consumers and cronjobs
 type: application
-version: 1.5.1
+version: 1.5.2
 kubeVersion: ">= 1.25.0-0 < 2.0.0-0"
 
 dependencies:

complex/README.md

@@ -2,7 +2,7 @@
 
 # complex
 
-![Version: 1.5.0](https://img.shields.io/badge/Version-1.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+![Version: 1.5.2](https://img.shields.io/badge/Version-1.5.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 For deploying applications, consumers and cronjobs
 
@@ -163,6 +163,65 @@ components:
 - `<name>` - Component middleware (e.g., `strip-prefix`)
 - `<name>@<provider>` - External reference (e.g., `auth@file`, `other-middleware@kubernetescrd`)
 
+## Init Containers
+
+The chart supports defining init containers that run before the main container starts. Init containers are useful for:
+
+- Running setup scripts or database migrations
+- Waiting for dependent services to be ready
+- Downloading configuration files or secrets
+- Setting up volumes with proper permissions
+
+### Defining Init Containers
+
+Init containers are defined at the component level using `initContainers`:
+
+```yaml
+components:
+  api:
+    type: http
+    ports:
+      - port: 3000
+    initContainers:
+      wait-for-db:
+        image:
+          repository: busybox
+          tag: "1.36"
+        command:
+          - sh
+          - -c
+          - |
+            until nc -z postgres-service 5432; do
+              echo "Waiting for database..."
+              sleep 2
+            done
+        resources:
+          requests:
+            cpu: "50m"
+            memory: "64M"
+          limits:
+            cpu: "100m"
+            memory: "128M"
+```
+
+### Init Container Properties
+
+Each init container supports the same properties as regular containers:
+
+| Property | Description | Required |
+|----------|-------------|----------|
+| `image.repository` | Container image repository | Yes |
+| `image.tag` | Container image tag | Yes |
+| `image.pullPolicy` | Image pull policy (IfNotPresent, Always, Never) | No |
+| `command` | Override container entrypoint | No |
+| `args` | Arguments to the entrypoint | No |
+| `envs.values` | Environment variables as key-value pairs | No |
+| `envs.from.configMaps` | Load env vars from ConfigMaps | No |
+| `envs.from.secrets` | Load env vars from Secrets | No |
+| `resources` | CPU/memory requests and limits | No |
+| `volumeMounts` | Mount ConfigMaps or Secrets as files | No |
+
+
 ## Configuration Structure
 
 ### Global vs Component-Specific Configuration

complex/README.md.gotmpl

@@ -165,6 +165,64 @@ components:
 - `<name>` - Component middleware (e.g., `strip-prefix`)
 - `<name>@<provider>` - External reference (e.g., `auth@file`, `other-middleware@kubernetescrd`)
 
+## Init Containers
+
+The chart supports defining init containers that run before the main container starts. Init containers are useful for:
+
+- Running setup scripts or database migrations
+- Waiting for dependent services to be ready
+- Downloading configuration files or secrets
+- Setting up volumes with proper permissions
+
+### Defining Init Containers
+
+Init containers are defined at the component level using `initContainers`:
+
+```yaml
+components:
+  api:
+    type: http
+    ports:
+      - port: 3000
+    initContainers:
+      wait-for-db:
+        image:
+          repository: busybox
+          tag: "1.36"
+        command:
+          - sh
+          - -c
+          - |
+            until nc -z postgres-service 5432; do
+              echo "Waiting for database..."
+              sleep 2
+            done
+        resources:
+          requests:
+            cpu: "50m"
+            memory: "64M"
+          limits:
+            cpu: "100m"
+            memory: "128M"
+```
+
+### Init Container Properties
+
+Each init container supports the same properties as regular containers:
+
+| Property | Description | Required |
+|----------|-------------|----------|
+| `image.repository` | Container image repository | Yes |
+| `image.tag` | Container image tag | Yes |
+| `image.pullPolicy` | Image pull policy (IfNotPresent, Always, Never) | No |
+| `command` | Override container entrypoint | No |
+| `args` | Arguments to the entrypoint | No |
+| `envs.values` | Environment variables as key-value pairs | No |
+| `envs.from.configMaps` | Load env vars from ConfigMaps | No |
+| `envs.from.secrets` | Load env vars from Secrets | No |
+| `resources` | CPU/memory requests and limits | No |
+| `volumeMounts` | Mount ConfigMaps or Secrets as files | No |
+
 ## Configuration Structure
 
 ### Global vs Component-Specific Configuration

complex/templates/deployment.yaml

@@ -46,6 +46,6 @@ spec:
         {{ $.Values.global.metadata.annotations | toYaml | nindent 8 }}
         {{- end }}
     spec:
-      {{ include "pod.spec" (dict "containers" (dict "application" $component) "global" $.Values.global "metadata" $.Values.global.metadata "nodeSelector" $component.nodeSelector "kubeLabels" $kubeLabels "enableServiceLinks" $component.enableServiceLinks "serviceAccountName" $component.serviceAccountName "tolerations" $component.tolerations "imagePullSecrets" $component.imagePullSecrets "volumeMounts" $component.volumeMounts "volumes" $component.volumes "persistentVolumeClaim" $component.persistentVolumeClaim "componentName" (include "component.name" (dict "name" $componentName "Release" $.Release)) "root" $) | indent 6 | trim }}
+      {{ include "pod.spec" (dict "containers" (dict "application" $component) "initContainers" $component.initContainers "global" $.Values.global "metadata" $.Values.global.metadata "nodeSelector" $component.nodeSelector "kubeLabels" $kubeLabels "enableServiceLinks" $component.enableServiceLinks "serviceAccountName" $component.serviceAccountName "tolerations" $component.tolerations "imagePullSecrets" $component.imagePullSecrets "volumeMounts" $component.volumeMounts "volumes" $component.volumes "persistentVolumeClaim" $component.persistentVolumeClaim "componentName" (include "component.name" (dict "name" $componentName "Release" $.Release)) "root" $) | indent 6 | trim }}
 {{ end -}}
 {{- end -}}

complex/testing-values/values-initcontainers.yaml

@@ -0,0 +1,49 @@
+global:
+  container:
+    image:
+      repository: cookielab/deployer
+      tag: 1.0.0-rc2
+
+components:
+  api:
+    type: http
+    replicas: 2
+    ports:
+      - port: 3000
+    probes:
+      readinessProbe:
+        httpGet:
+          port: 8080
+          path: /health-check
+        periodSeconds: 30
+        timeoutSeconds: 15
+      livenessProbe:
+        httpGet:
+          port: 8080
+          path: /health-check
+    targetGroup:
+      arn: 'arn:fake'
+      securityGroupIds:
+        - sg-fake
+    initContainers:
+      wait-for-db:
+        image:
+          repository: busybox
+          tag: "1.36"
+        command:
+          - sh
+          - -c
+          - |
+            until nc -z postgres-service 5432; do
+              echo "Waiting for database..."
+              sleep 2
+            done
+        resources:
+          requests:
+            cpu: "50m"
+            memory: "64M"
+            ephemeralStorage: "128Mi"
+          limits:
+            cpu: "100m"
+            memory: "128M"
+            ephemeralStorage: "128Mi"

complex/values.schema.json

@@ -2710,6 +2710,13 @@
             "type": "string"
           }
         },
+        "initContainers": {
+            "description": "InitContainers defines containers to run before the main container starts.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/definitions/container"
+            }
+          },
         "traefikMiddlewares": {
           "$ref": "#/definitions/traefikMiddlewares"
         }
@@ -2839,6 +2846,13 @@
               }
             }
           },
+          "initContainers": {
+            "description": "InitContainers defines containers to run before the main container starts.",
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/definitions/container"
+            }
+          },
           "traefikMiddlewares": {
             "$ref": "#/definitions/traefikMiddlewares"
           },
@@ -3529,4 +3543,4 @@
     }
   },
   "additionalProperties": false
-}
+}