docs(helm): document supported values and add usage examples#280
docs(helm): document supported values and add usage examples#280chihkang wants to merge 2 commits intoopenabdev:mainfrom
Conversation
chaodu-agent
left a comment
There was a problem hiding this comment.
🟡 Needs Update — Good intent, but stale + merge conflicts + incomplete coverage.
Baseline Check (Step 0)
| Field | Value |
|---|---|
| State | OPEN |
| Mergeable | CONFLICTING |
| Created | 2026-04-13 (18 days ago) |
| Changes | +78 / -0, docs only |
| Labels | p3, closing-soon |
Main branch status: No charts/openab/README.md exists — PR creates it fresh. ✅ However, values.yaml has changed significantly since April 13 with ~19 feature commits touching the chart.
Four-Question Framework
1. What problem does it solve?
The Helm chart supports many values only discoverable by reading templates directly. This PR adds a chart-level README with values reference table and practical usage examples.
2. How does it solve it?
- Creates
charts/openab/README.mdwith values table + 4 usage examples - Adds top-level
nameOverrideandfullnameOverridedefaults tovalues.yaml - Adds inline comments for
envFromandagentsMd
3. What was considered?
Documentation-only, no behavior change. Contributor reviewed templates to confirm documented values are supported.
4. Is it the best approach?
Sound approach — chart-level README is standard Helm convention. But execution has gaps due to staleness.
Traffic Light
🟢 INFO
- Correct identification of undocumented gap (
nameOverride/fullnameOverridemissing fromvalues.yaml) - Practical examples (envFrom, --set-file agentsMd, Discord ID precision warning)
- Standard Helm convention for chart docs
🟡 NIT
- Values table very incomplete — Documents only ~8 values. Actual chart has 27+ agent-level keys including
slack.*,gateway.*,reactions.*,stt.*,cron.*,persistence.*,pool.*,extraInitContainers,extraContainers,allowBotMessages,trustedBotIds,allowDm,maxBotTurns, etc. - Consider
helm-docsfor auto-generation fromvalues.yamlcomments.
🔴 SUGGESTED CHANGES
- Merge conflict must be resolved —
values.yamlhas changed significantly since April 13. - Stale documentation risk — Since PR opened, main gained: gateway templates, maxBotTurns, allowDm, reactions.toolDisplay, cron/cronjobs, extraContainers, Slack adapter config, allowBotMessages/trustedBotIds. The "values reference" title is misleading at ~15% coverage.
closing-soonlabel — Missing Discord Discussion URL. Will auto-close in 3 days unless addressed.
Reviewed by 超渡法師 🔃 chaodu Backlog triage
超渡法師 Review — PR #2801. What problem does it solve?The Helm chart supports several useful values ( 2. How does it solve it?
3. What was considered?Docs-only, no behavior changes. Contributor reviewed chart templates to confirm all documented values are already functional. 4. Is this the best approach?Clean, well-scoped docs PR that directly addresses every item in issue #163. Surfacing existing values in Traffic Light🟢 INFO — Well done
🟡 NIT
Verdict🟢 Looks good — Clean docs-only PR. The NITs above are minor improvements. No blocking issues. |
Summary
This PR improves the Helm chart documentation by adding several supported but currently undocumented values to the values reference and README.
Users can already rely on these options in practice, but today they are difficult to discover unless they inspect the chart templates directly. This change makes the chart easier to use and reduces trial-and-error during deployment.
Closes #163.
Changes
fullnameOverridetovalues.yamlnameOverridetovalues.yamlenvFrominvalues.yamlcomments and chart docsagentsMdusage with--set-filediscord.allowedChannels--set-stringrequirement more prominentlyWhy
The chart already supports these configuration paths, but they are not clearly documented. That creates unnecessary friction for users, especially for:
AGENTS.mdconfigurationsNotes
This PR is documentation-focused and does not change chart behavior. It only makes existing supported options easier to discover and use.
Testing
helmCLI was not available in the local environment forhelm lint