Version v0.5.7 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
Add a Helm value
The rules are in helm/AGENTS.md.
Write the unit test first under
helm/dexaflow/tests/: what the template renders with the value set, and what it renders without it.config_bind_test.yamlis the pattern for a value that becomes a server environment variable. Runhelm unittest helm/dexaflowand watch it fail.Add the key to
helm/dexaflow/values.yamlwith a# --doc comment above it. Its default keeps the rendered manifests of an existing install unchanged.Render it in the template that uses it. A server setting reaches the control plane as an environment variable in
templates/_controlplane-deployment.tpl; the server reads it under either prefix (see add a configuration setting). When a combination of values would make the server refuse to boot, fail the render with a message that says what to set, astemplates/deployment.yamldoes for its guarded combinations.Regenerate the README from
README.md.gotmpl, never by editing the table:helm-docs -c helm/dexaflow bash scripts/check-values-doc-comments.sh # what helm-docs cannot seeRun the chart checks:
helm lint helm/dexaflow helm unittest helm/dexaflow bash scripts/helm-template-checks.sh bash scripts/rbac-covers-executor.sh # when the Role or the executor changedHelm CI also installs the previous released chart and upgrades it to yours; a renamed value keeps the old key working.
Leave
Chart.yamlalone. The release cut bumpsversionandappVersiontogether with the tag (scripts/check-chart-version-matches-tag.sh).Document it.
values.yamlis user-facing surface for the docs guard: update the Helm chart page or the page of the feature, and record a changelog fragment (record a change).