Repository navigation
docs: document hostnames in cluster file and coordinators command - #14289
Open
VanshBhardwaj24 wants to merge 1 commit into
Open
VanshBhardwaj24 wants to merge 1 commit into
VanshBhardwaj24 wants to merge 1 commit into
Conversation
ShreeChaturvedi
self-requested a review
October 16, 2026 19:41
ShreeChaturvedi
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this! One correction before merging: the new text says hostnames are kept as written, but coordinators auto writes IP addresses. If auto changes the coordinators, the hostnames in the cluster file are replaced. On a local cluster:
fdb> coordinators coord1.fdbtest:4700
cluster file: ...@coord1.fdbtest:4700
fdb> configure double
fdb> coordinators auto
cluster file: ...@127.0.0.1:4701,127.0.0.1:4702,127.0.0.1:4703
I've suggested wording inline. A few smaller things readers might run into:
- Running
coordinators(or reading the special key) shows IPs even when the file has hostnames, so it looks like the change didn't work. - Every hostname has to resolve when you run
coordinators, or the command fails. - Order isn't kept: IPs go first, then hostnames.
Fine for this PR: architecture.rst, kv-architecture.rst, and help coordinators still say IP:PORT only.
The cluster file format section said coordinators are IP addresses "(not hostnames)", and the coordinators command and special key were documented as taking only IP:port. Hostnames have been accepted since 7.1.4: ClusterConnectionString routes each entry through Hostname::isHostname, and the coordinators command and special key accept HOSTNAME:PORT. Document the HOSTNAME:PORT form and the optional :tls suffix, that each hostname must resolve when the coordinators are changed, and that "coordinators auto" and reads of the coordinators key use IP addresses.
VanshBhardwaj24
force-pushed
the
docs-coordinator-hostnames
branch
from
October 17, 2026 12:01
e800932 to
8e1d4b5
Compare
Contributor
Author
|
Thanks @ShreeChaturvedi, that was a real miss on my part. I checked each point against the code and pushed an update:
I left |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs still say that the cluster file lists IP addresses "(not hostnames)", and that the
coordinatorscommand and thecoordinators/processesspecial key take IP:port pairs. Hostnames are supported:ClusterConnectionStringparses each entry withHostname::isHostname, so a list can mix hostnames and IP addresses (fdbclient/MonitorLeader.cpp), andHostname::parseaccepts an optional:tlssuffix (flow/Hostname.cpp).coordinatorscommand and the special key acceptHOSTNAME:PORT(fdbcli/CoordinatorsCommand.cpp,fdbclient/SpecialKeySpace.cpp).changeQuorumCheckerresolves the hostnames and fails withCOORDINATOR_UNREACHABLEif any of them does not resolve, and reading the special key returns the resolved addresses (fdbclient/ManagementAPI.cpp,fdbclient/SpecialKeySpace.cpp).coordinators autoreturns network addresses (AutoQuorumChangeinfdbclient/ManagementAPI.cpp), so if it changes the coordinators the cluster file lists IP addresses instead of hostnames.guide-common.rst.incalready says it selects processes by IP address./fdbclient/MonitorLeader/parseConnectionString/hostnamesunit test covers hostname-only connection strings, the:tlssuffix, and rejection of duplicate hostnames.This updates
administration.rst, the shared cluster-file rule inguide-common.rst.inc,command-line-interface.rstandspecial-keys.rstto describe theHOSTNAME:PORTform and these caveats. The new text only states what the code and tests above show.Not changed here: the built-in
fdbclihelp text forcoordinators,architecture.rstandkv-architecture.rststill mention only IP:port. Those can go in a follow-up.Validation: the Sphinx 6.2.1 HTML build passes with warnings treated as errors, using the same
sphinx-build -Winvocation asdocumentation/CMakeLists.txt.git diff --checkis clean. The unit tests andfdbcliwere not built or run.Docs-only change; no code or behavior is affected.
Related to #3469.