Skip to content

Commit fe7b850

Browse files
Merge pull request #2516 from redis/DOC-6047-sch-stub-page-for-rs
DOC-6047 SCH config page for RS
2 parents a3c6f00 + 087ea21 commit fe7b850

File tree

3 files changed

+35
-1
lines changed
  • content

3 files changed

+35
-1
lines changed

content/develop/clients/sch.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ curl -k -X PUT -H "accept: application/json" \
6969
```
7070

7171
{{< note >}}SCH is not supported for
72-
[Kubernetes]({{< relref "/operate/kubernetes" >}}) clusters.
72+
[Kubernetes]({{< relref "/operate/kubernetes" >}}) clusters
73+
and is supported on Redis Enterprise only for
74+
[rolling upgrades]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster#rolling-upgrade" >}}).
7375
{{< /note >}}
7476

7577
SCH is enabled automatically on the client side during connection
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
Title: Smart client handoffs
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Enable Smart client handoffs for your Redis Enterprise Software cluster.
9+
linkTitle: Smart client handoffs
10+
weight: 90
11+
---
12+
13+
Smart client handoffs (SCH) is a feature of Redis Cloud and Redis Enterprise servers that lets them actively notify clients about planned server maintenance shortly before it happens. This lets a client reconnect or otherwise respond gracefully without significant interruptions in service.
14+
See [Smart client handoffs]({{< relref "/develop/clients/sch" >}}) for more information about SCH.
15+
16+
{{< note >}}SCH is supported only for [rolling upgrades]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster#rolling-upgrade" >}}).
17+
{{< /note >}}
18+
19+
To enable SCH on a Redis Enterprise server, you must use the
20+
[/v1/cluster]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}})
21+
REST API request to set the `client_maint_notifications` option to `true`.
22+
The example below shows how to do this using the
23+
[`curl`](https://curl.se/) command line utility:
24+
25+
```bash
26+
curl -k -X PUT -H "accept: application/json" \
27+
-H "content-type: application/json" \
28+
-u "<username>:<password>" \
29+
-d '{ "client_maint_notifications": true }' \
30+
https://<host>:<port>/v1/cluster
31+
```

content/operate/rs/references/rest-api/objects/cluster/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ An API object that represents the cluster.
1919
| <span class="break-all">availability_lag_tolerance_ms</span> | integer (default: 100) | The maximum replication lag in milliseconds tolerated between source and replicas during [lag-aware database availability checks]({{<relref "/operate/rs/monitoring/db-availability#lag-aware">}}). |
2020
| bigstore_driver | "speedb"<br />"rocksdb" | Storage engine for [Redis Flex or Auto Tiering]({{<relref "/operate/rs/databases/flash">}}) |
2121
| <span class="break-all">cluster_ssh_public_key</span> | string | Cluster's autogenerated SSH public key |
22+
| client_maint_notifications | boolean (default: false) | Toggles sending client maintenance notifications about shard movements |
2223
| cm_port | integer, (range: 1024-65535) | UI HTTPS listening port |
2324
| <span class="break-all">cm_session_timeout_minutes</span> | integer (default: 15) | The timeout (in minutes) for the session to the CM |
2425
| <span class="break-all">cnm_http_max_threads_per_worker</span> | integer (default: 10) | Maximum number of threads per worker in the `cnm_http` service (deprecated) |

0 commit comments

Comments
 (0)