Skip to content

fix: correct helm upgrade command in Kubernetes update guide - #3110

Open
wyattwalter wants to merge 2 commits into
mainfrom
ww-676-fix-k8s-helm-upgrade-command
Open

wyattwalter wants to merge 2 commits into
mainfrom
ww-676-fix-k8s-helm-upgrade-command

Conversation

@wyattwalter

Copy link
Copy Markdown
Contributor

Problem: The Kubernetes steps in "Update Appsmith" run helm upgrade with only the release name. Helm fails with "helm upgrade" requires 2 arguments. The steps also make the user find or rebuild values.yaml and edit it with yq.

The fix: Use one helm upgrade command with the chart name, --reset-then-reuse-values and --set image.tag=<version>. Add a step for when the chart schema rejects existing values.

Tradeoff: The upgrade moves the chart to its latest version. If a release value is not compatible with the new chart, Helm rejects the upgrade before it changes anything. The new fallback step keeps the installed chart version and updates only the image.

Description

Kubernetes tab of getting-started/setup/instance-management/update-appsmith.mdx:

  1. Choose the Appsmith version. This step is unchanged.
  2. Run helm repo update appsmith-ee.
  3. Run helm upgrade appsmith-ee appsmith-ee/appsmith -n appsmith-ee --reset-then-reuse-values --set image.tag=<version>. Users who keep values.yaml in source control set image.tag there and pass -f values.yaml.
  4. If Helm returns values don't meet the specifications of the schema(s), either fix the listed values, or pin the installed chart version:
    helm upgrade ... --version "$CHART_VERSION" --reuse-values --set image.tag=<version>. CHART_VERSION comes from helm get metadata.

--reset-then-reuse-values applies the new chart defaults, then the values of the current release, then the command-line overrides. --reuse-values would replace the new chart defaults with the old chart defaults. Both --reset-then-reuse-values and helm get metadata exist in Helm 3.14, the minimum version in the Kubernetes installation guide.

Pull request type

  • Error in documentation

Verification

  • The old command fails in Helm v4.2.4: Error: "helm upgrade" requires 2 arguments.
  • helm show chart --repo https://helm-ee.appsmith.com appsmith returns name: appsmith, version: 3.9.3.
  • Chart 3.9.3 rejects a value that does not match its schema: helm template with --set image.pullPolicy=Sometimes returns values don't meet the specifications of the schema(s).
  • I did not run a Docusaurus build locally. The change contains only Markdown lists and code blocks inside the existing TabItem. Validate the page on the deploy preview.

Rollback

Revert this PR.

🤖 Generated with Claude Code

wyattwalter and others added 2 commits November 19, 2026 14:26
The update guide ran `helm upgrade` with only the release name.
Helm requires both the release and the chart, so the command failed
with: "helm upgrade" requires 2 arguments.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the values.yaml and yq steps with one helm upgrade command.
The command keeps the release's values, applies the new chart defaults,
and sets the image tag. Add a fallback that keeps the installed chart
version when the new chart schema rejects existing values.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
appsmith-docs Ready Ready Preview Nov 19, 2026 10:55pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 10c00f88 Deployed Nov 19, 2026 by vercel[bot]
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.

1 participant