Skip to content

docs: add a connectivity section to the 3.x manual - #1145

Closed
nikagra wants to merge 3 commits into
scylladb:scylla-3.11.5.xfrom
nikagra:connectivity-3115
Closed

nikagra wants to merge 3 commits into
scylladb:scylla-3.11.5.xfrom
nikagra:connectivity-3115

Conversation

@nikagra

@nikagra nikagra commented Sep 24, 2026 •

Copy link
Copy Markdown

Depends on: #1153 (stacked; review the last commit)
Blocks: nothing
If #1153 is squash-merged, rebase this onto the new base before merging.

This is the published-snapshot copy of #1150, which lands the same section on scylla-3.x. Rebased onto the branch as dkropachev reset it (the scylla-3.x tip), plus #1153.

3.x will never support client routes (DRIVER-437), but people search the 3.x docs for PrivateLink too, and #1081's note (already on this branch since its reset to the scylla-3.x tip) is all it has. This adds the 4.x Connectivity section (#1130) to the 3.x manual.

  • manual/connectivity/: an index, a VPC peering page in 3.x API terms, and a client routes page saying 3.x does not support them, with 4.x ≥ 4.19.0.7 as the path
  • 3.x-specific corrections compared with 4.x: withSSL() does no hostname verification, build() does not connect, a wrong local DC fails only on requests, withoutAdvancedShardAwareness() covers NAT and a blocked shard-aware port, and a translator must map each node to its own address:port
  • docs: note that client routes are 4.x-only (DRIVER-1043) #1081's section shrinks to a pointer; its heading is unchanged, so the anchor survives

Verified with make -C docs test against the unmodified base: same 52 warnings on both (this branch is recommonmark, so a local MyST build always fails, #1132), and the new anchor renders. The driver behaviour described was read from the source, not observed on a cluster. Not checked: search/sitemap indexing.

Refs: #1121
Jira: DRIVER-1043

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Sep 24, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Bouncheck and others added 3 commits September 28, 2026 14:06
Replaces occurences `{eval-rst}` occurences with `eval_rst` across
manuals. The former is used with myst parser the latter with recommonmark.
Myst parser version is currently worse because it does not link other pages
referenced in text correctly. It treats them as anchors on the same page.

(cherry picked from commit c3f9464)
A push to this branch runs its own copy of the docs publish workflow,
which rebuilds and deploys the whole site. This copy installs JDK 8
only and has no javadoc guard, so it would publish every JDK 11 version
without its api/. Replace it with scylla-4.x's docs-pages.yml.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Mirror 4.x's Connectivity section (scylladb#1130) so the 3.x docs answer the
same searches: an index mapping each kind of network to what the driver
needs, a VPC peering / Transit Gateway / direct connection page in 3.x
API terms, and a client routes page stating that 3.x does not support
them and pointing to 4.x. The Address resolution section from scylladb#1081
shrinks to a pointer; its heading is unchanged so the anchor survives.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
@nikagra

nikagra commented Sep 28, 2026

Copy link
Copy Markdown
Author

Superseded by #1150 on scylla-3.x, which reaches /scylla-3.11.5.x/ on the next fast-forward.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants