Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion content/develop/clients/sch.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ curl -k -X PUT -H "accept: application/json" \
```

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

SCH is enabled automatically on the client side during connection
Expand Down
31 changes: 31 additions & 0 deletions content/operate/rs/clusters/configure/sch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
Title: Smart client handoffs
alwaysopen: false
categories:
- docs
- operate
- rs
description: Enable Smart client handoffs for your Redis Enterprise Software cluster.
linkTitle: Smart client handoffs
weight: 90
---

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.
See [Smart client handoffs]({{< relref "/develop/clients/sch" >}}) for more information about SCH.

{{< note >}}SCH is supported only for [rolling upgrades]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster#rolling-upgrade" >}}).
{{< /note >}}

To enable SCH on a Redis Enterprise server, you must use the
[/v1/cluster]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}})
REST API request to set the `client_maint_notifications` option to `true`.
The example below shows how to do this using the
[`curl`](https://curl.se/) command line utility:

```bash
curl -k -X PUT -H "accept: application/json" \
-H "content-type: application/json" \
-u "<username>:<password>" \
-d '{ "client_maint_notifications": true }' \
https://<host>:<port>/v1/cluster
```
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ An API object that represents the cluster.
| <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">}}). |
| bigstore_driver | "speedb"<br />"rocksdb" | Storage engine for [Redis Flex or Auto Tiering]({{<relref "/operate/rs/databases/flash">}}) |
| <span class="break-all">cluster_ssh_public_key</span> | string | Cluster's autogenerated SSH public key |
| client_maint_notifications | boolean (default: false) | Toggles sending client maintenance notifications about shard movements |
| cm_port | integer, (range: 1024-65535) | UI HTTPS listening port |
| <span class="break-all">cm_session_timeout_minutes</span> | integer (default: 15) | The timeout (in minutes) for the session to the CM |
| <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) |
Expand Down