Skip to content

Commit 1162d32

Browse files
authored
DOC-5434 RS: Added missing module_list field to CRDB REST API references (#1986)
1 parent f5a8f3c commit 1162d32

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,18 @@ An object that represents the database configuration.
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| aof_policy | string | Policy for Append-Only File data persistence |
19-
| authentication_admin_pass | string | Administrative databases access token |
20-
| authentication_redis_pass | string | Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |
19+
| <span class="break-all">authentication_admin_pass</span> | string | Administrative databases access token |
20+
| <span class="break-all">authentication_redis_pass</span> | string | Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |
2121
| bigstore | boolean | Database driver is Auto Tiering |
2222
| bigstore_ram_size | integer | Memory size of RAM size |
2323
| data_persistence | string | Database on-disk persistence |
24-
| enforce_client_authentication | **'enabled'** <br />'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either <span class="break-all">`authentication_ssl_client_certs`</span> or <span class="break-all">`authentication_ssl_crdt_certs`</span> |
24+
| <span class="break-all">enforce_client_authentication</span> | **'enabled'** <br />'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either <span class="break-all">`authentication_ssl_client_certs`</span> or <span class="break-all">`authentication_ssl_crdt_certs`</span> |
2525
| max_aof_file_size | integer | Hint for maximum AOF file size |
2626
| max_aof_load_time | integer | Hint for maximum AOF reload time |
2727
| memory_size | integer | Database memory size limit, in bytes |
28+
| module_list | array of module objects | List of modules to be loaded to all participating clusters of the Active-Active database<br />{{<code>}}[{<br /> "module_id": string,<br /> "module_args": string,<br /> "module_name": string,<br /> "semantic_version": string<br />}, ...]{{</code>}}<br />**module_id**: Module UID <br />**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version<br /><br />As of Redis Enterprise Software v7.4.2, **module_id** and **semantic_version** are optional. |
2829
| oss_cluster | boolean | Enables OSS Cluster mode |
29-
| oss_cluster_api_preferred_ip_type | string | Indicates preferred IP type in OSS cluster API: internal/external |
30+
| <span class="break-all">oss_cluster_api_preferred_ip_type</span> | 'internal'<br />'external' | Indicates preferred IP type in OSS cluster API |
3031
| oss_sharding | boolean | An alternative to shard_key_regex for using the common case of the OSS shard hashing policy |
3132
| port | integer | TCP port for database access |
3233
| proxy_policy | string | The policy used for proxy binding to the endpoint |

content/operate/rs/7.8/references/rest-api/objects/crdb/database_config.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,18 @@ An object that represents the database configuration.
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| aof_policy | **'appendfsync-every-sec'** <br />'appendfsync-always' | Policy for Append-Only File data persistence |
19-
| authentication_admin_pass | string | Administrative databases access token |
20-
| authentication_redis_pass | string | Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |
19+
| <span class="break-all">authentication_admin_pass</span> | string | Administrative databases access token |
20+
| <span class="break-all">authentication_redis_pass</span> | string | Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |
2121
| bigstore | boolean (default: false) | Database driver is Auto Tiering |
2222
| bigstore_ram_size | integer (default: 0) | Memory size of RAM size |
2323
| data_persistence | 'disabled'<br />'snapshot'<br />**'aof'** | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/7.8/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided |
24-
| enforce_client_authentication | **'enabled'** <br />'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either <span class="break-all">`authentication_ssl_client_certs`</span> or <span class="break-all">`authentication_ssl_crdt_certs`</span> |
24+
| <span class="break-all">enforce_client_authentication</span> | **'enabled'** <br />'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either <span class="break-all">`authentication_ssl_client_certs`</span> or <span class="break-all">`authentication_ssl_crdt_certs`</span> |
2525
| max_aof_file_size | integer | Maximum AOF file size in bytes |
2626
| max_aof_load_time | integer (default: 3600) | Maximum AOF reload time in seconds |
2727
| memory_size | integer (default: 0) | Database memory size limit in bytes. 0 is unlimited. |
28+
| module_list | array of module objects | List of modules to be loaded to all participating clusters of the Active-Active database<br />{{<code>}}[{<br /> "module_id": string,<br /> "module_args": string,<br /> "module_name": string,<br /> "semantic_version": string,<br />}, ...]{{</code>}}<br />**module_id**: Module UID (deprecated; use `module_name` instead)<br />**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)<br /><br />**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2. |
2829
| oss_cluster | boolean (default: false) | Enables OSS Cluster mode |
29-
| oss_cluster_api_preferred_ip_type | 'internal'<br />'external' | Indicates preferred IP type in OSS cluster API |
30+
| <span class="break-all">oss_cluster_api_preferred_ip_type</span> | 'internal'<br />'external' | Indicates preferred IP type in OSS cluster API |
3031
| oss_sharding | boolean (default: false) | An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy |
3132
| port | integer | TCP port for database access |
3233
| proxy_policy | 'single'<br />'all-master-shards'<br />'all-nodes' | The policy used for proxy binding to the endpoint |

content/operate/rs/references/rest-api/objects/crdb/database_config.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,18 @@ An object that represents the database configuration.
1515
| Name | Type/Value | Description |
1616
|------|------------|-------------|
1717
| aof_policy | **'appendfsync-every-sec'** <br />'appendfsync-always' | Policy for Append-Only File data persistence |
18-
| authentication_admin_pass | string | Administrative databases access token |
19-
| authentication_redis_pass | string | Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |
18+
| <span class="break-all">authentication_admin_pass</span> | string | Administrative databases access token |
19+
| <span class="break-all">authentication_redis_pass</span> | string | Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |
2020
| bigstore | boolean (default: false) | Database driver is Auto Tiering |
2121
| bigstore_ram_size | integer (default: 0) | Memory size of RAM size |
2222
| data_persistence | 'disabled'<br />'snapshot'<br />**'aof'** | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided |
23-
| enforce_client_authentication | **'enabled'** <br />'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either <span class="break-all">`authentication_ssl_client_certs`</span> or <span class="break-all">`authentication_ssl_crdt_certs`</span> |
23+
| <span class="break-all">enforce_client_authentication</span> | **'enabled'** <br />'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either <span class="break-all">`authentication_ssl_client_certs`</span> or <span class="break-all">`authentication_ssl_crdt_certs`</span> |
2424
| max_aof_file_size | integer | Maximum AOF file size in bytes |
2525
| max_aof_load_time | integer (default: 3600) | Maximum AOF reload time in seconds |
2626
| memory_size | integer (default: 0) | Database memory size limit in bytes. 0 is unlimited. |
27+
| module_list | array of module objects | List of modules to be loaded to all participating clusters of the Active-Active database<br />{{<code>}}[{<br /> "module_id": string,<br /> "module_args": string,<br /> "module_name": string,<br /> "semantic_version": string,<br />}, ...]{{</code>}}<br />**module_id**: Module UID (deprecated; use `module_name` instead)<br />**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)<br /><br />**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2. |
2728
| oss_cluster | boolean (default: false) | Enables OSS Cluster mode |
28-
| oss_cluster_api_preferred_ip_type | 'internal'<br />'external' | Indicates preferred IP type in OSS cluster API |
29+
| <span class="break-all">oss_cluster_api_preferred_ip_type</span> | 'internal'<br />'external' | Indicates preferred IP type in OSS cluster API |
2930
| oss_sharding | boolean (default: false) | An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy |
3031
| port | integer | TCP port for database access |
3132
| proxy_policy | 'single'<br />'all-master-shards'<br />'all-nodes' | The policy used for proxy binding to the endpoint |

0 commit comments

Comments
 (0)