From 8082a7c79512b56e0976b96ea5356801d72208c8 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Tue, 28 Jul 2026 13:24:04 -0500 Subject: [PATCH 1/2] DOC-6858: document redis_version in CRDB database_config object --- .../rs/7.22/references/rest-api/objects/crdb/database_config.md | 1 + .../rs/7.4/references/rest-api/objects/crdb/database_config.md | 1 + .../rs/7.8/references/rest-api/objects/crdb/database_config.md | 1 + .../rs/8.0/references/rest-api/objects/crdb/database_config.md | 1 + .../rs/references/rest-api/objects/crdb/database_config.md | 1 + 5 files changed, 5 insertions(+) diff --git a/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md index 25ee4fd9e1..7fb4dd38e7 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md @@ -36,6 +36,7 @@ An object that represents the database configuration. This configuration object | port | integer | TCP port for database access | | proxy_policy | 'single'
'all-master-shards'
'all-nodes' | The policy used for proxy binding to the endpoint | | rack_aware | boolean (default: false) | Require the database to be always replicated across multiple racks | +| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4` | | replication | boolean (default: true) | Database replication | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md index fec7809d08..adf0440d11 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md @@ -36,6 +36,7 @@ An object that represents the database configuration. This configuration object | port | integer | TCP port for database access | | proxy_policy | string | The policy used for proxy binding to the endpoint | | rack_aware | boolean | Require the database to be always replicated across multiple racks | +| redis_version | string | Version of the redis-server processes used to create the Active-Active database | | replication | boolean | Database replication | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | diff --git a/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md index 3a6eb48040..0e71341ce7 100644 --- a/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md @@ -36,6 +36,7 @@ An object that represents the database configuration. This configuration object | port | integer | TCP port for database access | | proxy_policy | 'single'
'all-master-shards'
'all-nodes' | The policy used for proxy binding to the endpoint | | rack_aware | boolean (default: false) | Require the database to be always replicated across multiple racks | +| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4` | | replication | boolean (default: true) | Database replication | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | diff --git a/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md index 8d538549c6..26c7b5385b 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md @@ -27,6 +27,7 @@ Use `default_db_config` to set the following fields so they apply to every insta |------|------------|-------------| | module_list | array of module objects | List of modules to be loaded to all participating clusters of the Active-Active database
{{}}[{
"module_id": string,
"module_args": string,
"module_name": string,
"semantic_version": string,
}, ...]{{}}
**module_id**: Module UID (deprecated; use `module_name` instead)
**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")
**module_name**: Module's name
**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)

**module_id** and **semantic_version** are optional as of Redis Software v7.4.2 and deprecated as of v7.8.2. | | oss_sharding | boolean (default: false) | An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy | +| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4` | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | | tls_mode | 'enabled'
**'disabled'**
'replica_ssl' | Encrypt communication | diff --git a/content/operate/rs/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/references/rest-api/objects/crdb/database_config.md index 97c5b0ceee..a527b4961e 100644 --- a/content/operate/rs/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/references/rest-api/objects/crdb/database_config.md @@ -26,6 +26,7 @@ Use `default_db_config` to set the following fields so they apply to every insta |------|------------|-------------| | module_list | array of module objects | List of modules to be loaded to all participating clusters of the Active-Active database
{{}}[{
"module_id": string,
"module_args": string,
"module_name": string,
"semantic_version": string,
}, ...]{{}}
**module_id**: Module UID (deprecated; use `module_name` instead)
**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")
**module_name**: Module's name
**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)

**module_id** and **semantic_version** are optional as of Redis Software v7.4.2 and deprecated as of v7.8.2. | | oss_sharding | boolean (default: false) | An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy | +| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4` | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | | tls_mode | 'enabled'
**'disabled'**
'replica_ssl' | Encrypt communication | From 60f1504f1c123cd4afce7c13e46c2ff4a0e6c269 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Wed, 29 Jul 2026 13:34:29 -0500 Subject: [PATCH 2/2] only 7.22 and later --- .../rs/7.22/references/rest-api/objects/crdb/database_config.md | 2 +- .../rs/7.4/references/rest-api/objects/crdb/database_config.md | 1 - .../rs/7.8/references/rest-api/objects/crdb/database_config.md | 1 - 3 files changed, 1 insertion(+), 3 deletions(-) diff --git a/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md index 7fb4dd38e7..691f18f228 100644 --- a/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.22/references/rest-api/objects/crdb/database_config.md @@ -36,7 +36,7 @@ An object that represents the database configuration. This configuration object | port | integer | TCP port for database access | | proxy_policy | 'single'
'all-master-shards'
'all-nodes' | The policy used for proxy binding to the endpoint | | rack_aware | boolean (default: false) | Require the database to be always replicated across multiple racks | -| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4` | +| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4`. Set this field in `default_db_config` so it applies to every instance. Do not set it in `db_config` at the instance level. | | replication | boolean (default: true) | Database replication | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md index adf0440d11..fec7809d08 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md @@ -36,7 +36,6 @@ An object that represents the database configuration. This configuration object | port | integer | TCP port for database access | | proxy_policy | string | The policy used for proxy binding to the endpoint | | rack_aware | boolean | Require the database to be always replicated across multiple racks | -| redis_version | string | Version of the redis-server processes used to create the Active-Active database | | replication | boolean | Database replication | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | diff --git a/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md index 0e71341ce7..3a6eb48040 100644 --- a/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md @@ -36,7 +36,6 @@ An object that represents the database configuration. This configuration object | port | integer | TCP port for database access | | proxy_policy | 'single'
'all-master-shards'
'all-nodes' | The policy used for proxy binding to the endpoint | | rack_aware | boolean (default: false) | Require the database to be always replicated across multiple racks | -| redis_version | string | Version of the redis-server processes used to create the Active-Active database, for example `7.4` | | replication | boolean (default: true) | Database replication | | sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` | | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` |