Skip to content

docs: add the connectivity section to the 4.18.1 manual - #1144

Merged
dkropachev merged 3 commits into
scylladb:scylla-4.18.1.xfrom
nikagra:connectivity-4181
Oct 2, 2026
Merged

dkropachev merged 3 commits into
scylladb:scylla-4.18.1.xfrom
nikagra:connectivity-4181

Conversation

@nikagra

@nikagra nikagra commented Sep 24, 2026 •

Copy link
Copy Markdown

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

The 4.18.1 manual has no page answering how to connect to a cluster over VPC peering, Transit Gateway or the public internet, or whether PrivateLink works in this version. This ports #1130's Connectivity section, fitted to what 4.18.1 actually does.

  • manual/core/connectivity/: index, VPC peering / Transit Gateway / direct connection page, and a client routes page saying the feature needs 4.19.0.7+; a translator for a proxy must give each node its own address and port
  • TLS guidance matches ScyllaDB Cloud: port 9142 and the per-cluster CA imported into a truststore
  • dropped what 4.18.1 lacks: multi-address contact points, the subnet translator; the local-DC warning is the one this version logs
  • toctree entry in manual/core/README.md
  • the ScyllaDB Cloud example enables TLS in the builder (engine factory and truststore through withConfigLoader), with the truststore import first; same change as docs: enable TLS in the ScyllaDB Cloud connection example #1163 (scylla-4.x) and docs: add the connectivity section to the 4.19.0 manual #1143, from dkropachev's review there. Checked against driver-core 4.18.1.0: the example's loader yields DefaultSslEngineFactory, and the build shows the same 111 warnings as without the change

Verified with a clean make test: the warning set is identical to the base commit's (111, all pre-existing "not in any toctree" kinds), and the three pages render with the new text.

CI: every tests@v1 job fails at Set up job because this branch's own [email protected] uses unpinned actions, which the org now rejects. Pre-existing; any push to the branch hits it.

Refs: #1119, https://scylladb.atlassian.net/browse/DRIVER-1042

🤖 Generated with Claude Code

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]>
@coderabbitai

coderabbitai Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 53 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: QUIET

Plan: Advanced

Run ID: 6d925762-5397-457b-b558-99634ed2e13f

📥 Commits

Reviewing files that changed from the base of the PR and between 658bca5 and 9ae8812.

📒 Files selected for processing (6)
  • .github/workflows/docs-pages.yaml
  • .github/workflows/docs-pages.yml
  • manual/core/README.md
  • manual/core/connectivity/README.md
  • manual/core/connectivity/client_routes/README.md
  • manual/core/connectivity/vpc_peering/README.md
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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.

Port the connectivity section from scylla-4.x (scylladb#1130) so the 4.18.1.x
docs answer the same network questions: an index, and a page for VPC
peering, Transit Gateway and direct connections. Client routes do not
exist before 4.19.0.7, so their page says so, carries the search
aliases, and explains why an address translator is no substitute.
Hostname-expansion and subnet-proxy text is dropped; neither exists
in this version.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
The example connected to 9142, the TLS port, without enabling TLS, and
the truststore setup came only afterwards as a HOCON block, so the code
copied as shown fails to connect. Configure the engine factory in the
builder and keep the HOCON block as the application.conf alternative.
Say the TLS port is why the example needs TLS, and quote the truststore
password, which HOCON cuts at #.

Note the NullPointerException warning 4.18.1 logs on close when there
is no keystore, and say that a createUnresolved contact point is looked
up again on every connect rather than only at startup.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
@nikagra
nikagra force-pushed the connectivity-4181 branch from 993a109 to 9ae8812 Compare October 1, 2026 18:09
@dkropachev
dkropachev merged commit 18731d0 into scylladb:scylla-4.18.1.x Oct 2, 2026
5 of 9 checks passed
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