Describe the bug
The Configuration - Configurable Settings table on the docs website is missing several cluster networking settings that exist in defaults.conf and are required for NAT/cross-region deployments:
| Setting |
CLI Flag |
Purpose |
ClusterAnnounceIP |
--cluster-announce-ip |
Override the IP address advertised to other nodes for gossip/replication |
ClusterAnnouncePort |
--cluster-announce-port |
Override the port advertised to other nodes |
ClusterAnnounceHostname |
--cluster-announce-hostname |
Override the hostname advertised to other nodes |
ClusterPreferredEndpointType |
--cluster-preferred-endpoint-type |
Control whether IP or hostname is used as the primary endpoint (ip/hostname/unknown-endpoint) |
Impact
Users deploying Garnet cluster across regions (behind NAT/cloud EIPs) cannot discover these essential settings from the documentation. Without --cluster-announce-ip, nodes advertise their internal/private IP, making cross-region gossip and replication silently fail - CLUSTER REPLICATE returns OK but replication never activates because the replica can't reach the primary's advertised internal IP.
The only way to discover these options is to read defaults.conf on GitHub directly or find issue #1650's comment by @vazois.
Steps to reproduce the bug
- Visit https://microsoft.github.io/garnet/docs/getting-started/configuration
- Search for "announce" or "ClusterAnnounceIp" - not found in the settings table
- Compare with defaults.conf where all four settings are defined
Expected behavior
No response
Screenshots
No response
Release version
Garnet v1.1.6, two-node cluster across Alibaba Cloud regions (NAT'd public IPs)
IDE
No response
OS version
Windows Server 2022
Additional context
Related: PR #1151, PR #1495, Issue #640, Issue #1650
Describe the bug
The Configuration - Configurable Settings table on the docs website is missing several cluster networking settings that exist in
defaults.confand are required for NAT/cross-region deployments:ClusterAnnounceIP--cluster-announce-ipClusterAnnouncePort--cluster-announce-portClusterAnnounceHostname--cluster-announce-hostnameClusterPreferredEndpointType--cluster-preferred-endpoint-typeip/hostname/unknown-endpoint)Impact
Users deploying Garnet cluster across regions (behind NAT/cloud EIPs) cannot discover these essential settings from the documentation. Without
--cluster-announce-ip, nodes advertise their internal/private IP, making cross-region gossip and replication silently fail - CLUSTER REPLICATE returns OK but replication never activates because the replica can't reach the primary's advertised internal IP.The only way to discover these options is to read
defaults.confon GitHub directly or find issue #1650's comment by @vazois.Steps to reproduce the bug
Expected behavior
No response
Screenshots
No response
Release version
Garnet v1.1.6, two-node cluster across Alibaba Cloud regions (NAT'd public IPs)
IDE
No response
OS version
Windows Server 2022
Additional context
Related: PR #1151, PR #1495, Issue #640, Issue #1650