From cb03dfeb1d928575a555fe1e358b023cb78f598e Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Fri, 5 Dec 2025 09:57:15 +0000 Subject: [PATCH 1/4] DOC-6047 SCH config page for RS --- content/operate/rs/clusters/configure/sch.md | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 content/operate/rs/clusters/configure/sch.md diff --git a/content/operate/rs/clusters/configure/sch.md b/content/operate/rs/clusters/configure/sch.md new file mode 100644 index 0000000000..de0c8e467a --- /dev/null +++ b/content/operate/rs/clusters/configure/sch.md @@ -0,0 +1,28 @@ +--- +Title: Smart client handoffs +alwaysopen: false +categories: +- docs +- operate +- rs +description: Enable Smart client handoffs 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. + +To enable SCH on a Redis Enterprise server, you must use the +[v1/cluster]({{< relref "/operate/rs/references/rest-api/requests/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 "test@redis.com:test123" \ + -d '{ "client_maint_notifications": true }' \ + https://localhost:9443/v1/cluster +``` From 9ad459fed81d8f1a26c49e97da6006e6c96023bc Mon Sep 17 00:00:00 2001 From: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> Date: Fri, 5 Dec 2025 14:41:59 +0000 Subject: [PATCH 2/4] Update content/operate/rs/clusters/configure/sch.md Co-authored-by: David Dougherty --- content/operate/rs/clusters/configure/sch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/rs/clusters/configure/sch.md b/content/operate/rs/clusters/configure/sch.md index de0c8e467a..e9c14ac3c2 100644 --- a/content/operate/rs/clusters/configure/sch.md +++ b/content/operate/rs/clusters/configure/sch.md @@ -5,7 +5,7 @@ categories: - docs - operate - rs -description: Enable Smart client handoffs your Redis Enterprise Software cluster. +description: Enable Smart client handoffs for your Redis Enterprise Software cluster. linkTitle: Smart client handoffs weight: 90 --- From 62ca3f7d7aa621182e77ce134b19c0223d049f00 Mon Sep 17 00:00:00 2001 From: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> Date: Fri, 5 Dec 2025 16:49:55 +0000 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com> --- content/operate/rs/clusters/configure/sch.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/operate/rs/clusters/configure/sch.md b/content/operate/rs/clusters/configure/sch.md index e9c14ac3c2..8c77547e29 100644 --- a/content/operate/rs/clusters/configure/sch.md +++ b/content/operate/rs/clusters/configure/sch.md @@ -14,7 +14,7 @@ Smart client handoffs (SCH) is a feature of Redis Cloud and Redis Enterprise ser See [Smart client handoffs]({{< relref "/develop/clients/sch" >}}) for more information about SCH. To enable SCH on a Redis Enterprise server, you must use the -[v1/cluster]({{< relref "/operate/rs/references/rest-api/requests/cluster" >}}) +[/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: @@ -22,7 +22,7 @@ The example below shows how to do this using the ```bash curl -k -X PUT -H "accept: application/json" \ -H "content-type: application/json" \ - -u "test@redis.com:test123" \ + -u ":" \ -d '{ "client_maint_notifications": true }' \ - https://localhost:9443/v1/cluster + https://:/v1/cluster ``` From 087ea214fdd88e9a1bd269a2436e9ef0dfcbf7e8 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Mon, 8 Dec 2025 09:42:15 +0000 Subject: [PATCH 4/4] DOC-6047 applied feedback --- content/develop/clients/sch.md | 4 +++- content/operate/rs/clusters/configure/sch.md | 3 +++ .../operate/rs/references/rest-api/objects/cluster/_index.md | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) 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 index 8c77547e29..916e2d562e 100644 --- a/content/operate/rs/clusters/configure/sch.md +++ b/content/operate/rs/clusters/configure/sch.md @@ -13,6 +13,9 @@ 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`. 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) |