Skip to content

docs: single shared Gateway listener for all coordinators - #1740

Open
as51340 wants to merge 1 commit into
release/3.13from
feat/single-tcp-route-coords
Open

docs: single shared Gateway listener for all coordinators#1740
as51340 wants to merge 1 commit into
release/3.13from
feat/single-tcp-route-coords

Conversation

@as51340

@as51340 as51340 commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Release note

Documented the HA Helm chart change where all coordinators are exposed through a single Gateway API listener and a single TCPRoute on ports.boltPort instead of one listener/TCPRoute per coordinator. The Gateway round-robins new connections across every coordinator Service, so clients need only one coordinator address and scaling the coordinator tier no longer adds a listener or a port.

Changes in pages/clustering/high-availability/setup-ha-cluster-k8s.mdx:

  • Added a breaking-change callout: externalAccessConfig.gateway.coordinatorPortBase no longer exists (chart rendering fails if set), clients must move to <gateway-host>:<boltPort>, and existing Gateways must replace their coordinator-{id}-bolt listeners with a single coordinators-bolt listener.
  • Rewrote the chart-managed Gateway section: created resources, per-data-instance ports vs. the shared coordinator port, round-robin behavior, and the fact that the shared <hostname>:<boltPort> is registered as every coordinator's routing bolt_server.
  • Documented the new dataPortBase + id vs. ports.boltPort collision rule that fails rendering when both tiers go through the Gateway.
  • Updated the existing-Gateway listener list to coordinators-bolt on 7687.
  • Removed the externalAccessConfig.gateway.coordinatorPortBase row from the configuration table and clarified the dataPortBase and ports.boltPort descriptions.
  • Updated the external-access overview bullets to mention the shared coordinator listener.

Related product PRs

PRs from product repo this doc page is related to:

Checklist:

  • Add appropriate milestone (current release cycle)
  • Add bugfix or feature label, based on the product PR type you're documenting
  • Make sure all relevant tech details are documented
    • Update reference pages (configuration options table on the HA K8s page)
    • Search for the feature you are working on (mentions) and make updates if needed
    • Provide a basic example of usage
    • In case your feature is an Enterprise one, list it under ME page — N/A
  • Check all content with Grammarly
  • Perform a self-review of my code
  • The build passes locally
  • My changes generate no new warnings or errors

Note

The chart PR does not bump Chart.yaml (still 1.3.3, which is released and does ship coordinatorPortBase), so the breaking-change callout is worded as "HA chart versions after 1.3.3". If a specific version is decided before the chart PR merges, that line should be updated.

Coordinators are no longer exposed through one Gateway listener/TCPRoute
each: they share a single listener on ports.boltPort with one TCPRoute
fanning out to every coordinator Service, so the Gateway round-robins
connections across them. Drops externalAccessConfig.gateway.coordinatorPortBase
and documents the dataPortBase vs ports.boltPort collision rule.
@vercel

vercel Bot commented Aug 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Aug 27, 2026 10:30am

Request Review

@as51340
as51340 changed the base branch from main to release/3.13 August 27, 2026 10:25
@as51340 as51340 added this to the 3.13 milestone Aug 27, 2026
@as51340 as51340 self-assigned this Aug 27, 2026
@as51340 as51340 added the feature Documentation related to a new product feature of feature update label Aug 27, 2026
@as51340 as51340 changed the title docs(ha-k8s): single shared Gateway listener for all coordinators docs: single shared Gateway listener for all coordinators Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature Documentation related to a new product feature of feature update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant