Summary
The Helm chart has several useful values that are functional but not documented in values.yaml or the README. Users have to discover them through trial and error or by reading the chart templates directly.
Undocumented Values
fullnameOverride
- Supported by
_helpers.tpl but not listed in helm show values
- Essential for multi-instance deployments (e.g., running two agents on the same cluster with different names)
- Suggestion: Add
fullnameOverride: "" to values.yaml (standard Helm convention)
nameOverride
- Same situation as
fullnameOverride
- Suggestion: Add
nameOverride: "" to values.yaml
envFrom
- The chart supports injecting environment variables from Secrets/ConfigMaps via
envFrom
- This is critical for securely passing credentials like
GH_TOKEN without putting them in Helm values
- Suggestion: Add
envFrom: [] to values.yaml with a usage example:
envFrom:
- secretRef:
name: my-gh-token
agentsMd with --set-file
- The
agentsMd value works with --set-file agentsMd=./AGENTS.md for loading large agent identity files
- This is much more practical than inline
--set for files that can be 10KB+
- Suggestion: Document this usage pattern in the README
discord.allowedChannels precision warning
- The NOTES.txt already warns about using
--set-string for channel IDs, which is great
- Suggestion: Also mention this in the README/values.yaml comments so users see it before their first deploy
Proposed Changes
- Add missing values to
values.yaml with comments explaining their purpose
- Add a "Values Reference" section to the chart README
- Include practical examples for common configurations
This would significantly reduce the learning curve for new users deploying OpenAB via Helm.
Summary
The Helm chart has several useful values that are functional but not documented in
values.yamlor the README. Users have to discover them through trial and error or by reading the chart templates directly.Undocumented Values
fullnameOverride_helpers.tplbut not listed inhelm show valuesfullnameOverride: ""tovalues.yaml(standard Helm convention)nameOverridefullnameOverridenameOverride: ""tovalues.yamlenvFromenvFromGH_TOKENwithout putting them in Helm valuesenvFrom: []tovalues.yamlwith a usage example:agentsMdwith--set-fileagentsMdvalue works with--set-file agentsMd=./AGENTS.mdfor loading large agent identity files--setfor files that can be 10KB+discord.allowedChannelsprecision warning--set-stringfor channel IDs, which is greatProposed Changes
values.yamlwith comments explaining their purposeThis would significantly reduce the learning curve for new users deploying OpenAB via Helm.