Skip to content

Commit d279bea

Browse files
wyattwalterclaude
andcommitted
docs(helm): record redis.auth.password self-managed-path invariants in AGENTS.md
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 319b4c7 commit d279bea

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

deploy/helm/AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,20 @@ Each documented value in `values.yaml` carries up to three comment layers (all p
2626
- `# @section -- Section Name` — helm-docs groups the value into a named section table
2727

2828
When adding a new value, include at least the `# --` and `# @section --` lines so it lands in the correct README section. The `## @param` line is optional but preferred for consistency.
29+
30+
## Redis auth
31+
32+
`redis.auth.password` is a Bitnami subchart passthrough the Appsmith templates never read
33+
directly. There is exactly ONE supported way to use it — fully self-managed: set
34+
`redis.auth.password`, set `redis.auth.existingSecret: ""`, AND set
35+
`applicationConfig.APPSMITH_REDIS_URL` so the app uses the same credential. Every other use
36+
is rejected at render time by `appsmith.validateRedisAuth` (in `_helpers.tpl`, invoked from
37+
`configMap.yaml` so it always evaluates). Leave the password unset for the default
38+
(hook-bootstrapped secret) or BYO-secret paths.
39+
40+
Gotcha worth remembering: `helm template` cannot catch the self-managed path's runtime hazard.
41+
When a password is set the bootstrap hook is skipped, so the chart-managed Redis secret never
42+
exists — any pod referencing it (e.g. the `redis-init-container`'s `REDISCLI_AUTH`) must also be
43+
skipped on that path (gate on `not applicationConfig.APPSMITH_REDIS_URL`), or the pod wedges in
44+
`CreateContainerConfigError`. The init-container readiness ping needs no auth regardless:
45+
`redis-cli ping` against an auth-required server replies `NOAUTH` but exits 0, satisfying the wait.

0 commit comments

Comments
 (0)