From c1a305e24ac21904709cf66b71efb3473b90579b Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 19 Sep 2025 12:40:06 -0500 Subject: [PATCH] DOC-3301 RS: Auto-recovery rladmin doc updates --- content/operate/rs/7.8/databases/recover.md | 18 +++++++++++++++++- .../references/cli-utilities/rladmin/tune.md | 4 ++++ content/operate/rs/databases/recover.md | 18 +++++++++++++++++- .../references/cli-utilities/rladmin/tune.md | 4 ++++ 4 files changed, 42 insertions(+), 2 deletions(-) diff --git a/content/operate/rs/7.8/databases/recover.md b/content/operate/rs/7.8/databases/recover.md index 446ef63db0..d2eb6ebe2d 100644 --- a/content/operate/rs/7.8/databases/recover.md +++ b/content/operate/rs/7.8/databases/recover.md @@ -193,7 +193,21 @@ After the databases are recovered, make sure your Redis clients can successfully If you enable the automatic recovery cluster policy, Redis Enterprise tries to quickly recover as much data as possible from before the disaster. -To enable automatic recovery, [update the cluster policy]({{< relref "/operate/rs/7.8/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) using the REST API: +To enable automatic recovery, use one of the following methods: + +{{< multitabs id="enable-auto-recovery" +tab1="rladmin" +tab2="REST API" >}} + +To enable automatic recovery using `rladmin`, run the [`rladmin tune cluster`]({{}}) command: + +```sh +rladmin tune cluster auto_recovery enabled +``` + +-tab-sep- + +To enable automatic recovery using the REST API, use an [update cluster policy]({{< relref "/operate/rs/7.8/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) request: ```sh PUT /v1/cluster/policy @@ -202,6 +216,8 @@ PUT /v1/cluster/policy } ``` +{{< /multitabs >}} + Redis Enterprise tries to recover databases from the best existing persistence files. If a persistence file isn't available, which can happen if its host node is down, the automatic recovery process waits for it to become available. For each database, you can set the `recovery_wait_time` to define how many seconds the database waits for a persistence file to become available before recovery. After the wait time elapses, the recovery process continues, which can result in partial or full data loss. The default value is `-1`, which means to wait forever. Short wait times can increase the risk of potential data loss. diff --git a/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md b/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md index 2aa100fe71..747aa003f9 100644 --- a/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md @@ -49,6 +49,8 @@ rladmin tune cluster [ acl_pubsub_default { resetchannels | allchannels } ] [ resp3_default { enabled | disabled } ] [ automatic_node_offload { enabled | disabled } ] + [ auto_recovery { enabled | disabled } ] + [ default_recovery_wait_time ] [ default_tracking_table_max_keys_policy ] [ default_oss_sharding { enabled | disabled } ] ] @@ -60,9 +62,11 @@ rladmin tune cluster |----------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------| | acl_pubsub_default | `resetchannels`
`allchannels` | Default pub/sub ACL rule for all databases in the cluster:
•`resetchannels` blocks access to all channels (restrictive)
•`allchannels` allows access to all channels (permissive) | | automatic_node_offload | `enabled`
`disabled` | Define whether automatic node offload migration will take place | +| auto_recovery | `enabled`
`disabled` | Defines whether to use automatic recovery after shard failure | | data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/7.8/security/encryption/internode-encryption" >}}) for new databases | | db_conns_auditing | `enabled`
`disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/7.8/security/audit-events" >}}) by default for new databases of a cluster | | default_concurrent_restore_actions | integer
`all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") | +| default_recovery_wait_time | integer | The default time for new databases to wait for the persistence file to be available during automatic recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. | | default_non_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/7.8/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints | | default_oss_sharding | `enabled`
`disabled` | Default hashing policy to use for new databases. Set to `disabled` by default. This field is for future use only and should not be changed. | | default_redis_version | version number | The default Redis database compatibility version used to create new databases.

The value parameter should be a version number in the form of "x.y" where _x_ represents the major version number and _y_ represents the minor version number. The final value corresponds to the desired version of Redis.

You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. | diff --git a/content/operate/rs/databases/recover.md b/content/operate/rs/databases/recover.md index a256d1e051..83e223fb87 100644 --- a/content/operate/rs/databases/recover.md +++ b/content/operate/rs/databases/recover.md @@ -192,7 +192,21 @@ After the databases are recovered, make sure your Redis clients can successfully If you enable the automatic recovery cluster policy, Redis Enterprise tries to quickly recover as much data as possible from before the disaster. -To enable automatic recovery, [update the cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) using the REST API: +To enable automatic recovery, use one of the following methods: + +{{< multitabs id="enable-auto-recovery" +tab1="rladmin" +tab2="REST API" >}} + +To enable automatic recovery using `rladmin`, run the [`rladmin tune cluster`]({{}}) command: + +```sh +rladmin tune cluster auto_recovery enabled +``` + +-tab-sep- + +To enable automatic recovery using the REST API, use an [update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) request: ```sh PUT /v1/cluster/policy @@ -201,6 +215,8 @@ PUT /v1/cluster/policy } ``` +{{< /multitabs >}} + Redis Enterprise tries to recover databases from the best existing persistence files. If a persistence file isn't available, which can happen if its host node is down, the automatic recovery process waits for it to become available. For each database, you can set the `recovery_wait_time` to define how many seconds the database waits for a persistence file to become available before recovery. After the wait time elapses, the recovery process continues, which can result in partial or full data loss. The default value is `-1`, which means to wait forever. Short wait times can increase the risk of potential data loss. diff --git a/content/operate/rs/references/cli-utilities/rladmin/tune.md b/content/operate/rs/references/cli-utilities/rladmin/tune.md index e6a8fa04d0..1ef3a077c5 100644 --- a/content/operate/rs/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/references/cli-utilities/rladmin/tune.md @@ -48,6 +48,8 @@ rladmin tune cluster [ acl_pubsub_default { resetchannels | allchannels } ] [ resp3_default { enabled | disabled } ] [ automatic_node_offload { enabled | disabled } ] + [ auto_recovery { enabled | disabled } ] + [ default_recovery_wait_time ] [ default_tracking_table_max_keys_policy ] [ default_oss_sharding { enabled | disabled } ] ] @@ -59,11 +61,13 @@ rladmin tune cluster |----------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------| | acl_pubsub_default | `resetchannels`
`allchannels` | Default pub/sub ACL rule for all databases in the cluster:
•`resetchannels` blocks access to all channels (restrictive)
•`allchannels` allows access to all channels (permissive) | | automatic_node_offload | `enabled`
`disabled` | Define whether automatic node offload migration will take place | +| auto_recovery | `enabled`
`disabled` | Defines whether to use automatic recovery after shard failure | | data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) for new databases | | db_conns_auditing | `enabled`
`disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) by default for new databases of a cluster | | default_concurrent_restore_actions | integer
`all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") | | default_non_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints | | default_oss_sharding | `enabled`
`disabled` | Default hashing policy to use for new databases. Set to `disabled` by default. This field is for future use only and should not be changed. | +| default_recovery_wait_time | integer | The default time for new databases to wait for the persistence file to be available during automatic recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. | | default_redis_version | version number | The default Redis database compatibility version used to create new databases.

The value parameter should be a version number in the form of "x.y" where _x_ represents the major version number and _y_ represents the minor version number. The final value corresponds to the desired version of Redis.

You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. | | default_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) for newly created sharded databases' endpoints | | default_shards_placement | `dense`
`sparse` | New databases place shards according to the default [shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) |