Skip to content

DOC-7188 Add a Redis Cloud SCH support table for PrivateLink and PSC - #4493

Open
andy-stark-redis wants to merge 2 commits into
mainfrom
DOC-7188-sch-privatelink-table
Open

andy-stark-redis wants to merge 2 commits into
mainfrom
DOC-7188-sch-privatelink-table

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Implements DOC-7188.

What changed

  • Smart client handoffs: the Redis Cloud section now has a table of connection method against routing mode instead of the PrivateLink/PSC exclusion prose.
  • The SCH notes in the redis-py, node-redis, Lettuce and go-redis connect pages now apply only to PSC and to PrivateLink with the OSS Cluster API. They no longer tell PrivateLink standard-routing users to set the endpoint type to none, which would switch off pre-handoffs.
Connection method Standard routing OSS Cluster API
AWS PrivateLink Relaxed timeouts and pre-handoffs Relaxed timeouts only
Google Cloud Private Service Connect Relaxed timeouts only Not available
All other connection methods Relaxed timeouts and pre-handoffs Relaxed timeouts and pre-handoffs

What is confirmed and what isn't

Mirko Ortensi's Slack message (2026-10-15) confirms only that the PrivateLink limitation is dropped for standard routing. Every other cell keeps its old limitation, so please correct anything wrong.

Questions for engineers

  1. Is the endpoint type none setting still needed for PSC and for PrivateLink with the OSS Cluster API?
  2. Is "relaxed timeouts only" accurate for PrivateLink with the OSS Cluster API, or should users avoid SCH there?
  3. Is the PrivateLink standard-routing change live on Redis Cloud? If so, I'll add a release note. None is included here.
  4. Can the last row name VPC peering and Transit Gateway, or should it stay "all other connection methods"?

Not done

The Hugo build was not run.

🤖 Generated with Claude Code


Note

Low Risk
Docs-only updates; risk is inaccurate guidance if the PrivateLink standard-routing SCH behavior or table cells don’t match the product.

Overview
Redis Cloud SCH is documented with a connection method × routing mode table in sch.md (PrivateLink, PSC, and everything else; standard routing vs OSS Cluster API), replacing the old blanket PrivateLink/PSC prose and clarifying where pre-handoffs apply.

Client connect pages (go-redis, Lettuce, node-redis, redis-py) narrow the “relaxed timeouts only” SCH note to Google Cloud Private Service Connect and to OSS Cluster API with AWS PrivateLink, and stop telling all PrivateLink users to force EndpointType/maintEndpointType/none—so it matches full SCH on PrivateLink with standard routing.

Lettuce geographic failover is treated as generally available: the preview banner is removed from lettuce/failover.md, and the supported clients table lists Lettuce basic failover as Yes (no Preview).

Reviewed by Cursor Bugbot for commit d6ce40a. Bugbot is set up for automated code reviews on this repo. Configure here.

Replace the PrivateLink/PSC exclusion prose on the SCH page with a table of
connection method against routing mode, and narrow the matching NOTE in the
four client connect pages (redis-py, node-redis, Lettuce, go-redis).

Mirko Ortensi's Slack message (2026-10-15) is the only source: drop the
PrivateLink limitation on standard routing, keep it for the OSS Cluster API
("still some issues"), keep all of it for PSC. Nothing else is confirmed. The
four follow-up questions Andy posted in that thread were unanswered when this
was written, so every other cell keeps its old limitation (the safest reading)
and the PR is where engineers are expected to correct it. The "not available"
cell for PSC with the OSS Cluster API comes from the PSC limitation as
described, not from a source that says PSC lacks the Cluster API.

The client NOTEs told users to set the maintenance endpoint type to none for
PrivateLink. That advice would now switch off pre-handoffs for PrivateLink on
standard routing, so it is kept only for PSC and PrivateLink with the OSS
Cluster API. Lettuce has no OSS Cluster API support, so its note is unchanged
in substance.

Learned: PrivateLink standard routing is the only limitation Mirko lifted; every other cell is an unconfirmed carry-over
Directive: Do not name VPC peering or Transit Gateway in the "all other" row until an engineer confirms them
Gaps: Whether the endpoint type none advice is still needed for PSC and PrivateLink with the OSS Cluster API; whether the change is live (no Redis Cloud release note written); Hugo build not run
Recheck: when the PrivateLink OSS Cluster API issues are fixed or PSC gains pre-handoffs
Ticket: DOC-7188
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7188

@github-actions

github-actions Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 6 related items from repository history (1 new this commit):

Memory updated at d6ce40a

@andy-stark-redis
andy-stark-redis requested review from a team and mortensi November 6, 2026 10:23
@andy-stark-redis andy-stark-redis self-assigned this Nov 6, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Nov 6, 2026

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM.

@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

Thanks @dwdougherty !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants