Skip to content

RS: Added CM UI instructions to upgrade DB version#2899

Open
rrelledge wants to merge 2 commits intomainfrom
DOC-6312
Open

RS: Added CM UI instructions to upgrade DB version#2899
rrelledge wants to merge 2 commits intomainfrom
DOC-6312

Conversation

@rrelledge
Copy link
Collaborator

@rrelledge rrelledge commented Mar 17, 2026

Note

Low Risk
Documentation-only change that adds UI-based upgrade and version-check instructions alongside existing rladmin guidance; no runtime or API behavior changes.

Overview
Adds Cluster Manager UI instructions for upgrading a Redis Software database version, presented alongside the existing rladmin workflow via multitabs.

Also adds UI-based steps to verify the upgraded database compatibility version, with rladmin verification retained as an alternative.

Written by Cursor Bugbot for commit 0fd829f. This will update automatically on new commits. Configure here.

@rrelledge rrelledge requested a review from a team March 17, 2026 22:22
@rrelledge rrelledge self-assigned this Mar 17, 2026
@rrelledge rrelledge added the rs Redis Software label Mar 17, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2026

DOC-6312

@jit-ci
Copy link

jit-ci bot commented Mar 17, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Contributor

@andy-stark-redis andy-stark-redis left a comment

Choose a reason for hiding this comment

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

Just a suggestion to simplify the current list with two tab groups (feel free to ignore it) but otherwise LGTM.

1. _(Optional)_ Back up the database to minimize the risk of data loss.

1. Use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade" >}}) to upgrade the database. During the upgrade process, the database will restart without losing any data. Use the `preserve_roles` option to keep the database's current state, including primary shard placement, and prevent the cluster from becoming unbalanced.
1. Upgrade the database using one of the following methods. During the upgrade process, the database will restart without losing any data.
Copy link
Contributor

Choose a reason for hiding this comment

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

Lanugage and links seem fine, but I wonder if you could simplify this by just having the two big multitabs directly after "To upgrade a database..." rather than the current list? It's quite complicated that you have two multitab groups with item 4 separating them (especially when the first tab contains two sequential numbered lists in itself).

You'd have a bit of duplication, adding items 1 to 4 from the outer list into both tabs, but I think it might be worthwhile to give a clearer presentation.

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.

2 participants