docs(self-managed): correct 0.6.1 upgrade documentation - #569
Conversation
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
📝 WalkthroughWalkthroughDocumentation updates clarify Cassandra StatefulSet migration, add 0.6.1 OpenBao and Cassandra release procedures, and route release-note navigation and redirects to versioned documentation. ChangesCassandra upgrade guidance
0.6.1 release procedure
Versioned documentation routing
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@deploy/helm/cassandra/docs/upgrade-from-bitnami.md`:
- Around line 63-67: Update the StatefulSet comparison text to state that only
volumeClaimTemplates.spec is shared unchanged, or explicitly qualify that all
volume claim template fields except metadata.labels match. Keep the existing
list of other shared fields and the note about removed labels.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 7ee309fe-4571-439f-88ed-680b1ff8bb8c
📒 Files selected for processing (2)
deploy/helm/cassandra/docs/upgrade-from-bitnami.mddocs/user/release-notes/0.6.0-to-0.6.1-upgrade.md
|
🌿 Preview your docs: https://nvidia-preview-docs-fix-061-upgrade-warnings.docs.buildwithfern.com/nvcf |
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
sbaum1994
changed the title
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/v0.6.1-rc/release-notes/0.6.1.md`:
- Around line 298-303: Update the 0.6.1 release instructions after OpenBao
health validation so make install runs directly only for fresh installs; for
existing data-bearing clusters, require completion of the documented Cassandra
migration method before performing the full-stack sync, preserving the existing
HELMFILE_ENV usage.
- Around line 307-312: Update the final pod-health check in the release notes to
reuse the Cassandra upgrade guide’s filtered readiness command, or an equivalent
kubectl status filter, so only pods that are not Running or Completed are shown
and no output indicates success.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 0b90a692-bfda-4e16-9e45-e242705f5552
📒 Files selected for processing (10)
docs/user/cluster-management/index.mddocs/user/release-notes/0.5.0-to-0.6.0-upgrade.mddocs/user/release-notes/0.6.0.mddocs/user/release-notes/index.mddocs/v0.6.1-rc/release-notes/0.6.0-to-0.6.1-upgrade.mddocs/v0.6.1-rc/release-notes/0.6.1.mddocs/v0.6.1-rc/release-notes/index.mdfern/docs.ymlfern/versions/dev.ymlfern/versions/v0.6.1-rc.yml
💤 Files with no reviewable changes (3)
- docs/user/release-notes/0.5.0-to-0.6.0-upgrade.md
- docs/user/release-notes/0.6.0.md
- fern/versions/dev.yml
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/v0.6.1-rc/release-notes/0.6.1.md`:
- Around line 298-303: Update the 0.6.1 release instructions after OpenBao
health validation so make install runs directly only for fresh installs; for
existing data-bearing clusters, require completion of the documented Cassandra
migration method before performing the full-stack sync, preserving the existing
HELMFILE_ENV usage.
- Around line 307-312: Update the final pod-health check in the release notes to
reuse the Cassandra upgrade guide’s filtered readiness command, or an equivalent
kubectl status filter, so only pods that are not Running or Completed are shown
and no output indicates success.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 0b90a692-bfda-4e16-9e45-e242705f5552
📒 Files selected for processing (10)
docs/user/cluster-management/index.mddocs/user/release-notes/0.5.0-to-0.6.0-upgrade.mddocs/user/release-notes/0.6.0.mddocs/user/release-notes/index.mddocs/v0.6.1-rc/release-notes/0.6.0-to-0.6.1-upgrade.mddocs/v0.6.1-rc/release-notes/0.6.1.mddocs/v0.6.1-rc/release-notes/index.mdfern/docs.ymlfern/versions/dev.ymlfern/versions/v0.6.1-rc.yml
💤 Files with no reviewable changes (3)
- docs/user/release-notes/0.5.0-to-0.6.0-upgrade.md
- docs/user/release-notes/0.6.0.md
- fern/versions/dev.yml
🛑 Comments failed to post (2)
docs/v0.6.1-rc/release-notes/0.6.1.md (2)
298-303: 🩺 Stability & Availability | 🟠 Major | 🏗️ Heavy lift
Gate the full-stack sync on Cassandra migration.
This unconditionally runs
make installafter OpenBao rotation. For existing data-bearing clusters, the linked Cassandra guide explicitly forbids an unscoped install until a Cassandra migration method is complete; otherwise Helm attempts the immutable StatefulSet patch and fails. Make this step conditional for fresh installs, and require existing clusters to complete Cassandra migration first.Proposed wording
-After OpenBao is healthy on the updated OpenBao image, sync the rest of the -0.6.1 stack: +After OpenBao is healthy, fresh installations can sync the remaining 0.6.1 +stack. For existing data-bearing clusters, complete one of the Cassandra +migration methods in `0.6.0-to-0.6.1-upgrade.md` first. Do not run an +unscoped full-stack sync until Cassandra migration is complete.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.After OpenBao is healthy, fresh installations can sync the remaining 0.6.1 stack. For existing data-bearing clusters, complete one of the Cassandra migration methods in `0.6.0-to-0.6.1-upgrade.md` first. Do not run an unscoped full-stack sync until Cassandra migration is complete.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/v0.6.1-rc/release-notes/0.6.1.md` around lines 298 - 303, Update the 0.6.1 release instructions after OpenBao health validation so make install runs directly only for fresh installs; for existing data-bearing clusters, require completion of the documented Cassandra migration method before performing the full-stack sync, preserving the existing HELMFILE_ENV usage.
307-312: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Filter the final pod-health check before claiming success.
kubectl get pods -Aalways prints every pod, so this command cannot produce the stated empty result. Reuse the filtered readiness check from the Cassandra upgrade guide or add an equivalent status/readiness filter.Proposed fix
-kubectl get pods -A +kubectl get pods -A --no-headers | awk \ + '$4 != "Running" && $4 != "Completed" { print } + $4 == "Running" { + split($3, ready, "/") + if (ready[1] != ready[2]) print + }'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/v0.6.1-rc/release-notes/0.6.1.md` around lines 307 - 312, Update the final pod-health check in the release notes to reuse the Cassandra upgrade guide’s filtered readiness command, or an equivalent kubectl status filter, so only pods that are not Running or Completed are shown and no output indicates success.
|
🎉 This PR is included in version helm-nvcf-cassandra-v0.19.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
3 participants
TL;DR
Correct the Cassandra migration explanation and required values for the 0.6.0
to 0.6.1 upgrade. Publish the release-specific documents under the existing
0.6.1 RC documentation instead of the development documentation.
Additional Details (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
Why
The upgrade guide and Cassandra migration design note incorrectly state that
the StatefulSet name, selector, service name, and volume claim specification
differ. The name, selector, service name, pod management policy, and volume
claim specification remain unchanged.
The guide also overstates the values an operator must configure for in-place
volume adoption. The chart already supplies the correct image, filesystem group,
and cluster name for a standard deployment.
The 0.6.1 release notes and upgrade guide were published in the development
documentation. Release-specific documents belong to their matching versioned
documentation.
What changed
volumeClaimTemplates.metadata.labelsas the sole immutable-fielddifference.
app.kubernetes.io/nameandapp.kubernetes.io/instancelabels.cassandra.persistence.subPath: "data"subsection.environments/<HELMFILE_ENV>.yamlas the file to update and telloperators to merge the subsection without replacing the file.
docs/v0.6.1-rc.docs/user.locations.
Customer Release Notes
Corrects the Cassandra StatefulSet recreation and configuration guidance in the
self-managed 0.6.0 to 0.6.1 upgrade procedure. Publishes release notes and
upgrade guides with their corresponding documentation versions.
Plan Summary
Not applicable. Documentation only.
Usage
Select the 0.6.1 RC documentation to read the 0.6.1 release notes and upgrade
guide. Continue to follow the documented StatefulSet recreation procedure. Add
the documented
cassandra.persistence.subPathsubsection to the existingenvironment file.
Notes
This change does not modify the Cassandra chart or restore the removed labels.
The development release-notes landing page remains and directs readers to the
documentation version menu.
References
Related Pull Requests
Dependencies
None.
For the Reviewer
Confirm that both Cassandra documents accurately distinguish the unchanged
StatefulSet fields from the intentional label removal. Confirm that the customer
guide shows only the required migration-specific values subsection. Confirm
that release-specific pages appear only in versioned documentation and that the
former development routes redirect to their matching versions.
For QA (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
./tools/ci/check-docs: Fern reports 0 errors. The only warning is that theauthenticated redirect check was skipped because no Fern token is configured.
imports.yamlfrom theisolated worktree.
redirects are present, and no release-specific files remain under
docs/user/release-notes.git diff --checkpass.Issues
Relates to #317
Checklist
compliance.
Summary by CodeRabbit
persistence.subPath: "data"forcassandra.