Skip to content

Commit a61bd30

Browse files
authored
DOC-3301 RS: Auto-recovery rladmin doc updates (#2149)
1 parent 642386d commit a61bd30

File tree

4 files changed

+42
-2
lines changed

4 files changed

+42
-2
lines changed

content/operate/rs/7.8/databases/recover.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,21 @@ After the databases are recovered, make sure your Redis clients can successfully
193193

194194
If you enable the automatic recovery cluster policy, Redis Enterprise tries to quickly recover as much data as possible from before the disaster.
195195

196-
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:
196+
To enable automatic recovery, use one of the following methods:
197+
198+
{{< multitabs id="enable-auto-recovery"
199+
tab1="rladmin"
200+
tab2="REST API" >}}
201+
202+
To enable automatic recovery using `rladmin`, run the [`rladmin tune cluster`]({{<relref "/operate/rs/7.8/references/cli-utilities/rladmin/tune#tune-cluster">}}) command:
203+
204+
```sh
205+
rladmin tune cluster auto_recovery enabled
206+
```
207+
208+
-tab-sep-
209+
210+
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:
197211

198212
```sh
199213
PUT /v1/cluster/policy
@@ -202,6 +216,8 @@ PUT /v1/cluster/policy
202216
}
203217
```
204218

219+
{{< /multitabs >}}
220+
205221
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.
206222
207223
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.

content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ rladmin tune cluster
4949
[ acl_pubsub_default { resetchannels | allchannels } ]
5050
[ resp3_default { enabled | disabled } ]
5151
[ automatic_node_offload { enabled | disabled } ]
52+
[ auto_recovery { enabled | disabled } ]
53+
[ default_recovery_wait_time <value> ]
5254
[ default_tracking_table_max_keys_policy <value> ]
5355
[ default_oss_sharding { enabled | disabled } ]
5456
]
@@ -60,9 +62,11 @@ rladmin tune cluster
6062
|----------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------|
6163
| acl_pubsub_default | `resetchannels`<br /> `allchannels` | Default pub/sub ACL rule for all databases in the cluster:<br />`resetchannels` blocks access to all channels (restrictive)<br />`allchannels` allows access to all channels (permissive) |
6264
| automatic_node_offload | `enabled`<br />`disabled` | Define whether automatic node offload migration will take place |
65+
| auto_recovery | `enabled`<br />`disabled` | Defines whether to use automatic recovery after shard failure |
6366
| data_internode_encryption | `enabled`<br />`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/7.8/security/encryption/internode-encryption" >}}) for new databases |
6467
| db_conns_auditing | `enabled`<br /> `disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/7.8/security/audit-events" >}}) by default for new databases of a cluster |
6568
| default_concurrent_restore_actions | integer<br />`all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") |
69+
| 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. |
6670
| default_non_sharded_proxy_policy | `single`<br /><br />`all-master-shards`<br /><br />`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/7.8/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints |
6771
| default_oss_sharding | `enabled`<br />`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. |
6872
| default_redis_version | version number | The default Redis database compatibility version used to create new databases.<br/><br/> 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.<br/><br/>You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. |

content/operate/rs/databases/recover.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,21 @@ After the databases are recovered, make sure your Redis clients can successfully
192192

193193
If you enable the automatic recovery cluster policy, Redis Enterprise tries to quickly recover as much data as possible from before the disaster.
194194

195-
To enable automatic recovery, [update the cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) using the REST API:
195+
To enable automatic recovery, use one of the following methods:
196+
197+
{{< multitabs id="enable-auto-recovery"
198+
tab1="rladmin"
199+
tab2="REST API" >}}
200+
201+
To enable automatic recovery using `rladmin`, run the [`rladmin tune cluster`]({{<relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster">}}) command:
202+
203+
```sh
204+
rladmin tune cluster auto_recovery enabled
205+
```
206+
207+
-tab-sep-
208+
209+
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:
196210

197211
```sh
198212
PUT /v1/cluster/policy
@@ -201,6 +215,8 @@ PUT /v1/cluster/policy
201215
}
202216
```
203217

218+
{{< /multitabs >}}
219+
204220
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.
205221
206222
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.

content/operate/rs/references/cli-utilities/rladmin/tune.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ rladmin tune cluster
4848
[ acl_pubsub_default { resetchannels | allchannels } ]
4949
[ resp3_default { enabled | disabled } ]
5050
[ automatic_node_offload { enabled | disabled } ]
51+
[ auto_recovery { enabled | disabled } ]
52+
[ default_recovery_wait_time <value> ]
5153
[ default_tracking_table_max_keys_policy <value> ]
5254
[ default_oss_sharding { enabled | disabled } ]
5355
]
@@ -59,11 +61,13 @@ rladmin tune cluster
5961
|----------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------|
6062
| acl_pubsub_default | `resetchannels`<br /> `allchannels` | Default pub/sub ACL rule for all databases in the cluster:<br />`resetchannels` blocks access to all channels (restrictive)<br />`allchannels` allows access to all channels (permissive) |
6163
| automatic_node_offload | `enabled`<br />`disabled` | Define whether automatic node offload migration will take place |
64+
| auto_recovery | `enabled`<br />`disabled` | Defines whether to use automatic recovery after shard failure |
6265
| data_internode_encryption | `enabled`<br />`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) for new databases |
6366
| db_conns_auditing | `enabled`<br /> `disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) by default for new databases of a cluster |
6467
| default_concurrent_restore_actions | integer<br />`all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") |
6568
| default_non_sharded_proxy_policy | `single`<br /><br />`all-master-shards`<br /><br />`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints |
6669
| default_oss_sharding | `enabled`<br />`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. |
70+
| 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. |
6771
| default_redis_version | version number | The default Redis database compatibility version used to create new databases.<br/><br/> 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.<br/><br/>You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. |
6872
| default_sharded_proxy_policy | `single`<br /><br />`all-master-shards`<br /><br />`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) for newly created sharded databases' endpoints |
6973
| default_shards_placement | `dense`<br />`sparse` | New databases place shards according to the default [shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) |

0 commit comments

Comments
 (0)