diff --git a/content/develop/clients/sch.md b/content/develop/clients/sch.md index 6d58a69233..b8051d096c 100644 --- a/content/develop/clients/sch.md +++ b/content/develop/clients/sch.md @@ -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 diff --git a/content/operate/rs/clusters/configure/sch.md b/content/operate/rs/clusters/configure/sch.md new file mode 100644 index 0000000000..916e2d562e --- /dev/null +++ b/content/operate/rs/clusters/configure/sch.md @@ -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 ":" \ + -d '{ "client_maint_notifications": true }' \ + https://:/v1/cluster +``` diff --git a/content/operate/rs/references/rest-api/objects/cluster/_index.md b/content/operate/rs/references/rest-api/objects/cluster/_index.md index 608f6331f5..b5a160c074 100644 --- a/content/operate/rs/references/rest-api/objects/cluster/_index.md +++ b/content/operate/rs/references/rest-api/objects/cluster/_index.md @@ -19,6 +19,7 @@ An API object that represents the cluster. | availability_lag_tolerance_ms | integer (default: 100) | The maximum replication lag in milliseconds tolerated between source and replicas during [lag-aware database availability checks]({{}}). | | bigstore_driver | "speedb"
"rocksdb" | Storage engine for [Redis Flex or Auto Tiering]({{}}) | | cluster_ssh_public_key | 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 | | cm_session_timeout_minutes | integer (default: 15) | The timeout (in minutes) for the session to the CM | | cnm_http_max_threads_per_worker | integer (default: 10) | Maximum number of threads per worker in the `cnm_http` service (deprecated) |