From 3e0beaace224c8e1eee7b75bca1230beb5803220 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Tue, 15 Apr 2025 14:41:19 -0500 Subject: [PATCH 1/2] DOC-5038 RS: Added preserve_roles to upgrade DB examples --- .../rs/installing-upgrading/upgrading/upgrade-database.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md b/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md index 5f4db7ca8..e254b6660 100644 --- a/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md +++ b/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md @@ -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. - To upgrade a database and its modules: ``` shell - rladmin upgrade db + rladmin upgrade db preserve_roles ``` Example of a successful upgrade: @@ -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 redis_version + rladmin upgrade db redis_version preserve_roles ``` 1. Check the Redis database compatibility version for the database to confirm the upgrade. From faf25dcff6bf0f454ceadf124d73476b89e3d5ad Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Tue, 15 Apr 2025 14:45:34 -0500 Subject: [PATCH 2/2] DOC-5038 RS: Copy edit to add more detail --- .../rs/installing-upgrading/upgrading/upgrade-database.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md b/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md index e254b6660..99c5a9869 100644 --- a/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md +++ b/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md @@ -81,7 +81,7 @@ 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. Use the `preserve_roles` option to keep the database's current state, including primary shard placement. +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: