Skip to content

Commit 825a1f0

Browse files
committed
DOC-5124 RS: Added update-db-config-modules option to CRDB update reference & Active-Active upgrade doc
1 parent 5e1b0aa commit 825a1f0

File tree

2 files changed

+8
-27
lines changed

2 files changed

+8
-27
lines changed

content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -107,36 +107,15 @@ without upgrading the CRDB protocol version.
107107
700140c5-478e-49d7-ad3c-64d517ddc486 aatest 2 aatest2.example.com
108108
```
109109

110-
1. Update module information in the CRDB configuration using the following command syntax:
110+
1. Update module information in the CRDB configuration using the following command:
111111

112112
```sh
113-
crdb-cli crdb update --crdb-guid <guid> --default-db-config \
114-
'{ "module_list":
115-
[
116-
{
117-
"module_name": "<module1_name>",
118-
"semantic_version": "<module1_version>"
119-
},
120-
{
121-
"module_name": "<module2_name>",
122-
"semantic_version": "<module2_version>"
123-
}
124-
]}'
113+
crdb-cli crdb update --crdb-guid <guid> --update-db-config-modules true
125114
```
126115

127-
For example:
116+
`crdb-cli` will ask you to verify all Active-Active database instances and their modules have been updated before you enter `y` to continue.
128117

129-
```sh
130-
crdb-cli crdb update --crdb-guid 82a80988-f5fe-4fa5-bca0-aef2a0fd60db --default-db-config \
131-
'{ "module_list":
132-
[
133-
{
134-
"module_name": "search",
135-
"semantic_version": "2.4.6"
136-
},
137-
{
138-
"module_name": "ReJSON",
139-
"semantic_version": "2.4.5"
140-
}
141-
]}'
118+
```
119+
Verify that all CRDB database instances and their modules have been updated.
120+
Do you want to continue? (y/n): y
142121
```

content/operate/rs/references/cli-utilities/crdb-cli/crdb/update.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ crdb-cli crdb update --crdb-guid <guid>
2727
[--memory-size <maximum_memory>]
2828
[--bigstore-ram-size <maximum_memory>]
2929
[--update-module name=<name>,featureset_version=<version>]
30+
[--update-db-config-modules { true | false } ]
3031
```
3132
3233
If you want to change the configuration of the local instance only, use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) instead.
@@ -50,6 +51,7 @@ If you want to change the configuration of the local instance only, use [`rladmi
5051
| eviction-policy | noeviction<br/>allkeys-lru<br/>allkeys-lfu<br/>allkeys-random<br/>volatile-lru<br/>volatile-lfu<br/>volatile-random<br/>volatile-ttl | Updates [eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) |
5152
| featureset-version | true<br/>false | Updates to latest FeatureSet version |
5253
| update-module name=\<name>,featureset_version=\<version\> | strings | Update a module to the specified version |
54+
| update-db-config-modules | true<br/>false | Updates module information in the CRDB configuration (default-db-config) based on the latest module data for the database. Use this option only after all CRDB database instances have upgraded their modules. |
5355
5456
### Returns
5557

0 commit comments

Comments
 (0)