Skip to content

DOC-7145: Document coordinated Active-Active database upgrade - #4196

Open
tedraykov wants to merge 2 commits into
mainfrom
DOC-7145
Open

tedraykov wants to merge 2 commits into
mainfrom
DOC-7145

Conversation

@tedraykov

@tedraykov tedraykov commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

Rewrites the Active-Active upgrade page around the coordinated upgrade in Redis Software 8.0.18 and later. You now upgrade the database with a single crdb-cli crdb upgrade or POST /v1/crdbs/{crdb_guid}/upgrade request. Also adds a crdb-cli crdb upgrade reference page and lists upgrade in the crdb-cli overview.

Jira: DOC-7145

Conflicts with #4142. This PR removes the "Update module information" section that #4142 adds its --update-db-config-modules warning to. The warning needs a new home, possibly under Upgrade limitations. Its point that crdb-cli crdb upgrade pins module versions again in the default configuration applies to the procedure documented here.

Needs verification:

  • The crdb-cli crdb upgrade flag names come from the upgrade options table and haven't been checked against --help on 8.0.18 or later.
  • keep_crdt_featureset_version appears in the options table but not in the REST reference for POST /v1/crdbs/{crdb_guid}/upgrade.
  • The REST API accepts a modules field. It's unclear whether crdb-cli crdb upgrade has a matching flag.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes to upgrade procedures and API/CLI reference; no runtime code, though operators may follow the new flow and drop older per-instance steps.

Overview
Rewrites the Active-Active database upgrade guide for Redis Software 8.0.18+ coordinated upgrades: one crdb-cli crdb upgrade or POST /v1/crdbs/{crdb_guid}/upgrade call upgrades all participating clusters instead of per-cluster rladmin steps.

The page now leads with what the coordinated upgrade does (Redis/modules, module config sync, feature set), adds default Redis version and prerequisites (cluster upgrades, version support, backups, client compatibility), and puts crdb-cli first in multitabs with --preserve-roles, optional --redis-version, task polling, and post-upgrade rladmin status checks. Status troubleshooting is reframed around coordinated behavior and keep_crdt_protocol_version / keep_crdt_featureset_version instead of separate featureset and “update module information” procedures.

Adds a new crdb-cli crdb upgrade reference (flags, returns, examples) and mentions upgrade in the crdb-cli overview. Documents keep_crdt_featureset_version on the REST upgrade request body.

Reviewed by Cursor Bugbot for commit 16b713e. Bugbot is set up for automated code reviews on this repo. Configure here.

Rewrite the Active-Active upgrade page around the coordinated upgrade
(Redis Software 8.0.18 and later), which upgrades the database with a
single crdb-cli or REST API request. Add a crdb-cli crdb upgrade
reference page and list upgrade in the crdb-cli overview.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tedraykov tedraykov added the rs Redis Software label Oct 2, 2026
@CLAassistant

CLAassistant commented Oct 2, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7145

@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

@kaitlynmichael kaitlynmichael self-assigned this Oct 2, 2026
- Add keep_crdt_featureset_version to the REST API upgrade request body
- Show parallel-shards-upgrade accepts an integer or `all` in crdb-cli upgrade
- Upgrade guide: name the crdb-cli flag forms alongside the REST API fields
  for the protocol and feature set version options
- Point "additional options" links at the crdb-cli parameters and REST API
  request body instead of the in-page #upgrade-options anchor
- "featureset" -> "feature set" in prose; remove a stray blank line

@kaitlynmichael kaitlynmichael left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after a few small changes

@kaitlynmichael
kaitlynmichael requested a review from a team October 2, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rs Redis Software

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants