Skip to content

docs: add guide for enabling Redis authentication on Helm deployments#3019

Open
sebastianiv21 wants to merge 12 commits into
mainfrom
claude/fervent-jennings-047f72
Open

docs: add guide for enabling Redis authentication on Helm deployments#3019
sebastianiv21 wants to merge 12 commits into
mainfrom
claude/fervent-jennings-047f72

Conversation

@sebastianiv21

Copy link
Copy Markdown
Contributor

Description

Provide a concise summary of the changes made in this pull request

  • Adds a new guide, Enable Redis Authentication, documenting the Redis auth support introduced in Helm chart 3.8.2 (appsmithorg/appsmith#41874): how the password bootstrap hook Job works, how to upgrade existing deployments to chart 3.8.2+ (including bring-your-own password, opt-out, ArgoCD, and air-gapped registries), and how to enable auth manually on charts older than 3.8.2 (pre-created Secret with a redis-password key, explicit applicationConfig.APPSMITH_REDIS_URL, and an ArgoCD ignoreDifferences fallback). Includes a troubleshooting section (NOAUTH/WRONGPASS, hook image pulls, release names containing "redis").
  • Registers the page in the sidebar under the existing Helm Chart category as "Redis Authentication".
  • Adds a cross-link in the Helm Chart reference's Redis section noting auth is enabled by default since chart 3.8.2.

Pull request type

Check the appropriate box:

Documentation tickets

Link to one or more documentation tickets:

  • N/A

Checklist

From the below options, select the ones that are applicable:

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jun 12, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
appsmith-docs Ready Ready Preview, Comment Jul 1, 2026 7:54pm

Request Review

sebastianiv21 and others added 2 commits June 15, 2026 10:53
Remove the "How it works" section, the standalone ArgoCD note, and
internal-behavior narration throughout so the guide focuses on the
steps users need to act on.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
sebastianiv21 and others added 2 commits June 15, 2026 11:33
An explicit redis.auth.enabled: false in an existing values.yaml
overrides the new chart default, leaving Redis auth disabled after the
upgrade. Add a step to check for and remove it.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Lead with the action rather than the explanation.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Per review: removes a confusing workaround section in favor of the
pre-created Secret path already documented.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
sebastianiv21 and others added 2 commits June 25, 2026 23:09
Add a "Self-manage the Redis password" subsection covering the
redis.auth.password + empty existingSecret + matching APPSMITH_REDIS_URL
combination, and a troubleshooting entry for the chart's fail-fast guard.

Drop the now-stale "Appsmith can't resolve the Redis host" entry: the
chart's redisMasterHost helper now derives the host from the subchart's
common.names.fullname, which handles release names containing "redis".

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Cloud-managed Redis (ElastiCache, Azure Cache, Memorystore, Redis Cloud)
must run with authentication enabled. Update the external Redis examples
to credentialed connection strings, add an "Enable authentication"
section with provider-specific formats, and update the AWS ECS and GCP
Cloud Run HA guides to enable auth and connect with credentials. Also
fix a copy-paste reference to ElastiCache in the GCP guide.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Add a plaintext-storage caution and rotation pointer to the
  self-manage password path (security).
- State rollout expectation (ephemeral Redis, brief logout, no data
  loss) on the upgrade path (product).
- Note that examples assume release name appsmith-ee and that the Redis
  Secret name is a fixed default; add a Docker pointer (architecture).
- Discourage the :latest bootstrap image in favor of a pinned tag.
- Align terminology: cleartext -> plaintext.
- Fix invalid YAML (missing space) in the external Redis k8s example.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants