Skip to content

Conversation

andy-stark-redis
Copy link
Contributor

Draft of docs for Seamless client experience (aka Hitless upgrades). I believe all the clients that will initially support this are in beta versions or still in development, so things are likely to change before release.

All feedback is welcome, but a few particular things to think about are:

  • "SCE" seems a good abbreviation to use, but I've not officially seen it anywhere.
  • The client APIs provide options to set the endpoint type, but I'm not clear about whether this is useful to add to the main docs (ie, do most users have any need to do it?) If it's important, then I'll add it in, of course.
  • I've mentioned that Redis Cloud enables SCE by default, but the only method I've seen to enable it in RS is via a REST API call. If we want to publish these docs for the beta versions of SCE then maybe we should give the details of the REST API call. However, I'm guessing there will be a command or config option to enable this for the final release.
  • Do we need docs for the CLIENT MAINT_NOTIFICATIONS command?

Copy link
Contributor

github-actions bot commented Sep 10, 2025

DOC-5712

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM. Answers:

  • "SCE" seems a good abbreviation to use, but I've not officially seen it anywhere. [DWD] works for me.
  • Do we need docs for the CLIENT MAINT_NOTIFICATIONS command? [DWD] no such command AFAIK.

@andy-stark-redis
Copy link
Contributor Author

@dwdougherty Thanks for the review! I'm not sure if the command is actually useful from the CLI, so we might not end up documenting it.

.
```

{{< note >}}SCE requires the [RESP3]({{< relref "/develop/reference/protocol-spec#resp-versions" >}})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to frame it like this since Lettuce tries to use RESP3 by default and falls back to RESP2 if it's not available. Maybe a link to the RS/Cloud docs here on SCE requirements is a better choice.

SCE is enabled by default on Redis Cloud, but you must enable it
explicitly on Redis Enterprise servers.

You must also configure SCE on the client side during connection.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We decided to enable it by default on the client side in RESP3 mode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients Client library docs do not merge yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants