You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
RS: Rearranged upgrade Active-Active DB page and added more details about rladmin status output (#2321)
* Upgrade A-A DB improvements
* DOC-5437 Copy edits and added in-page links to upgrade A-A DB
* Fix rladmin status relref
* DOC-5437 Feedback updates to clarify CRDB featureset and how to check if an A-A DB uses modules
Copy file name to clipboardExpand all lines: content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md
+82-53Lines changed: 82 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,115 +5,144 @@ categories:
5
5
- docs
6
6
- operate
7
7
- rs
8
-
description: Upgrade an Active-Active database.
8
+
description: How to upgrade an Active-Active database.
9
9
linkTitle: Active-Active databases
10
10
weight: 70
11
11
---
12
12
13
-
When you upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/active-active" >}}), you can also upgrade the CRDB protocol version and feature version.
13
+
## Upgrade an Active-Active database
14
14
15
-
## CRDB protocol version guidelines
15
+
To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/active-active" >}}):
16
16
17
-
Redis Enterprise Software versions 5.4.2 and later use CRDB protocol version 1 to help support Active-Active features.
17
+
1.[Upgrade Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) on each node in the clusters where the Active-Active instances are located.
18
18
19
-
CRDB protocol version 1 is backward compatible, which means Redis Enterprise v5.4.2 CRDB instances can understand write operations from instances using the earlier CRDB protocol version 0.
19
+
1.[Check the status](#check-database-status) of all Active-Active database instances.
20
20
21
-
After you upgrade one instance's CRDB protocol to version 1:
21
+
1.[Upgrade all Active-Active database instances](#upgrade-database-instances)to a later version of Redis.
22
22
23
-
- Any instances that use CRDB protocol version 1 can receive updates from both version 1 and version 0 instances.
23
+
1. If the status indicates `OLD CRDB FEATURESET VERSION`, [upgrade the featureset version](#upgrade-featureset-version). See [Feature version guidelines](#feature-version-guidelines) for more information.
24
24
25
-
- However, instances that still use CRDB protocol version 0 cannot receive write updates from version 1 instances.
25
+
1. If your Active-Active database uses modules, [update module information](#update-module-information). To check if your database uses modules, run [`rladmin status modules`]({{<relref "/operate/rs/references/cli-utilities/rladmin/status#status-modules">}}):
26
26
27
-
- After you upgrade an instance from CRDB protocol version 0 to version 1, it automatically receives any missing write operations.
27
+
```sh
28
+
rladmin status modules db { db:<ID>|<database-name> }
29
+
```
28
30
29
-
Follow these upgrade guidelines:
31
+
## Check database status
30
32
31
-
- Upgrade all instances of a specific CRDB within a reasonable time frame to avoid temporary inconsistencies between the instances.
33
+
To check the status of an Active-Active database instance, run [`rladmin status`]({{<relref "/operate/rs/references/cli-utilities/rladmin/status">}}):
32
34
33
-
- Make sure that you upgrade all instances of a specific CRDB before you do global operations on the CRDB, such as removing instances and adding new instances.
35
+
```sh
36
+
rladmin status
37
+
```
34
38
35
-
- As of v6.0.20, protocol version 0 is deprecated and support will be removed in a future version.
- To avoid upgrade failures, update all Active-Active databases to protocol version 1 _before_ upgrading Redis Enterprise Software to v6.0.20 or later.
41
+
The statuses of the Active-Active instances on the node can indicate:
38
42
39
-
## Feature version guidelines
43
+
- `OLD REDIS VERSION`: The database instance is running a Redis version that is outdated or not fully compatible with the current Redis Enterprise Software cluster version. You should [upgrade the database](#upgrade-database-instances) to a later version of Redis bundled with the cluster's current Redis Enterprise Software version.
40
44
41
-
Starting with version 5.6.0, a new feature version (also called a _feature set version_) helps support new Active-Active features.
45
+
- `OLD CRDB PROTOCOL VERSION`: This instance uses an older CRDB protocol. Redis Enterprise Software versions 5.4.2 and later use CRDB protocol version 1. You can upgrade the CRDB protocol version when you [upgrade the Active-Active database instances](#upgrade-database-instances). See [CRDB protocol version guidelines](#crdb-protocol-version-guidelines) for more information.
42
46
43
-
When you update the feature version for an Active-Active database, the feature version is updated for all database instances.
44
-
45
-
Follow these upgrade guidelines:
47
+
- `OLD CRDB FEATURESET VERSION`: The database feature set version is outdated. After all [Active-Active database instances are upgraded](#upgrade-database-instances), [upgrade the feature set version](#upgrade-featureset-version). See [Feature version guidelines](#feature-version-guidelines) for more information.
46
48
47
-
- As of v6.0.20, feature version 0 is deprecated and support will be removed in a future version.
49
+
## Upgrade database instances
48
50
49
-
- To avoid upgrade failures, update all Active-Active databases to protocol version 1 _before_ upgrading Redis Enterprise Software to v6.0.20 or later.
51
+
For each Active-Active database instance:
50
52
51
-
##Upgrade Active-Active database instance
53
+
1. Upgrade the Redis database version and enabled modules with [`rladmin upgrade db`]({{<relref "/operate/rs/references/cli-utilities/rladmin/upgrade#upgrade-db">}}):
52
54
53
-
To upgrade an Active-Active database (CRDB) instance:
55
+
```sh
56
+
rladmin upgrade db { db:<ID>|<database-name> }
57
+
```
54
58
55
-
1.[Upgrade Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) on each node in the clusters where the Active-Active instances are located.
59
+
1. If the CRDB protocol version is old, read the warning message carefully and confirm that you want to update the CRDB protocol. See [CRDB protocol version guidelines](#crdb-protocol-version-guidelines) for more information.
56
60
57
-
1. To see the status of your Active-Active instances, run:
After confirmation, the Active-Active instance will use the new Redis version and CRDB protocol version.
62
64
63
-
The statuses of the Active-Active instances on the node can indicate:
65
+
{{<note>}}
66
+
You can use the `keep_crdt_protocol_version` option to upgrade the database version without upgrading the CRDB protocol version. However, you must upgrade the CRDB protocol before you update the CRDB feature set version.
64
67
65
-
- `OLD REDIS VERSION`
66
-
- `OLD CRDB PROTOCOL VERSION`
67
-
- `OLD CRBD FEATURESET VERSION`
68
+
If you use `keep_crdt_protocol_version`, make sure that you upgrade the CRDB protocol soon after with the [`rladmin upgrade db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade#upgrade-db">}}) command.
1. To upgrade each Active-Active instance and its modules, including the Redis version and CRDB protocol version, run:
73
+
Redis Enterprise Software versions 5.4.2 and later use CRDB protocol version 1 to help support Active-Active features.
72
74
73
-
```sh
74
-
rladmin upgrade db <database_name | database_ID>
75
-
```
75
+
CRDB protocol version 1 is backward compatible, which means Redis Enterprise v5.4.2 CRDB instances can understand write operations from instances using the earlier CRDB protocol version 0.
76
76
77
-
If the protocol version is old, read the warning message carefully and confirm.
77
+
After you upgrade one instance's CRDB protocol to version 1:
- Any instances that use CRDB protocol version 1 can receive updates from both version 1 and version 0 instances.
80
80
81
-
The Active-Active instance uses the new Redis version and CRDB protocol version.
81
+
- However, instances that still use CRDB protocol version 0 cannot receive write updates from version 1 instances.
82
82
83
-
Use the `keep_crdt_protocol_version` option to upgrade the database feature version
84
-
without upgrading the CRDB protocol version.
83
+
- After you upgrade an instance from CRDB protocol version 0 to version 1, it automatically receives any missing write operations.
85
84
86
-
If you use this option, make sure that you upgrade the CRDB protocol soon after with the [`rladmin upgrade db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade#upgrade-db">}}) command.
85
+
Follow these upgrade guidelines:
87
86
88
-
You must upgrade the CRDB protocol before you update the CRDB feature set version.
87
+
- Upgrade all instances of a specific CRDB within a reasonable time frame to avoid temporary inconsistencies between the instances.
89
88
90
-
1. If the feature set version is old, you must upgrade all of the Active-Active instances. Then, to update the feature setfor each active-active database, run:
89
+
- Make sure that you upgrade all instances of a specific CRDB before you perform global operations on the CRDB, such as removing instances and adding new instances.
- As of v6.0.20, protocol version 0 is deprecated and support will be removed in a future version.
95
92
96
-
You can retrieve the `<CRDB-GUID>` with the following command:
93
+
- To avoid upgrade failures, update all Active-Active databases to protocol version 1 _before_ upgrading Redis Enterprise Software to v6.0.20 or later.
94
+
95
+
## Upgrade featureset version
96
+
97
+
If the feature set version is old, as indicated by the `OLD CRDB FEATURESET VERSION` status:
98
+
99
+
1. [Upgrade all Active-Active database instances](#upgrade-database-instances) and make sure the CRDB protocol is not outdated.
100
+
101
+
1. Find the `<CRDB-GUID>` of your Active-Active database.
102
+
103
+
You can use the [`crdb-cli crdb list`]({{<relref "/operate/rs/references/cli-utilities/crdb-cli/crdb/list">}}) command:
97
104
98
105
```sh
99
106
crdb-cli crdb list
100
107
```
101
108
102
-
Look for the fully qualified domain name (CLUSTER-FDQN) of your cluster and use the associated GUID:
109
+
Look for the fully qualified domain name (`CLUSTER-FDQN`) of your cluster and use the associated `GUID`:
Starting with version 5.6.0, a new feature version (also called a _feature set version_) helps support new Active-Active features.
126
+
127
+
The featureset version is an internal version of the Active-Active feature that enables new capabilities and improvements across participating Active-Active clusters. When you update the feature version for an Active-Active database, the feature version is updated for all database instances.
128
+
129
+
Follow these upgrade guidelines:
130
+
131
+
- As of v6.0.20, feature version 0 is deprecated and support will be removed in a future version.
132
+
133
+
- To avoid upgrade failures, make sure all your Active-Active databases are configured with the latest feature set version before upgrading to Redis Enterprise Software 6.0.20 or later.
134
+
135
+
## Update module information
136
+
137
+
If your Active-Active database uses modules:
138
+
139
+
1. Update module information in the CRDB configuration using the following command syntax:
0 commit comments