Skip to content

RS: Documented CRDB default_db_config usage and config requirements #3540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rrelledge wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RS: Documented CRDB default_db_config usage and config requirements #3540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions content/operate/rs/databases/active-active/planning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,15 @@ The `replication_oom_threshold_percent` setting works as follows:

- If memory reaches `maxmemory` despite the client block, the standard out-of-memory behavior applies to all operations, including replication.

`replication_oom_threshold_percent` defaults to `5`, which means 5% of `maxmemory` is reserved. To adjust the reserved percentage, use an [update database configuration]({{<relref "operate/rs/references/rest-api/requests/bdbs#put-bdbs">}}) REST API request:
`replication_oom_threshold_percent` defaults to `5`, which means 5% of `maxmemory` is reserved. To adjust the reserved percentage in all participating clusters, use an [update Active-Active database configuration]({{<relref "/operate/rs/references/rest-api/requests/crdbs#patch-crdbs">}}) REST API request:

```sh
PUT https://<host>:<port>/v1/bdbs/<database_id>
{ "replication_oom_threshold_percent": <integer from 0 to 20> }
PATCH https://<host>:<port>/v1/crdbs/<crdb_guid>
{
"default_db_config": {
"replication_oom_threshold_percent": <integer from 0 to 20>
}
}
```

## Networking
Expand Down
10 changes: 7 additions & 3 deletions content/operate/rs/databases/memory-performance/memory-limit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,15 @@ The `replication_oom_threshold_percent` setting works as follows:

- If memory reaches `maxmemory` despite the client block, the standard out-of-memory behavior applies to all operations, including replication.

`replication_oom_threshold_percent` defaults to `5`, which means 5% of `maxmemory` is reserved. To adjust the reserved percentage, use an [update database configuration]({{<relref "operate/rs/references/rest-api/requests/bdbs#put-bdbs">}}) REST API request:
`replication_oom_threshold_percent` defaults to `5`, which means 5% of `maxmemory` is reserved. To adjust the reserved percentage in all participating clusters, use an [update Active-Active database configuration]({{<relref "/operate/rs/references/rest-api/requests/crdbs#patch-crdbs">}}) REST API request:

```sh
PUT https://<host>:<port>/v1/bdbs/<database_id>
{ "replication_oom_threshold_percent": <integer from 0 to 20> }
PATCH https://<host>:<port>/v1/crdbs/<crdb_guid>
{
"default_db_config": {
"replication_oom_threshold_percent": <integer from 0 to 20>
}
}
```

## Adaptive memory allocation
Expand Down
4 changes: 2 additions & 2 deletions content/operate/rs/references/cli-utilities/crdb-cli/crdb/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ Before you create an Active-Active database, you must have:
| memory-size \<maximum_memory\> | size in bytes, megabytes (MB), or gigabytes (GB) | Maximum database memory (required) |
| instance fqdn=\<cluster_fqdn\>,username=\<username\>,password=\<password\>,url=https://\<hostname-or-IP\>:9443,replication_endpoint=\<hostname-or-IP\>:\<port\>,replication_tls_sni=\<hostname\> | strings | The connection information for the participating clusters (required for each participating cluster)<br/><br/>**Required:**<br/>• `fqdn` - Cluster fully qualified domain name<br/>• `username` - Cluster username<br/>• `password` - Cluster password<br/><br/>**Optional:**<br/>• `url` - URL to access the cluster's REST API<br/>• `replication_endpoint` - Address to access the database instance for peer replication<br/>• `replication_tls_sni` - Cluster [Server Name Indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) hostname for TLS connections |
| port \<port_number\> | integer | TCP port for the Active-Active database on all participating clusters |
| default-db-config \<configuration\> | string | Default database configuration options |
| default-db-config-file \<filename\> | filepath | Default database configuration options from a file |
| default-db-config \<configuration\> | string | Default database configuration options. For a list of database settings, see the [CRDB database config object]({{<relref "/operate/rs/references/rest-api/objects/crdb/database_config">}}) reference.|
| default-db-config-file \<filename\> | filepath | Default database configuration options from a file. For a list of database settings, see the [CRDB database config object]({{<relref "/operate/rs/references/rest-api/objects/crdb/database_config">}}) reference.|
| wait | | Prevents `crdb-cli` from running another command before this command finishes |
| no-wait | | `crdb-cli` can run another command before this command finishes |
| compression | 0-6 | The level of data compression: <br /><br > 0 = No compression <br /><br > 6 = High compression and resource load (Default: 3) |
Expand Down
2 changes: 1 addition & 1 deletion content/operate/rs/references/cli-utilities/crdb-cli/crdb/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you want to change the configuration of the local instance only, use [`rladmi
| compression | 0-6 | The level of data compression: <br /><br /> 0 = No compression <br /><br /> 6 = High compression and resource load (Default: 3) |
| credentials id=\<id\>,username=\<username\>,password=\<password\> | strings | Updates the credentials for access to the instance |
| default-db-config \<configuration\> | | Default database configuration from stdin. For a list of database settings, see the [CRDB database config object]({{<relref "/operate/rs/references/rest-api/objects/crdb/database_config">}}) reference. |
| default-db-config-file \<filename\> | filepath | Default database configuration from file |
| default-db-config-file \<filename\> | filepath | Default database configuration from file. For a list of database settings, see the [CRDB database config object]({{<relref "/operate/rs/references/rest-api/objects/crdb/database_config">}}) reference.|
| encryption | true <br/>false | Activates or deactivates encryption |
| force | | Force an update even if there are no changes |
| no-wait | | Do not wait for the command to finish |
Expand Down
12 changes: 6 additions & 6 deletions content/operate/rs/references/rest-api/objects/crdb/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ An object that represents an Active-Active database.
|------|------------|-------------|
| guid | string | The global unique ID of the Active-Active database |
| causal_consistency | boolean | Enables causal consistency across CRDT instances |
| default_db_config| [CRDB database_config]({{< relref "/operate/rs/references/rest-api/objects/crdb/database_config" >}}) object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects]({{< relref "/operate/rs/references/rest-api/objects/crdb/instance_info" >}}). |
| default_db_config| [CRDB database_config]({{< relref "/operate/rs/references/rest-api/objects/crdb/database_config" >}}) object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects]({{< relref "/operate/rs/references/rest-api/objects/crdb/instance_info" >}}). For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object]({{<relref "/operate/rs/references/rest-api/objects/crdb/database_config">}}) reference. |
| encryption | boolean | Encrypt communication |
| featureset_version | integer | Active-Active database active FeatureSet version
| instances | array of [CRDB instance_info]({{< relref "/operate/rs/references/rest-api/objects/crdb/instance_info" >}}) objects | |
| local_databases | {{<code>}}[{
| local_databases | object | Mapping of instance IDs for local databases to local BDB IDs<br />{{<code>}}[{
"bdb_uid": string,
"id": integer
}, ...] {{</code>}} | Mapping of instance IDs for local databases to local BDB IDs |
}, ...] {{</code>}} |
| managed_by | string | The component that manages the Active-Active database |
| modules | {{<code>}}[{
| modules | object | Modules used by the Active-Active database<br />{{<code>}}[{
"featureset_version": integer,
"module_name": string
}, ...] {{</code>}} | Modules used by the Active-Active database |
}, ...] {{</code>}} |
| name | string | Name of Active-Active database |
| protocol_version | integer | Active-Active database active protocol version |
| volatile_config_fields | array of strings | A list of database configuration fields that will be set even if unchanged |
| <span class="break-all">volatile_config_fields</span> | array of strings | A list of database configuration fields that will be set even if unchanged |
Loading
Loading