Skip to content

RS: Added preserve_roles to upgrade DB examples #1419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

RS: Added preserve_roles to upgrade DB examples #1419

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e0beaa
DOC-5038 RS: Added preserve_roles to upgrade DB examples
rrelledge Apr 15, 2025
faf25dc
DOC-5038 RS: Copy edit to add more detail
rrelledge Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/operate/rs/installing-upgrading/upgrading/upgrade-database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ To upgrade a database:

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.
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.

- To upgrade a database and its modules:

``` shell
rladmin upgrade db <database name | database ID>
rladmin upgrade db <database name | database ID> preserve_roles
```

Example of a successful upgrade:
Expand All @@ -104,7 +104,7 @@ To upgrade a database:
- To upgrade the database to a version other than the default version, use the `redis_version` parameter:

```sh
rladmin upgrade db <database name | database ID> redis_version <version>
rladmin upgrade db <database name | database ID> redis_version <version> preserve_roles
```

1. Check the Redis database compatibility version for the database to confirm the upgrade.
Expand Down