docs(self-managed): correct Cassandra upgrade guidance - #562
Merged
Conversation
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
📝 WalkthroughWalkthroughThe 0.6.0→0.6.1 upgrade guide adds safeguards for scoped deployment and credential preservation, generalizes Cassandra migration checks, updates StatefulSet rollout instructions, and strengthens control-plane health verification. ChangesUpgrade guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-docs-fix-061-upgrade-warnings.docs.buildwithfern.com/nvcf |
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 `@docs/user/release-notes/0.6.0-to-0.6.1-upgrade.md`:
- Around line 370-381: Clarify in the StatefulSet rollout instructions that
cassandra-0 is recreated first because the preceding command explicitly deletes
it; state that normal StatefulSet rollouts proceed from the highest ordinal
downward, so the controller is not inherently starting at ordinal 0.
🪄 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: ba278d70-9e82-4f3d-8069-bfae6921fc7e
📒 Files selected for processing (1)
docs/user/release-notes/0.6.0-to-0.6.1-upgrade.md
sbaum1994
enabled auto-merge
July 30, 2026 05:53
kristinapathak
approved these changes
Jul 30, 2026
4 tasks
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Correct the 0.6.0 to 0.6.1 Cassandra upgrade guide so operators avoid unsafe sync and password changes, rely on the controller rollout, and use accurate verification steps.
Additional Details (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
Why
The upgrade guide can lead operators into a failed unscoped Helmfile sync, manual pod deletion that conflicts with the StatefulSet controller, and a health check that misses unready containers. It also names a keyspace that is not part of the 0.6.1 release.
What changed
Customer Release Notes
Corrects the self-managed 0.6.0 to 0.6.1 Cassandra upgrade procedure.
Plan Summary
Not applicable. Documentation only.
Usage
Follow the warnings and verification commands in the updated upgrade guide.
Notes
The full docs check reports one advisory docs-version-sync path warning that is also present on the clean baseline. Fern reports 0 errors.
References
Related Pull Requests
None.
Dependencies
None.
For the Reviewer
Review the warning placement, failed-sync recovery sequence, automatic rollout guidance, and readiness-aware pod filter.
For QA (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
./tools/ci/check-docs: Fern reports 0 errors and 1 baseline advisory warning.Issues
Relates to #317
Checklist
Summary by CodeRabbit