Skip to content

DOC-7104: Migrate content/operate/rs/7.4/references/ (incl. rest-api) to render hooks #4094

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

Merged
andy-stark-redis merged 4 commits into from
Sep 24, 2026
Merged

DOC-7104: Migrate content/operate/rs/7.4/references/ (incl. rest-api) to render hooks #4094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb62edd
DOC-7104: Migrate content/operate/rs/7.4/references/ (incl. rest-api)…
andy-stark-redis Sep 23, 2026
e46f70e
DOC-7104: Fix and convert the missing-paren relref in redis-cli/_inde…
andy-stark-redis Sep 23, 2026
8e929b1
DOC-7104: Canonical /commands links, real filenames in relative refs …
andy-stark-redis Sep 24, 2026
aaf1b78
DOC-7104: Fix bare /commands links in redis-cli/_index.md (review)
andy-stark-redis Sep 24, 2026
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
5 changes: 2 additions & 3 deletions content/operate/rs/7.4/references/cli-utilities/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@ Administrators can use these CLI tools to manage and test a Redis Enterprise clu

The `/opt/redislabs/bin/` directory also contains utilities used internally by Redis Enterprise Software and for troubleshooting.

{{<warning>}}
Do not use these tools for normal operations.
{{</warning>}}
> [!WARNING]
> Do not use these tools for normal operations.

| Utility | Description |
|---------|-------------|
Expand Down
6 changes: 3 additions & 3 deletions content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ weight: $weight
url: '/operate/rs/7.4/references/cli-utilities/crdb-cli/'
---

An [Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}) (also known as CRDB or conflict-free replicated database)
An [Active-Active database](/content/operate/rs/7.4/databases/active-active/_index.md) (also known as CRDB or conflict-free replicated database)
replicates your data across Redis Enterprise Software clusters located in geographically distributed regions.
Active-Active databases allow read-write access in all locations, making them ideal for distributed applications that require fast response times and disaster recovery.

Expand All @@ -21,7 +21,7 @@ Each cluster that hosts an instance is called a **participating cluster**.

An Active-Active database requires two or more participating clusters.
Each instance is responsible for updating the instances that reside on other participating clusters with the transactions it receives.
Write conflicts are resolved using [conflict-free replicated data types]({{< relref "/operate/rs/7.4/databases/active-active" >}}) (CRDTs).
Write conflicts are resolved using [conflict-free replicated data types](/content/operate/rs/7.4/databases/active-active/_index.md) (CRDTs).

To programmatically maintain an Active-Active database and its instances, you can use the `crdb-cli` command-line tool.

Expand All @@ -45,6 +45,6 @@ By default, the command runs immediately and displays the result in the output.

If you use the <nobr>`--no-wait`</nobr> flag, the command runs in the background so that your application is not delayed by the response.

Use the [`crdb-cli task` commands]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/task/" >}}) to manage Active-Active database tasks.
Use the [`crdb-cli task` commands](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/_index.md) to manage Active-Active database tasks.

For each `crdb-cli` command, you can use <nobr>`--help`</nobr> for additional information about the command.
14 changes: 7 additions & 7 deletions content/operate/rs/7.4/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 @@ -44,7 +44,7 @@ crdb-cli crdb create --name <name>
Before you create an Active-Active database, you must have:

- At least two participating clusters
- [Network connectivity]({{< relref "/operate/rs/7.4/networking/port-configurations" >}}) between the participating clusters
- [Network connectivity](/content/operate/rs/7.4/networking/port-configurations.md) between the participating clusters

### Parameters

Expand All @@ -60,18 +60,18 @@ Before you create an Active-Active database, you must have:
| 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) |
| causal-consistency | true <br/> false (*default*) | [Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received |
| causal-consistency | true <br/> false (*default*) | [Causal consistency](/content/operate/rs/7.4/databases/active-active/causal-consistency.md) applies updates to all instances in the order they were received |
| password \<password\> | string | Password for access to the database |
| replication | true <br/> false (*default*) | Activates or deactivates [database replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) where every master shard replicates to a replica shard |
| replication | true <br/> false (*default*) | Activates or deactivates [database replication](/content/operate/rs/7.4/databases/durability-ha/replication.md) where every master shard replicates to a replica shard |
| encryption | true <br/> false (*default*) | Activates or deactivates encryption |
| sharding | true (*default*)<br/> false | Activates or deactivates sharding (also known as [database clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}})). Cannot be updated after the database is created |
| sharding | true (*default*)<br/> false | Activates or deactivates sharding (also known as [database clustering](/content/operate/rs/7.4/databases/durability-ha/clustering.md)). Cannot be updated after the database is created |
| shards-count \<number_of_shards\> | integer | If sharding is enabled, this specifies the number of Redis shards for each database instance |
| oss-cluster | true<br/>false (*default*) | Activates [OSS cluster API]({{< relref "/operate/rs/7.4/clusters/optimize/oss-cluster-api" >}}) |
| shard-key-regex \<regex_rule\> | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#custom-hashing-policy" >}})) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?<tag>.*)\\}.*'}, {u'regex': u'(?<tag>.*)'} `) |
| oss-cluster | true<br/>false (*default*) | Activates [OSS cluster API](/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md) |
| shard-key-regex \<regex_rule\> | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy](/content/operate/rs/7.4/databases/durability-ha/clustering.md#custom-hashing-policy)) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?<tag>.*)\\}.*'}, {u'regex': u'(?<tag>.*)'} `) |
| bigstore | true <br/> <br/> false (*default*) | If true, the database uses Auto Tiering to add flash memory to the database |
| bigstore-ram-size \<size\> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for databases with Auto Tiering enabled |
| with-module<br/>&nbsp;&nbsp;name=\<module_name\>,<br/>&nbsp;&nbsp;version=\<module_version\>,<br/>&nbsp;&nbsp;args=\<module_args\> | strings | Creates a database with a specific module |
| eviction-policy | noeviction (*default*)<br/>allkeys-lru<br/>allkeys-lfu<br/>allkeys-random<br/>volatile-lru<br/>volatile-lfu<br/>volatile-random<br/>volatile-ttl | Sets [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}) |
| eviction-policy | noeviction (*default*)<br/>allkeys-lru<br/>allkeys-lfu<br/>allkeys-random<br/>volatile-lru<br/>volatile-lfu<br/>volatile-random<br/>volatile-ttl | Sets [eviction policy](/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md) |
| proxy-policy | all-nodes<br>all-master-shards<br>single | Sets proxy policy |


