docs: Add warning about unsupported Helm v3.18.0#1316
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughAdds documentation warning about Helm v3.18.0 causing installation failures. Updates:
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Assessment against linked issues
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
modules/deploy/partials/requirements.adoc (1)
32-41: Add an anchor to enable cross-references from troubleshooting and elsewhereAdding a stable anchor lets us xref this warning from troubleshooting (and future docs), improving discoverability.
Apply this diff:
+[[@helm-3-18-0-unsupported]] [NOTE] ==== Helm v3.18.0 is not supported due to a bug that causes errors such as: [.no-copy] ---- Error: INSTALLATION FAILED: execution error at (redpanda/templates/entry-point.yaml:17:4): invalid Quantity expected string or float64 got: json.Number (1) ---- To avoid this and similar errors, upgrade to Helm v3.18.4 or later. For more details, see the https://github.com/helm/helm/issues/30880[Helm GitHub issue^].modules/troubleshoot/partials/errors-and-solutions.adoc (2)
11-22: Align version guidance with requirements note and add the other common symptom
- Aligns “later version” wording to the specific minimum “v3.18.4 or later” used in requirements.
- Adds the repository-name conflict symptom noted in DOC-1581, so users recognize the issue earlier in the flow.
- Adds a quick command to verify current Helm version.
- Optionally cross-links back to the requirements note (if you add the anchor as suggested).
Apply this diff:
//tag::deployment-helm-3-18[] === Helm v3.18.0 is not supported (json.Number error) If you are using Helm v3.18.0, you may encounter errors such as: [.no-copy] ---- Error: INSTALLATION FAILED: execution error at (redpanda/templates/entry-point.yaml:17:4): invalid Quantity expected string or float64 got: json.Number (1) ---- -This is due to a bug in Helm v3.18.0. To avoid similar errors, upgrade to a later version. For more details, see the https://github.com/helm/helm/issues/30880[Helm GitHub issue^]. +This is due to a bug in Helm v3.18.0. To avoid similar errors, upgrade to v3.18.4 or later. For more details, see the https://github.com/helm/helm/issues/30880[Helm GitHub issue^]. + +You may also see a repository conflict earlier in the process: + +[.no-copy] +---- +Error: repository name (redpanda) already exists, please specify a different name +---- + +Check your Helm version: + +[,bash] +---- +helm version +---- + +See also: xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc#helm-3-18-0-unsupported[Requirements note]. //end::deployment-helm-3-18[]
18-19: Consider future-proofing the example line/column referenceThe exact template path and line/column numbers can drift between chart releases. Keeping the error text is valuable; the specific “entry-point.yaml:17:4” may become stale.
If this becomes noisy to maintain, consider eliding the line/column and keeping the salient error:
- invalid Quantity expected string or float64 got: json.Number (1)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/deploy/partials/requirements.adoc(1 hunks)modules/troubleshoot/partials/errors-and-solutions.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (2)
modules/deploy/partials/requirements.adoc (1)
32-41: Good addition: clear, actionable warning with concrete error and upstream linkThis note concisely warns about Helm v3.18.0 and provides the exact error users may see, plus the upstream issue and a recommended fixed version. This aligns with the PR objectives and should reduce support friction.
modules/troubleshoot/partials/errors-and-solutions.adoc (1)
11-22: Nice placement and taggingWrapping this under deployment and with a dedicated tag block is consistent with the rest of the troubleshooting content and makes reuse straightforward.
4 participants
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1581
This pull request improves documentation around Helm compatibility by warning users about a known issue with Helm v3.18.0 and providing troubleshooting guidance. The most important changes are grouped below.
Helm compatibility warnings and troubleshooting:
modules/deploy/partials/requirements.adocexplicitly stating that Helm v3.18.0 is not supported due to a bug, including an example error message and a link to the relevant Helm GitHub issue.modules/troubleshoot/partials/errors-and-solutions.adocdescribing the Helm v3.18.0 bug, its symptoms, and the recommended solution to upgrade Helm, with a link to the GitHub issue for more details.Page previews
Checks