Skip to content

DOC-7103 Document SNI hostname precedence for StackExchange.Redis TLS/cluster connections - #4082

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7103-stackexchange-redis-sni-tls
Sep 23, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7103-stackexchange-redis-sni-tls

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds an "SNI hostname selection for cluster connections" subsection to the .NET client's TLS docs, covering the SslHost / DnsEndPoint / default-provider / endpoint-address precedence introduced in StackExchange.Redis#3250.
  • Confirmed this is shipped, not speculative: the PR's merge commit is the 3.3.1 tag commit (verified via gh api .../compare/3.3.1...<merge_sha> returning identical), so the version gate is pinned to exactly v3.3.1.
  • Surfaced by the 2026-09-23 /pr-scan-review; ticket DOC-7103.

Test plan

  • Build the site locally and confirm the new subsection renders under "Connect to your production Redis with TLS" in content/develop/clients/dotnet/connect.md
  • Spot-check the callout note and numbered precedence list render correctly

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change to the .NET client connect guide with no runtime or security behavior changes.

Overview
Adds documentation under the .NET Connect to your production Redis with TLS section explaining how StackExchange.Redis picks the TLS SNI hostname when cluster nodes are discovered via CLUSTER SLOTS, so load balancers/proxies can route handshakes correctly.

The new subsection documents a v3.3.1+ precedence order (SslHostDnsEndPoint host → default SNI provider → endpoint address) and clarifies that ConfigurationOptions.SslHost is only surfaced when set explicitly, not when inferred by the client.

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

…/cluster connections

Adds an "SNI hostname selection for cluster connections" subsection to
connect.md's TLS section, covering the SslHost/DnsEndPoint/default-provider/
endpoint-address precedence StackExchange.#3250 introduced.

Verified this is real, shipped behavior rather than an in-flight PR: `gh api
repos/StackExchange/StackExchange.Redis/compare/3.3.1...<merge_commit_sha>`
returned "identical", meaning the merge commit for #3250 *is* the 3.3.1 tag
commit, not just an ancestor of it. That's a stronger and cheap-to-run check
than eyeballing "merged" + a changelog mention, and it's why the version gate
here is pinned to exactly v3.3.1, not "3.3.x" or "check the changelog."

Left the fallback provider unnamed ("the default SNI provider") rather than
citing the internal `GetSslHostFromEndpoints` method the upstream PR
description uses — couldn't confirm it's stable public API rather than an
implementation detail, and AGENTS.md's prose/code-form split only calls for
literal identifiers where the reader actually types them.

Learned: gh compare(tag...merge_sha) == identical is a reliable released-vs-merged check, cheaper than changelog reading
Rejected: naming GetSslHostFromEndpoints in prose | not confirmed as stable public API, only appears in the upstream PR description
Constraint: version gate must stay exactly v3.3.1 (the tag the merge commit resolves to), not loosened to "3.3.x"
Recheck: if StackExchange.Redis changes SslHost/SNI resolution again, re-verify this precedence order and version gate against the new release
Ticket: DOC-7103
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

DOC-7103

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

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

Memory updated at b9883b0

@andy-stark-redis andy-stark-redis self-assigned this Sep 23, 2026
@andy-stark-redis
andy-stark-redis requested a review from a team September 23, 2026 10:03
@andy-stark-redis andy-stark-redis added the clients Client library docs label Sep 23, 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 !

@andy-stark-redis
andy-stark-redis merged commit 7af7ba8 into main Sep 23, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7103-stackexchange-redis-sni-tls branch September 23, 2026 13:38
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