Skip to content

Add missing cluster configuration options to docs#1835

Merged
vazois merged 2 commits into
mainfrom
vazois/docs-cluster-announce-options
May 29, 2026
Merged

Add missing cluster configuration options to docs#1835
vazois merged 2 commits into
mainfrom
vazois/docs-cluster-announce-options

Conversation

@vazois

@vazois vazois commented May 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Add four missing cluster-related options to the configuration documentation page.

Closes #1824

Added Options

Option CLI Flag Description
ClusterAnnouncePort \--cluster-announce-port\ Port advertised to other nodes for gossiping
ClusterAnnounceIp \--cluster-announce-ip\ IP address advertised to other nodes for gossiping
ClusterAnnounceHostname \--cluster-announce-hostname\ Hostname advertised to other nodes for gossiping
ClusterPreferredEndpointType \--cluster-preferred-endpoint-type\ Endpoint type advertised to other nodes (ip/hostname/unknown)

These are placed after \CleanClusterConfig\ to group all cluster announce/endpoint settings together.

…page

Add ClusterAnnouncePort, ClusterAnnounceIp, ClusterAnnounceHostname,
and ClusterPreferredEndpointType to the configuration documentation.

Closes #1824

Co-authored-by: Copilot <[email protected]>
Copilot AI review requested due to automatic review settings May 28, 2026 18:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds four cluster networking/announce-related configuration settings to the user-facing configuration table on the docs site, mirroring what already exists in defaults.conf and Options.cs. This addresses #1824, where users deploying clusters behind NAT/cross-region could not discover these options from the documentation.

Changes:

  • Add table rows for ClusterAnnouncePort, ClusterAnnounceIp, ClusterAnnounceHostname, and ClusterPreferredEndpointType.
  • Place new rows after CleanClusterConfig so cluster-related options stay grouped.

@vazois vazois merged commit e7025a6 into main May 29, 2026
16 checks passed
@vazois vazois deleted the vazois/docs-cluster-announce-options branch May 29, 2026 18:07
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.

ClusterAnnounceIp, ClusterAnnouncePort, ClusterAnnounceHostname, and ClusterPreferredEndpointType missing from Configuration documentation page

3 participants