Expand Down
2 changes: 1 addition & 1 deletion content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ crdb-cli crdb purge-instance --crdb-guid <guid>
[ --no-wait ]
```

Once this command finishes, the other replicas must remove this instance with [`crdb-cli crdb remove-instance --force`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance" >}}).
Once this command finishes, the other replicas must remove this instance with [`crdb-cli crdb remove-instance --force`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md).

### Parameters

Expand Down
4 changes: 2 additions & 2 deletions content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ If the cluster cannot communicate with the instance that you want to remove, you

1. Use the `--force` option to remove the instance from the Active-Active database without purging the data from the instance.

1. Run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance to delete the Active-Active database and its data.
1. Run [`crdb-cli crdb purge-instance`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md) from the removed instance to delete the Active-Active database and its data.

### Parameters

| Parameter | Value | Description|
|------------------------------|--------|------------|
| crdb-guid | string | The GUID of the database (required) |
| instance-id | string | The ID of the local instance to remove (required) |
| force | | Removes the instance without purging data from the instance. <br>If --force is specified, you must run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance. |
| force | | Removes the instance without purging data from the instance. <br>If --force is specified, you must run [`crdb-cli crdb purge-instance`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md) from the removed instance. |
| no-wait | | Does not wait for the task to complete |

### Returns
Expand Down
6 changes: 3 additions & 3 deletions content/operate/rs/7.4/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 @@ -31,7 +31,7 @@ crdb-cli crdb update --crdb-guid <guid>
[--update-module name=<name>,featureset_version=<version>]
```

If you want to change the configuration of the local instance only, use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) instead.
If you want to change the configuration of the local instance only, use [`rladmin`](/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md) instead.

### Parameters

Expand All @@ -40,7 +40,7 @@ If you want to change the configuration of the local instance only, use [`rladmi
| crdb-guid \<guid\> | string | GUID of the Active-Active database (required) |
| bigstore-ram-size \<maximum_memory\> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for the databases with Auto Tiering enabled, if activated |
| memory-size \<maximum_memory\> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required) |
| causal-consistency | true <br/>false | [Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received |
| causal-consistency | true <br/>false | [Causal consistency](/content/operate/rs/7.4/databases/active-active/causal-consistency.md) applies updates to all instances in the order they were received |
| 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 |
Expand All @@ -49,7 +49,7 @@ If you want to change the configuration of the local instance only, use [`rladmi
| force | | Force an update even if there are no changes |
| no-wait | | Do not wait for the command to finish |
| oss-cluster | true <br/>false | Activates or deactivates OSS Cluster mode |
| eviction-policy | noeviction<br/>allkeys-lru<br/>allkeys-lfu<br/>allkeys-random<br/>volatile-lru<br/>volatile-lfu<br/>volatile-random<br/>volatile-ttl | Updates [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}) |
| eviction-policy | noeviction<br/>allkeys-lru<br/>allkeys-lfu<br/>allkeys-random<br/>volatile-lru<br/>volatile-lfu<br/>volatile-random<br/>volatile-ttl | Updates [eviction policy](/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md) |
| featureset-version | true<br/>false | Updates to latest FeatureSet version |
| update-module name=\<name>,featureset_version=\<version\> | strings | Update a module to the specified version |

Expand Down
2 changes: 1 addition & 1 deletion content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ crdb-cli task status --task-id <task_id>

The `--verbose` and `--no-verbose` options are mutually incompatible; specify one or the other.

The `404 Not Found` error indicates an invalid task ID. Use the [`task list`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/task/list" >}}) command to determine available task IDs.
The `404 Not Found` error indicates an invalid task ID. Use the [`task list`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/list.md) command to determine available task IDs.

### Returns

Expand Down
Loading
Loading