Skip to content

Revise rolling upgrade guide#599

Open
hammerhead wants to merge 2 commits into
mainfrom
hammerhead/upgrade
Open

Revise rolling upgrade guide#599
hammerhead wants to merge 2 commits into
mainfrom
hammerhead/upgrade

Conversation

@hammerhead

@hammerhead hammerhead commented Jul 16, 2026

Copy link
Copy Markdown
Member

About

We received feedback that the rolling upgrade guide was hard to follow for new users who aren't familiar yet with distributed systems. While the overall upgrade process was documented well before, there were the following issues:

  • Step-by-step instructions were interrupted by lengthy educational background information on certain parameters and their implications, causing a loss of focus. Now: Focus on the flow with default settings, elaborate on possible deviations separately.
  • Added an initial health check to ensure the cluster is green before starting
  • Removed a warning that upgrades aren't possible from "testing versions". This is not applicable if we understand "testing versions" as the testing channel, which are regular releases. It may have targeted nightly builds, but those aren't supported anyway.
  • Some of the SQL statements were outdated, querying _node instead of node from sys.shards, and also unnecessarily limiting their result to the schemas doc and blob.
  • There was an incorrect statement about writes only succeeding if a quorum of shards are present, contradicting the documentation of write.wait-for-active-shards
  • Replaced the outdated system command with modern systemctl in examples
  • The "Repeat" step was inconsistent, asking to issue SET GLOBAL TRANSIENT "cluster.routing.allocation.enable" = 'new_primaries'; after upgrading every single node, even though it wasn't reset
  • Added a post-upgrade health check to see if everything is back to green
  • Provided clearer guidance when to use min_availability options full, none, or primaries

Pending clarifications

Preview

https://cratedb-guide--599.org.readthedocs.build/admin/upgrade/rolling.html

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6df49ba9-5f03-4e8c-9293-e6c783f6115c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch hammerhead/upgrade

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@hammerhead
hammerhead force-pushed the hammerhead/upgrade branch 2 times, most recently from c450646 to 42785b2 Compare July 16, 2026 13:43
Mostly restructuring, separating step-by-step instructions from background knowledge about configuration parameters.
@hammerhead
hammerhead force-pushed the hammerhead/upgrade branch from 42785b2 to 4ba327e Compare July 16, 2026 13:55
@hammerhead
hammerhead marked this pull request as ready for review July 16, 2026 14:14
@hammerhead
hammerhead requested a review from karynzv July 17, 2026 12:09
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