Skip to content

Commit 91cf5f3

Browse files
rrelledgecmilesbkaitlynmichaelnermiller
authored
rladmin reorg (RedisLabs#1944)
* Initial RS command-line utilities reorg * Added rladmin verify and rladmin cluster placeholders * DOC-1317 - RS: CLI Utitilites Reorg rladmin help and rladmin info commands (RedisLabs#1887) * Added rladmin help and rladmin info command information. * Added parameters and returns sections to info and help. * Apply suggestions from code review - help.md Co-authored-by: Rachel Elledge <[email protected]> * Apply suggestions from code review - info.md Co-authored-by: Rachel Elledge <[email protected]> * Made suggested changes to info.md - Changed "configurable settings" to "current configuration" - Added <id> | all for info proxy * Update content/rs/references/cli-utilities/rladmin/info.md Co-authored-by: Rachel Elledge <[email protected]> * Reorder rladmin info commands in alphabetical order Co-authored-by: Rachel Elledge <[email protected]> * DOC-1319 - RS Utilities Reorg: rladmin status page (RedisLabs#1891) * DOC-1319 - RS rladmin status page * Replace IP addresses * Standardize capitalization in tables * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Update content/rs/references/cli-utilities/rladmin/status.md * Normalize verb tense in tables * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Update status.md * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Escape < and > in tables Co-authored-by: Rachel Elledge <[email protected]> * DOC-1320 - RS CLI Utilities Reorg: rladmin tune commands (RedisLabs#1893) * Add rladmin tune page. * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Added Type/Value column to tables. * Update tune.md Co-authored-by: Rachel Elledge <[email protected]> * DOC-1323 - RS CLI Utilities Reorg: rladmin failover command (RedisLabs#1895) * Add rladmin failover page * Add hyphenation and capitalization corrections * Fix fragment on line 32 * DOC-1326 - RS CLI Utilities Reorg: rladmin placement command (RedisLabs#1901) * DOC-1328 - RS CLI Utilities Reorg: rladmin restart page (RedisLabs#1902) * Add rladmin restart page * Apply suggestions from code review Co-authored-by: Kaitlyn Michael <[email protected]> * Update restart.md * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: Kaitlyn Michael <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> * Minor edits for rladmin placement * Added crdb-cli crdb and coordinate landing pages * DOC-1321: RS CLI Utilities - rladmin suffix (RedisLabs#1917) * Add rladmin suffix page * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> * DOC-1322: RS CLI Reorg - rladmin bind page (RedisLabs#1916) * Add bind page * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Split rladmin bind include and exclude into their own sections * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> * DOC-1324: RS CLI Reorg - rladmin migrate page (RedisLabs#1919) * Add rladmin migrate * Made headings in alphabetical order * Change roles to primary/replica * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Changed parameter descriptions Co-authored-by: Rachel Elledge <[email protected]> * Reorg rladmin cluster commands (RedisLabs#1922) * Update rladmin cluster reference pages * Updated parameter tables for rladmin cluster commands * Update rladmin config parameters table * Updated rladmin cluster commands * Updated rladmin cluster command examples * Added ability to limit which pages appear in table-children with tags param * Added missing rladmin cluster commands * Feedback updates and additional edits * DOC-1325: RS CLI Reorg: rladmin node (RedisLabs#1920) * Add node structure and landing page * Add node addr set page * Apply suggestions from code review Co-authored-by: Nermina Miller <[email protected]> * Add node external_addr page * Replcae rladmin prompts in node external_addr * Change "node ID" to "integer" in param tables * Adds error clause in Returns * Add recovery_path set page * Add rladmin enslave page * Replace rladmin prompts in node enslave * Changed replica tense in node enslave * Added node snapshot page * Adds node snapshot restore section to node snapshot * Added node remove page * Add rladmin node maintenance_mode page * Update recovery-path.md * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Add seconds parameter to rladmin enslave Co-authored-by: Nermina Miller <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> * DOC-1329: RS CLI Utilites Reorg - rladmin upgrade command page (RedisLabs#1924) * Add rladmin upgrade page * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> * Update content/rs/references/cli-utilities/rladmin/upgrade.md Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> * Removed old CLI refs and updated links * DOC-1327: RS CLI Utilities - rladmin recover page (RedisLabs#1926) * Add rladmin recover page * Added fake recover examples * Removed fake recover examples and s3_import * Apply suggestions from code review Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> * rladmin reference edits * Add redis-cli overview (RedisLabs#1929) * Added redis-cli reference page * Updated redis-cli reference * Update redis-cli reference * Removed name option from rladmin cluster join (RedisLabs#1932) * Removed name option from rladmin cluster join * Feedback update * More CLI edits * Added more info to the CLI landing page (RedisLabs#1933) * Minor edits * More rladmin edits * rladmin node command edits * rladmin cluster command edits * Fixed relref * Add rladmin recover s3_import information * rladmin recover edits Co-authored-by: Cameron Bates <[email protected]> Co-authored-by: Kaitlyn Michael <[email protected]> Co-authored-by: Nermina Miller <[email protected]>
1 parent 06ef470 commit 91cf5f3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+3313
-882
lines changed

‎content/kubernetes/re-clusters/create-aa-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ crdb-cli crdb create
187187

188188
To create a database that syncs between more than two instances, add additional `--instance` arguments.
189189

190-
See the [`crdb-cli` reference]({{<relref "/rs/references/crdb-cli-reference.md">}}) for more options.
190+
See the [`crdb-cli` reference]({{<relref "/rs/references/cli-utilities/crdb-cli">}}) for more options.
191191

192192
## Test your database
193193

‎content/rs/administering/designing-production/networking/multi-ip-ipv6.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ addresses for internal traffic use, and assign one or more IPv4/IPv6
3131
addresses for external traffic.
3232

3333
If at a later stage you would like to update the IP address allocation,
34-
run the relevant commands in [rladmin command-line interface
35-
(CLI)]({{< relref "/rs/references/rladmin.md" >}}).
34+
run the relevant commands in [`rladmin` command-line interface
35+
(CLI)]({{<relref "/rs/references/cli-utilities/rladmin">}}).
3636

3737
If you need to update the internal IP address in the OS, you must remove
3838
that node from the RS cluster, make the IP change, and then add the node

‎content/rs/administering/monitoring-metrics/nagios-plugin.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,9 @@ below.
133133
1. "host_name" should be a unique value.
134134
1. "display_name " should be updated to a user-friendly name
135135
to show in the UI.
136-
1. "_RLECID " should be the database's internal id that can
136+
1. "_RLECID " should be the database's internal ID that can
137137
be retrieved from
138-
[rladmin]({{< relref "/rs/references/rladmin.md" >}})
139-
status command output.
138+
[`rladmin status`]({{<relref "/rs/references/cli-utilities/rladmin/status">}}) command output.
140139
1. "nodes.cfg " ­ holds configuration details of the nodes in the
141140
cluster. The "define host" section should be duplicated for
142141
every node in the cluster.
@@ -145,10 +144,9 @@ below.
145144
to show in the UI.
146145
1. "address" should be updated to the DNS name mapped to the
147146
IP address of the node, or to the IP address itself.
148-
1. "_RLECID " should be the node's internal id that can be
147+
1. "_RLECID " should be the node's internal ID that can be
149148
retrieved
150-
from [rladmin]({{< relref "/rs/references/rladmin.md" >}})
151-
status command output.
149+
from [`rladmin status`]({{<relref "/rs/references/cli-utilities/rladmin/status">}}) command output.
152150
1. Under the "/rlec_obj" folder:
153151
1. "rlec_cmd.cfg" ­ holds configuration details of how to
154152
activate the plugin. No need to make any updates to it.

‎content/rs/clusters/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ aliases: [
1717
You can manage your Redis Enterprise Software clusters with several different tools:
1818

1919
- Admin console (the web-based user interface)
20-
- Command-line tools ([rladmin]({{<relref "/rs/references/rladmin.md">}}), [redis-cli](https://redis.io/docs/manual/cli/), [crdb-cli]({{<relref "/rs/references/crdb-cli-reference.md">}}))
20+
- Command-line tools ([rladmin]({{<relref "/rs/references/cli-utilities/rladmin">}}), [redis-cli](https://redis.io/docs/manual/cli/), [crdb-cli]({{<relref "/rs/references/cli-utilities/crdb-cli">}}))
2121
- [REST API]({{<relref "/rs/references/rest-api/_index.md">}})
2222

2323
## Manage your cluster

‎content/rs/clusters/add-node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,6 @@ You can see it in the list of nodes in the cluster.
8080
If you see an error when you add the node, try adding the node again.
8181

8282
{{< tip >}}
83-
We recommend that you run the [rlcheck utility]({{< relref "/rs/references/rlcheck.md" >}}) to verify that the node is functioning properly.
83+
We recommend that you run the [rlcheck utility]({{<relref "/rs/references/cli-utilities/rlcheck">}}) to verify that the node is functioning properly.
8484
{{< /tip >}}
8585

‎content/rs/clusters/cluster-recovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ of the configuration and persistence files on each of the nodes.
7979
If you use local persistent storage, place all of the recovery files on each of the cluster nodes.
8080

8181
1. To recover the cluster configuration from the original cluster to the first node in the new cluster,
82-
from the [rladmin]({{< relref "/rs/references/rladmin.md" >}}) command-line interface (CLI):
82+
from the [`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}}) command-line interface (CLI):
8383

8484
```sh
8585
cluster recover filename [ <persistent_path> | <ephemeral_path> ]<filename> node_uid <node_uid> rack_id <rack_id>

‎content/rs/clusters/configure/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aliases:
1010
You can manage your Redis Enterprise Software clusters with several different tools:
1111

1212
- Admin console (the web-based user interface)
13-
- Command-line tools ([rladmin]({{<relref "/rs/references/rladmin.md">}}), [redis-cli](https://redis.io/docs/manual/cli/), [crdb-cli]({{<relref "/rs/references/crdb-cli-reference.md">}}))
13+
- Command-line tools ([rladmin]({{<relref "/rs/references/cli-utilities/rladmin">}}), [redis-cli](https://redis.io/docs/manual/cli/), [crdb-cli]({{<relref "/rs/references/cli-utilities/crdb-cli">}}))
1414
- [REST API]({{<relref "/rs/references/rest-api/_index.md">}})
1515

1616

‎content/rs/clusters/maintenance-mode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Maintenance mode does not protect against quorum loss. If you turn on maintenanc
2828
1. Takes a snapshot of the node configuration to record which shards and endpoints are on the node.
2929
1. Marks the node as a quorum node to prevent shards and endpoints from migrating to it.
3030
{{<note>}}
31-
If you run [`rladmin status`]({{<relref "/rs/references/rladmin#status">}}), the node's shards field is now yellow to show that shards cannot migrate to it.
31+
If you run [`rladmin status`]({{<relref "/rs/references/cli-utilities/rladmin/status">}}), the node's shards field is now yellow to show that shards cannot migrate to it.
3232
{{</note>}}
3333
![maintenance_mode](/images/rs/maintenance_mode.png)
3434
1. Migrates shards and binds endpoints to other nodes, if space is available.
@@ -121,7 +121,7 @@ rladmin node <node_id> maintenance_mode off skip_shards_restore
121121

122122
## Cluster status example
123123

124-
This example shows how the output of [`rladmin status`]({{<relref "/rs/references/rladmin#status">}}) changes when you turn on maintenance mode for a node.
124+
This example shows how the output of [`rladmin status`]({{<relref "/rs/references/cli-utilities/rladmin/status">}}) changes when you turn on maintenance mode for a node.
125125

126126
The cluster status before turning on maintenance mode:
127127

‎content/rs/clusters/remove-node.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ from the node you would like to remove, and only then remove the node.
6666
For further guidance, refer to [adding a new node to a
6767
cluster]({{< relref "/rs/clusters/add-node.md" >}}).
6868

69-
You can migrate resources by using the *rladmin* command-line interface
70-
(CLI). For guidelines, refer to [*rladmin* command line interface
71-
(CLI)]({{< relref "/rs/references/rladmin.md" >}}).
69+
You can migrate resources by using the `rladmin` command-line interface
70+
(CLI). For guidelines, refer to [`rladmin` command-line interface
71+
(CLI)]({{<relref "/rs/references/cli-utilities/rladmin">}}).
7272

7373
{{< note >}}
7474
The [DNS records]({{< relref "/rs/installing-upgrading/configuring/cluster-dns/_index.md" >}}) must be updated each time a node is added or replaced.

‎content/rs/connections/supported-clients-browsers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Note: You cannot use client libraries to configure Redis Enterprise Software. I
2222

2323
- The Redis Software [admin console]({{< relref "/rs/installing-upgrading/get-started-redis-enterprise-software.md" >}})
2424
- The [REST API]({{<relref "/rs/references/rest-api">}})
25-
- Command-line utilities, such as [`rladmin`]({{< relref "/rs/references/rladmin.md" >}})
25+
- Command-line utilities, such as [`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}})
2626

2727
### Discovery service
2828

‎content/rs/databases/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ aliases: [
1414
You can manage your Redis Enterprise Software databases with several different tools:
1515

1616
- Admin console (the web-based user interface)
17-
- Command-line tools ([rladmin]({{<relref "/rs/references/rladmin.md">}}), [redis-cli](https://redis.io/docs/manual/cli/), [crdb-cli]({{<relref "/rs/references/crdb-cli-reference.md">}}))
17+
- Command-line tools ([`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}}), [`redis-cli`](https://redis.io/docs/manual/cli/), [`crdb-cli`]({{<relref "/rs/references/cli-utilities/crdb-cli">}}))
1818
- [REST API]({{<relref "/rs/references/rest-api/_index.md">}})
1919

2020
{{< allchildren style="h2" description="true" />}}

‎content/rs/databases/active-active/edit-aa-database.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ most database settings only apply to the Active-Active database instance that yo
2626
- TLS mode
2727
- Periodic backup
2828

29-
You can change the global configuration of the Active-Active database from the command-line with the [crdb-cli]({{< relref "rs/references/crdb-cli-reference.md" >}}).
29+
You can change the global configuration of the Active-Active database from the command line with the [`crdb-cli`]({{<relref "/rs/references/cli-utilities/crdb-cli">}}).
3030

3131
## Participating clusters
3232

@@ -54,7 +54,7 @@ The joined participating clusters reject updates sent from the removed participa
5454

5555
Redis databases that use [replication for high availability]({{< relref "/rs/databases/configure/replication.md" >}}) maintain a replication backlog (per shard) to synchronize the primary and replica shards of a database.
5656
By default, the replication backlog is set to one percent (1%) of the database size divided by the database number of shards and ranges between 1MB to 250MB per shard.
57-
Use the [rladmin]({{< relref "rs/references/rladmin.md" >}}) and the [crdb-cli]({{< relref "rs/references/crdb-cli-reference.md" >}}) utilities to control the size of the replication backlog. You can set it to `auto` or set a specific size.
57+
Use the [`rladmin`]({{<relref "rs/references/cli-utilities/rladmin">}}) and the [`crdb-cli`]({{<relref "/rs/references/cli-utilities/crdb-cli">}}) utilities to control the size of the replication backlog. You can set it to `auto` or set a specific size.
5858

5959
The syntax varies between regular and Active-Active databases.
6060

@@ -72,7 +72,7 @@ crdb-cli crdb update --crdb-guid <crdb_guid> --default-db-config "{\"repl_backlo
7272

7373
In addition to the database replication backlog, Active-Active databases maintain a CRDT replication backlog (per shard) to synchronize the database instances between clusters.
7474
By default, the CRDT replication backlog is set to one percent (1%) of the Active-Active database size divided by the database number of shards and ranges between 1MB to 250MB per shard.
75-
Use the [crdb-cli]({{< relref "rs/references/crdb-cli-reference.md" >}}) utility to control the size of the CRDT replication backlog. You can set it to `auto` or set a specific size:
75+
Use the [`crdb-cli`]({{<relref "/rs/references/cli-utilities/crdb-cli">}}) utility to control the size of the CRDT replication backlog. You can set it to `auto` or set a specific size:
7676

7777
```text
7878
crdb-cli crdb update --crdb-guid <crdb_guid> --default-db-config "{\"crdt_repl_backlog_size\": <size in MB | 'auto'>}"
@@ -82,7 +82,7 @@ crdb-cli crdb update --crdb-guid <crdb_guid> --default-db-config "{\"crdt_repl_b
8282

8383
In addition to the database replication backlog, Active-Passive databases maintain a replication backlog (per shard) to synchronize the database instances between clusters.
8484
By default, the replication backlog is set to one percent (1%) of the database size divided by the database number of shards and ranges between 1MB to 250MB per shard.
85-
Use the [rladmin]({{< relref "rs/references/rladmin.md" >}}) utility to control the size of the replication backlog. You can set it to `auto` or set a specific size.
85+
Use the [`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}}) utility to control the size of the replication backlog. You can set it to `auto` or set a specific size.
8686

8787
For an Active-Passive database:
8888
```text
@@ -95,7 +95,7 @@ On an Active-Passive database, the replication backlog configuration applies to
9595

9696
**For Redis Software versions earlier than 6.0.20:**
9797
The replication backlog and the CRDT replication backlog defaults are set to 1MB and cannot be set dynamically with 'auto' mode.
98-
To control the size of the replication log, use [rladmin]({{< relref "rs/references/rladmin.md" >}}) to tune the local database instance in each cluster.
98+
To control the size of the replication log, use [`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}}) to tune the local database instance in each cluster.
9999
```text
100100
rladmin tune db <db:id | name> repl_backlog <Backlog size in MB (or if ending with bytes, KB or GB, in the respective unit)>
101101
```

‎content/rs/databases/configure/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ aliases: [
1414
You can manage your Redis Enterprise Software databases with several different tools:
1515

1616
- Admin console (the web-based user interface)
17-
- Command-line tools ([rladmin]({{<relref "/rs/references/rladmin.md">}}), [redis-cli](https://redis.io/docs/manual/cli/), [crdb-cli]({{<relref "/rs/references/crdb-cli-reference.md">}}))
17+
- Command-line tools ([`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}}), [`redis-cli`](https://redis.io/docs/manual/cli/), [`crdb-cli`]({{<relref "/rs/references/cli-utilities/crdb-cli">}}))
1818
- [REST API]({{<relref "/rs/references/rest-api/_index.md">}})
1919

2020
## Database settings

‎content/rs/databases/recover-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The database recovery process includes:
4141
## Recovering the databases
4242

4343
After you prepare the cluster that hosts the database,
44-
you can run the recovery process from the [rladmin]({{< relref "/rs/references/rladmin.md" >}})
44+
you can run the recovery process from the [`rladmin`]({{<relref "/rs/references/cli-utilities/rladmin">}})
4545
command-line interface (CLI).
4646

4747
To recover the database:

‎content/rs/installing-upgrading/configuring/cluster-lba-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ An additional setting can be done to allow (on average) closer termination of cl
8888

8989
After the cluster settings are updated and the LBs are configured you can go to the RS admin console at https://load-balancer-virtual-ip:8443/ and [create a new database]({{<relref "/rs/databases/create-database.md">}}).
9090

91-
If you are creating an Active-Active database, you will need to use the`crdb-cli` utility. See the ['crdb-cli' reference]({{<relref "/rs/references/crdb-cli-reference.md">}}) for more information about creating Active-Active databases from the command line.
91+
If you are creating an Active-Active database, you will need to use the`crdb-cli` utility. See the [`crdb-cli` reference]({{<relref "/rs/references/cli-utilities/crdb-cli">}}) for more information about creating Active-Active databases from the command line.
9292

9393
### Keep LB configuration updated when the cluster configuration changes
9494

‎content/rs/installing-upgrading/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Before upgrading a cluster:
8282

8383
- Identify the cluster master node and upgrade that node first.
8484

85-
Use the [`rladmin status nodes`]({{< relref "/rs/references/rladmin.md#status" >}}) command to identify the master node.
85+
Use the [`rladmin status nodes`]({{<relref "/rs/references/cli-utilities/rladmin/status#status-nodes">}}) command to identify the master node.
8686

8787
## Cluster upgrade process
8888

‎content/rs/references/cli-utilities/_index.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
Title: Command-line utilities
3+
linkTitle: Command-line utilities
4+
description: Documents the command-line utilities included with Redis Enterprise Software.
5+
weight: $weight
6+
alwaysopen: false
7+
categories: ["RS"]
8+
aliases:
9+
---
10+
11+
Redis Enterprise Software includes a set of utilities to help you manage and test your cluster. To use a utility, run it from the command line.
12+
13+
## Public utilities
14+
15+
Administrators can use these CLI tools to manage and test a Redis Enterprise cluster. You can find the binaries in the `/opt/redislabs/bin/` directory.
16+
17+
{{<table-children columnNames="Utility,Description" columnSources="LinkTitle,Description" enableLinks="LinkTitle">}}
18+
19+
## Internal utilities
20+
21+
The `/opt/redislabs/bin/` directory also contains utilities used internally by Redis Enterprise Software and for troubleshooting.
22+
23+
{{<warning>}}
24+
Do not use these tools for normal operations.
25+
{{</warning>}}
26+
27+
| Utility | Description |
28+
|---------|-------------|
29+
| bdb-cli | `redis-cli` connected to a database. |
30+
| ccs-cli | Inspect Cluster Configuration Store. |
31+
| cnm-ctl | Manages services for provisioning, migration, monitoring, <br />resharding, rebalancing, deprovisioning, and autoscaling. |
32+
| consistency_checker | Checks the consistency of Redis instances. |
33+
| crdbtop | Monitor Active-Active databases. |
34+
| debug_mode | Enables debug mode. |
35+
| debuginfo | Collects cluster information. |
36+
| dmc-cli | Configure and monitor the DMC proxy. |
37+
| pdns_control | Sends commands to a running PowerDNS nameserver. |
38+
| redis_ctl | Stops or starts Redis instances. |
39+
| rl_rdbloader | Load RDB backup files to a server. |
40+
| rlutil | Maintenance utility. |
41+
| shard-cli | `redis-cli` connected to a shard. |
42+
| supervisorctl | Manages the lifecycles of Redis Enterprise services. |

‎content/rs/references/crdb-cli-reference.md renamed to ‎content/rs/references/cli-utilities/crdb-cli/_index.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,44 @@
11
---
2-
Title: CRDB-CLI commands
3-
description:
2+
Title: crdb-cli
3+
linkTitle: crdb-cli (manage Active-Active)
4+
description: Manage Active-Active databases.
45
weight: $weight
56
alwaysopen: false
67
categories: ["RS"]
8+
aliases: ["/rs/references/crdb-cli-reference/"]
79
---
8-
An [Active-Active database]({{< relref "/rs/databases/active-active/_index.md" >}}) (also known as CRDB or Conflict-free, Replicated DataBase)
9-
replicates your dataset across Redis Enterprise Software (RS) clusters located in geographically distributed regions.
10-
Active-Active databases allow read-write access in all locations, making them ideal for distributed applications that require the fastest response times, and also for disaster recovery.
10+
11+
An [Active-Active database]({{<relref "/rs/databases/active-active/_index.md">}}) (also known as CRDB or Conflict-free, Replicated DataBase)
12+
replicates your dataset across Redis Enterprise Software clusters located in geographically distributed regions.
13+
Active-Active databases allow read-write access in all locations, making them ideal for distributed applications that require fast response times and disaster recovery.
1114

1215
The Active-Active database on an individual cluster is called an **instance**.
1316
Each cluster that hosts an instance is called a **participating cluster**.
1417

1518
An Active-Active database requires two or more participating clusters.
16-
Each instance is responsible for updating the instances residing on other participating clusters with the transactions it receives.
19+
Each instance is responsible for updating the instances that reside on other participating clusters with the transactions it receives.
1720
Write conflicts are resolved using [CRDTs]({{< relref "/rs/databases/active-active/_index.md" >}}).
1821

19-
To programmatically maintain an Active-Active database and its instances, you can use the CRDB-CLI command-line tool.
22+
To programmatically maintain an Active-Active database and its instances, you can use the `crdb-cli` command-line tool.
2023

2124
## Use the crdb-cli
2225

23-
To use the CRDB-CLI tool, use SSH to log in to an RS host with a user that belongs to the group that RS was installed with (Default: **redislabs**).
24-
If you log in with a non-root user, you must add `/opt/redislabs/bin/` to your PATH environment variables.
26+
To use the `crdb-cli` tool, use SSH to sign in to a Redis Enterprise host with a user that belongs to the group that Redis Enterprise Software was installed with (Default: **redislabs**).
27+
If you sign in with a non-root user, you must add `/opt/redislabs/bin/` to your `PATH` environment variables.
2528

26-
CRDB-CLI commands use the syntax: `crdb-cli <command> <arguments>` to let you:
29+
`crdb-cli` commands use the syntax: `crdb-cli <command> <arguments>` to let you:
2730

2831
- Create, list, update, flush, or delete an Active-Active database
2932
- Add or remove an instance of the Active-Active database on a specific cluster
3033

3134
Each command creates a task.
32-
By default, the command runs immediately and you see the result of the command in the command output.
35+
By default, the command runs immediately and displays the result in the output.
3336
If you use the `--no-wait` flag, the command runs in the background so that your application is not delayed by the response.
3437
You can track the task with [`crdb-cli task status`](#active-active-task-status).
3538

36-
For each CRDB-CLI command, you can use `--help` for additional information about the command.
39+
For each `crdb-cli` command, you can use `--help` for additional information about the command.
40+
41+
<!-- The section below this line will eventually move to other pages as part of the ongoing reorg. -->
3742

3843
## Active-Active database operations
3944

0 commit comments

Comments
 (0)