Skip to content

Commit 381ac87

Browse files
committed
DOC-5354 Copied missing instance parameters and details to RS 7.8 crdb-cli references
1 parent 4201ded commit 381ac87

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

content/operate/rs/7.8/references/cli-utilities/crdb-cli/crdb/add-instance.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,20 @@ Adds a peer replica to an existing Active-Active database in order to host the d
1515

1616
```sh
1717
crdb-cli crdb add-instance --crdb-guid <guid>
18-
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>]
19-
[ --compression <0-6> ]
20-
[ --no-wait ]
18+
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=https://<hostname-or-IP>:9443,replication_endpoint=<hostname-or-IP>:<port>,replication_tls_sni=<hostname>]
19+
[--compression <0-6>]
20+
[--wait | --no-wait]
2121
```
2222

2323
### Parameters
2424

2525
| Parameter | Value | Description |
2626
|-----------|---------|-------------|
2727
| crdb-guid | string | The GUID of the database (required) |
28-
| instance | strings | The connection information for the new participating cluster (required) |
29-
| compression | 0-6 | The level of data compression: 0=Compression disabled <br> <br> 6=High compression and resource load (Default: 3) |
30-
| no-wait | | Does not wait for the task to complete |
28+
| 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 new participating cluster (required)<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 |
29+
| compression | 0-6 | The level of data compression: <br /><br > 0 = No compression <br /><br > 6 = High compression and resource load (Default: 3) |
30+
| wait | | Prevents `crdb-cli` from running another command before this command finishes |
31+
| no-wait | | `crdb-cli` can run another command before this command finishes |
3132

3233
### Returns
3334

content/operate/rs/7.8/references/cli-utilities/crdb-cli/crdb/create.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Creates an Active-Active database.
1616
```sh
1717
crdb-cli crdb create --name <name>
1818
--memory-size <maximum_memory>
19-
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>]
20-
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>]
19+
--instance fqdn=<cluster1.example.com>,username=<username>,password=<password>[,url=https://<hostname-or-IP>:9443,replication_endpoint=<hostname-or-IP>:<port>,replication_tls_sni=<hostname>]
20+
--instance fqdn=<cluster2.example.com>,username=<username>,password=<password>[,url=https://<hostname-or-IP>:9443,replication_endpoint=<hostname-or-IP>:<port>,replication_tls_sni=<hostname>]
2121
[--port <port_number>]
22-
[--no-wait]
22+
[--wait | --no-wait]
2323
[--default-db-config <configuration>]
2424
[--default-db-config-file <filename>]
2525
[--compression <0-6>]
@@ -31,8 +31,11 @@ crdb-cli crdb create --name <name>
3131
[--shards-count <number_of_shards>]
3232
[--shard-key-regex <regex_rule>]
3333
[--oss-cluster { true | false } ]
34+
[--oss-sharding { true | false } ]
3435
[--bigstore { true | false }]
3536
[--bigstore-ram-size <maximum_memory>]
37+
[--eviction-policy { noeviction | allkeys-lru | allkeys-lfu |allkeys-random | volatile-lru | volatile-lfu | volatile-random | volatile-ttl }]
38+
[--proxy-policy { all-nodes | all-master-shards | single }]
3639
[--with-module name=<module_name>,version=<module_version>,args=<module_args>]
3740
```
3841
@@ -50,11 +53,12 @@ Before you create an Active-Active database, you must have:
5053
|---------------------------------------------------------------------------------------|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5154
| name \<CRDB_name\> | string | Name of the Active-Active database (required) |
5255
| memory-size \<maximum_memory\> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required) |
53-
| instance<br/>&nbsp;&nbsp; fqdn=\<cluster_fqdn\>,<br/>&nbsp;&nbsp; username=\<username\>,<br/>&nbsp;&nbsp; password=\<password\> | strings | The connection information for the participating clusters (required for each participating cluster) |
56+
| 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 |
5457
| port \<port_number\> | integer | TCP port for the Active-Active database on all participating clusters |
5558
| default-db-config \<configuration\> | string | Default database configuration options |
5659
| default-db-config-file \<filename\> | filepath | Default database configuration options from a file |
57-
| no-wait | | Prevents `crdb-cli` from running another command before this command finishes |
60+
| wait | | Prevents `crdb-cli` from running another command before this command finishes |
61+
| no-wait | | `crdb-cli` can run another command before this command finishes |
5862
| compression | 0-6 | The level of data compression: <br /><br > 0 = No compression <br /><br > 6 = High compression and resource load (Default: 3) |
5963
| causal-consistency | true <br/> false (*default*) | [Causal consistency]({{< relref "/operate/rs/7.8/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received |
6064
| password \<password\> | string | Password for access to the database |

0 commit comments

Comments
 (0)