Skip to content

Commit 43170c5

Browse files
rrelledgerrelledge
authored
DOC-6039 RS: Removed upgrade module from 8.0.x rladmin reference and fixed some wording on older versions (#2538)
1 parent 56903d5 commit 43170c5

File tree

4 files changed

+12
-61
lines changed

4 files changed

+12
-61
lines changed

‎content/operate/rs/7.22/references/cli-utilities/rladmin/upgrade.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,17 @@ categories:
55
- docs
66
- operate
77
- rs
8-
description: Upgrades the version of a module or Redis Enterprise Software for a database.
8+
description: Upgrades the version of a module or Redis for a database.
99
headerRange: '[1-2]'
1010
linkTitle: upgrade
1111
toc: 'true'
1212
weight: $weight
1313
url: '/operate/rs/7.22/references/cli-utilities/rladmin/upgrade/'
1414
---
1515

16-
Upgrades the version of a module or Redis Enterprise Software for a database.
17-
1816
## `upgrade db`
1917

20-
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis Enterprise Software.
18+
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis.
2119

2220
For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/7.22/installing-upgrading/upgrading" >}}).
2321

@@ -49,7 +47,7 @@ As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade
4947
| force_discard | | Forces `discard_data` if replication or persistence is enabled |
5048
| keep_crdt_protocol_version | | Keeps the current CRDT protocol version |
5149
| keep_redis_version | | Upgrades to a new patch release, not to the latest major.minor version. Deprecated as of Redis Enterprise Software v7.8.2. To upgrade modules without upgrading the Redis database version, set `redis_version` to the current Redis database version instead. |
52-
| latest_with_modules | | Upgrades the Redis Enterprise Software version and all modules in the database. As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade modules. |
50+
| latest_with_modules | | Upgrades the Redis version and all modules in the database. As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade modules. |
5351
| parallel_shards_upgrade | integer <br />'all' | Maximum number of shards to upgrade all at once |
5452
| preserve_roles | | Performs an additional failover to guarantee the shards' roles are preserved |
5553
| redis_version | Redis version | Upgrades the database to the specified version instead of the latest version |

‎content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,17 @@ categories:
55
- docs
66
- operate
77
- rs
8-
description: Upgrades the version of a module or Redis Enterprise Software for a database.
8+
description: Upgrades the version of a module or Redis for a database.
99
headerRange: '[1-2]'
1010
linkTitle: upgrade
1111
toc: 'true'
1212
weight: $weight
1313
url: '/operate/rs/7.4/references/cli-utilities/rladmin/upgrade/'
1414
---
1515

16-
Upgrades the version of a module or Redis Enterprise Software for a database.
17-
1816
## `upgrade db`
1917

20-
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis Enterprise Software.
18+
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis.
2119

2220
For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading" >}}).
2321

@@ -47,7 +45,7 @@ As of v6.2.4, the default behavior for `upgrade db` has changed. It is now cont
4745
| force_discard | | Forces `discard_data` if replication or persistence is enabled |
4846
| keep_crdt_protocol_version | | Keeps the current CRDT protocol version |
4947
| keep_redis_version | | Upgrades to a new patch release, not to the latest major.minor version |
50-
| latest_with_modules | | Upgrades the Redis Enterprise Software version and all modules in the database |
48+
| latest_with_modules | | Upgrades the Redis version and all modules in the database |
5149
| parallel_shards_upgrade | integer <br />'all' | Maximum number of shards to upgrade all at once |
5250
| preserve_roles | | Performs an additional failover to guarantee the shards' roles are preserved |
5351
| redis_version | Redis version | Upgrades the database to the specified version instead of the latest version |

‎content/operate/rs/7.8/references/cli-utilities/rladmin/upgrade.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,17 @@ categories:
55
- docs
66
- operate
77
- rs
8-
description: Upgrades the version of a module or Redis Enterprise Software for a database.
8+
description: Upgrades the version of a module or Redis for a database.
99
headerRange: '[1-2]'
1010
linkTitle: upgrade
1111
toc: 'true'
1212
weight: $weight
1313
url: '/operate/rs/7.8/references/cli-utilities/rladmin/upgrade/'
1414
---
1515

16-
Upgrades the version of a module or Redis Enterprise Software for a database.
17-
1816
## `upgrade db`
1917

20-
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis Enterprise Software.
18+
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis.
2119

2220
For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/7.8/installing-upgrading/upgrading" >}}).
2321

@@ -49,7 +47,7 @@ As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade
4947
| force_discard | | Forces `discard_data` if replication or persistence is enabled |
5048
| keep_crdt_protocol_version | | Keeps the current CRDT protocol version |
5149
| keep_redis_version | | Upgrades to a new patch release, not to the latest major.minor version. Deprecated as of Redis Enterprise Software v7.8.2. To upgrade modules without upgrading the Redis database version, set `redis_version` to the current Redis database version instead. |
52-
| latest_with_modules | | Upgrades the Redis Enterprise Software version and all modules in the database. As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade modules. |
50+
| latest_with_modules | | Upgrades the Redis version and all modules in the database. As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade modules. |
5351
| parallel_shards_upgrade | integer <br />'all' | Maximum number of shards to upgrade all at once |
5452
| preserve_roles | | Performs an additional failover to guarantee the shards' roles are preserved |
5553
| redis_version | Redis version | Upgrades the database to the specified version instead of the latest version |

‎content/operate/rs/references/cli-utilities/rladmin/upgrade.md‎

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,16 @@ categories:
55
- docs
66
- operate
77
- rs
8-
description: Upgrades the version of a module or Redis Enterprise Software for a database.
8+
description: Upgrades a database's Redis version and modules.
99
headerRange: '[1-2]'
1010
linkTitle: upgrade
1111
toc: 'true'
1212
weight: $weight
1313
---
1414

15-
Upgrades the version of a module or Redis Enterprise Software for a database.
16-
1715
## `upgrade db`
1816

19-
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis Enterprise Software.
17+
Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis.
2018

2119
For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/installing-upgrading/upgrading" >}}).
2220

@@ -30,7 +28,7 @@ rladmin upgrade db { db:<id> | <name> }
3028
[ keep_crdt_protocol_version ]
3129
[ redis_version <version> ]
3230
[ force ]
33-
[ { latest_with_modules | and module module_name <module name> version <version> module_args <arguments string> } ]
31+
[ and module module_name <module name> version <version> module_args <arguments string> ]
3432
```
3533
3634
As of v6.2.4, the default behavior for `upgrade db` has changed. It is now controlled by a new parameter that sets the default upgrade policy used to create new databases and to upgrade ones already in the cluster. To learn more, see [`tune cluster default_redis_version`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}).
@@ -48,7 +46,6 @@ As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade
4846
| force_discard | | Forces `discard_data` if replication or persistence is enabled |
4947
| keep_crdt_protocol_version | | Keeps the current CRDT protocol version |
5048
| keep_redis_version | | Upgrades to a new patch release, not to the latest major.minor version. Deprecated as of Redis Enterprise Software v7.8.2. To upgrade modules without upgrading the Redis database version, set `redis_version` to the current Redis database version instead. |
51-
| latest_with_modules | | Upgrades the Redis Enterprise Software version and all modules in the database. As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade modules. |
5249
| parallel_shards_upgrade | integer <br />'all' | Maximum number of shards to upgrade all at once |
5350
| preserve_roles | | Performs an additional failover to guarantee the shards' roles are preserved |
5451
| redis_version | Redis version | Upgrades the database to the specified version instead of the latest version |
@@ -71,43 +68,3 @@ active - SMUpgradeBDB wait_for_version
7168
.completed - SMUpgradeBDB
7269
Done
7370
```
74-
75-
## `upgrade module`
76-
77-
Upgrades Redis modules in use by a specific database. Deprecated as of Redis Enterprise Software v7.8.2. Use [`upgrade db`](#upgrade-db) instead.
78-
79-
For more information, see [Upgrade modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}).
80-
81-
```sh
82-
rladmin upgrade module
83-
db_name { db:<id> | <name> }
84-
module_name <mod_name>
85-
version <version>
86-
module_args <args_str>
87-
```
88-
89-
### Parameters
90-
91-
| Parameters | Type/Value | Description |
92-
|----------------------------|--------------------------|------------------------------------------------------------------------------------------------------------------------|
93-
| db_name | db:\<id\> <br />name | Upgrade a module for the specified database |
94-
| module_name | 'ReJSON'<br />'graph'<br />'search'<br />'bf'<br />'rg'<br />'timeseries' | Redis module to upgrade |
95-
| version | module version number | Upgrades the module to the specified version |
96-
| module_args | 'keep_args'<br />string | Module configuration options |
97-
98-
For more information about module configuration options, see [Module configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database#module-configuration-options" >}}).
99-
100-
### Returns
101-
102-
Returns `Done` if the upgrade completed. Otherwise, it returns an error.
103-
104-
### Example
105-
106-
```sh
107-
$ rladmin upgrade module db_name db:8 module_name graph version 20812 module_args ""
108-
Monitoring 21ac7659-e44c-4cc9-b243-a07922b2a6cc
109-
active - SMUpgradeBDB init
110-
active - SMUpgradeBDB wait_for_version
111-
Ocompleted - SMUpgradeBDB
112-
Done
113-
```

0 commit comments

Comments
 (0)