feat: add configurable init containers (#11)

## Summary
- allow bootstrapper and node pods to define init containers through
values with tpl support
- expand values annotations and helm-docs output to cover new keys
- document helm-docs expectations in AGENTS.md

## Testing
- bun run typecheck
- bun run check
- bun run test
- bun run check:fix
- bun run docs:helm

## Summary by Sourcery

Add support for configurable init containers in the network-bootstrapper
and network-nodes Helm charts, including templating for shared,
validator, and RPC pods, and update documentation accordingly.

New Features:
- Allow defining initContainers via chart values for both bootstrapper
and node pods, with separate shared, validator, and RPC configurations
and tpl support

Enhancements:
- Introduce a helper template to render initContainers in statefulsets
and jobs
- Update Helm chart values and README files to include initContainers
keys for bootstrapper, validator, and RPC pods

Documentation:
- Extend AGENTS.md with instructions for regenerating Helm chart
documentation using helm-docs
- Add initContainers sections to network-bootstrapper and network-nodes
README files

Author: roderik

AGENTS.md

@@ -8,6 +8,10 @@ The TypeScript sources live in `src/`. CLI flows under `src/cli/` orchestrate pr
 
 Install dependencies with `bun install`. Use `bun run src/index.ts` to execute the bootstrapper locally. Run the full test suite with `bun test`. Type safety is enforced by `bun run typecheck`, and formatting plus lint rules are auto-fixed with `bun run check:fix` (Biome). Combine these commands before pushing to catch regressions early.
 
+## Documentation
+
+Regenerate Helm chart documentation with `helm-docs` (`bun run docs:helm`) after modifying any values or templates so every README stays in helm-docs format. When editing `values.yaml`, ensure each key has a helm-docs compatible comment block (`# -- description`) including type hints or context so autogenerated tables stay complete.
+
 ## Coding Style & Naming Conventions
 
 We write modern ESM TypeScript with strict compiler options. Keep indentation at two spaces and favor `const` over `let`. Module files follow kebab-case (for example, `build-command.ts`), functions and variables use camelCase, and classes use PascalCase. Rely on Biome defaults; do not disable rules unless you add justification. Avoid `console` noise in committed code—prefer structured logging through existing helpers.

charts/network/charts/network-bootstrapper/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: network-bootstrapper
 description: A Helm chart for Kubernetes
 type: application
-version: 0.1.0
+version: 0.1.1
 appVersion: "0.1.0"
 maintainers:
   - name: SettleMint

charts/network/charts/network-bootstrapper/README.md

@@ -1,6 +1,6 @@
 # network-bootstrapper
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
 
 A Helm chart for Kubernetes
 
@@ -27,6 +27,7 @@ A Helm chart for Kubernetes
 | image.repository | string | `"ghcr.io/settlemint/network-bootstrapper"` | OCI registry path hosting the network bootstrapper image. |
 | image.tag | string | `""` | Image tag override; leave empty to inherit the chart appVersion. |
 | imagePullSecrets | list | `[]` | Image pull secrets enabling access to private registries. |
+| initContainers | list|string | `[]` | Init containers executed before the bootstrapper container starts. |
 | nameOverride | string | `""` | Override for the short release name used by name templates. |
 | nodeSelector | object | `{}` |  |
 | podAnnotations | object | `{}` |  |

charts/network/charts/network-bootstrapper/templates/_helpers.tpl

@@ -60,3 +60,20 @@ Create the name of the service account to use
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
 {{- end }}
+
+{{/*
+Render init container specifications provided via values.
+Accepts either a YAML string or a list of init container maps and indents output appropriately.
+*/}}
+{{- define "network-bootstrapper.renderInitContainers" -}}
+{{- $ctx := .context -}}
+{{- $containers := .containers -}}
+{{- $indent := .indent | default 2 -}}
+{{- if $containers -}}
+{{- if kindIs "string" $containers -}}
+{{ tpl $containers $ctx | nindent $indent }}
+{{- else -}}
+{{ tpl (toYaml $containers) $ctx | nindent $indent }}
+{{- end -}}
+{{- end -}}
+{{- end -}}

charts/network/charts/network-bootstrapper/templates/job.yaml

@@ -31,6 +31,10 @@ spec:
       securityContext:
         {{- toYaml . | nindent 8 }}
       {{- end }}
+      {{- with .Values.initContainers }}
+      initContainers:
+{{- include "network-bootstrapper.renderInitContainers" (dict "context" $ "containers" . "indent" 8) }}
+      {{- end }}
       containers:
         - name: {{ .Chart.Name }}
           {{- with .Values.securityContext }}

charts/network/charts/network-bootstrapper/values.yaml

@@ -53,6 +53,37 @@ securityContext:
   # runAsNonRoot: true
   # runAsUser: 1000
 
+# -- (list|string) Init containers executed before the bootstrapper container starts.
+initContainers: []
+# - name: wait-for-genesis
+#   image: busybox:1.36
+#   imagePullPolicy: IfNotPresent
+#   command:
+#     - sh
+#     - -c
+#   args:
+#     - >-
+#       until nc -z ${STATIC_NODE_HOST:?} ${STATIC_NODE_PORT:?}; do echo "waiting for nodes"; sleep 2; done
+#   env:
+#     - name: STATIC_NODE_HOST
+#       value: besu-node-validator-0.besu-node-validator
+#     - name: STATIC_NODE_PORT
+#       value: "30303"
+#   envFrom:
+#     - secretRef:
+#         name: bootstrapper-env
+#   volumeMounts:
+#     - name: config
+#       mountPath: /config
+#   resources:
+#     requests:
+#       cpu: 50m
+#       memory: 64Mi
+#   securityContext: {}
+#   workingDir: /config
+#   stdin: false
+#   tty: false
+
 # CPU and memory requests or limits for the bootstrapper container.
 resources:
   {}

charts/network/charts/network-nodes/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: network-nodes
 description: A Helm chart for Kubernetes
 type: application
-version: 0.1.0
+version: 0.1.1
 appVersion: "0.1.0"
 maintainers:
   - name: SettleMint

charts/network/charts/network-nodes/README.md

@@ -1,6 +1,6 @@
 # network-nodes
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
 
 A Helm chart for Kubernetes
 
@@ -77,6 +77,9 @@ A Helm chart for Kubernetes
 | ingress.enabled | bool | `false` | Enable creation of an Ingress resource. |
 | ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | Hostname and path routing rules for the Ingress. |
 | ingress.tls | list | `[]` | TLS configuration for Ingress hosts. |
+| initContainers.rpc | list|string | `[]` | Additional init containers exclusively for RPC pods. |
+| initContainers.shared | list|string | `[]` | Init containers applied to both validator and RPC pods. |
+| initContainers.validator | list|string | `[]` | Additional init containers exclusively for validator pods. |
 | livenessProbe.failureThreshold | int | `3` | Consecutive failures required before the container is restarted. |
 | livenessProbe.httpGet.path | string | `"/liveness"` | HTTP path used for liveness probing. |
 | livenessProbe.httpGet.port | string|int | `"json-rpc"` | Target container port serving the liveness endpoint. |

charts/network/charts/network-nodes/templates/_helpers.tpl

@@ -86,3 +86,20 @@ Resolve the number of validator replicas, falling back to global overrides when
 {{- end -}}
 {{- end -}}
 {{- end }}
+
+{{/*
+Render init container specifications provided via values.
+Accepts either a YAML string or a list of init container maps and indents output appropriately.
+*/}}
+{{- define "nodes.renderInitContainers" -}}
+{{- $ctx := .context -}}
+{{- $containers := .containers -}}
+{{- $indent := .indent | default 2 -}}
+{{- if $containers -}}
+{{- if kindIs "string" $containers -}}
+{{ tpl $containers $ctx | nindent $indent }}
+{{- else -}}
+{{ tpl (toYaml $containers) $ctx | nindent $indent }}
+{{- end -}}
+{{- end -}}
+{{- end -}}

charts/network/charts/network-nodes/templates/statefulset-rpc.yaml

@@ -28,6 +28,9 @@ spec:
   {{- $privateKeyFilename := default "privateKey" .Values.config.privateKeyFilename }}
   {{- $shouldMountPersistence := $persistenceEnabled }}
   {{- $rpcReplicaBudget := .Values.rpcReplicaCount | int }}
+  {{- $initContainers := .Values.initContainers | default (dict) }}
+  {{- $sharedInitContainers := get $initContainers "shared" }}
+  {{- $rpcInitContainers := get $initContainers "rpc" }}
   podManagementPolicy: Parallel
   replicas: {{ .Values.rpcReplicaCount }}
   serviceName: {{ include "nodes.fullname" . }}-rpc
@@ -66,6 +69,11 @@ spec:
       securityContext:
         {{- toYaml . | nindent 8 }}
       {{- end }}
+      {{- if or $sharedInitContainers $rpcInitContainers }}
+      initContainers:
+{{- include "nodes.renderInitContainers" (dict "context" $root "containers" $sharedInitContainers "indent" 8) }}
+{{- include "nodes.renderInitContainers" (dict "context" $root "containers" $rpcInitContainers "indent" 8) }}
+      {{- end }}
       containers:
         - name: {{ .Chart.Name }}
           env: