From 5460c100471fda537468d1f1fa43258638c8a1ce Mon Sep 17 00:00:00 2001
From: Madelyn Olson <34459052+madolson@users.noreply.github.com>
Date: Sun, 2 Jan 2022 19:48:29 -0800
Subject: Implement clusterbus message extensions and cluster hostname support
 (#9530)

Implement the ability for cluster nodes to advertise their location with extension messages.
---
 redis.conf | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'redis.conf')

diff --git a/redis.conf b/redis.conf
index 8804aac37..9d0f0dfb7 100644
--- a/redis.conf
+++ b/redis.conf
@@ -1632,6 +1632,32 @@ lua-time-limit 5000
 # PubSub message by default. (client-query-buffer-limit default value is 1gb)
 #
 # cluster-link-sendbuf-limit 0
+ 
+# Clusters can configure their announced hostname using this config. This is a common use case for 
+# applications that need to use TLS Server Name Indication (SNI) or dealing with DNS based
+# routing. By default this value is only shown as additional metadata in the CLUSTER SLOTS
+# command, but can be changed using 'cluster-preferred-endpoint-type' config. This value is 
+# communicated along the clusterbus to all nodes, setting it to an empty string will remove 
+# the hostname and also propgate the removal. 
+#
+# cluster-announce-hostname ""
+
+# Clusters can advertise how clients should connect to them using either their IP address,
+# a user defined hostname, or by declaring they have no endpoint. Which endpoint is
+# shown as the preferred endpoint is set by using the cluster-preferred-endpoint-type
+# config with values 'ip', 'hostname', or 'unknown-endpoint'. This value controls how
+# the endpoint returned for MOVED/ASKING requests as well as the first field of CLUSTER SLOTS. 
+# If the preferred endpoint type is set to hostname, but no announced hostname is set, a '?' 
+# will be returned instead.
+#
+# When a cluster advertises itself as having an unknown endpoint, it's indicating that
+# the server doesn't know how clients can reach the cluster. This can happen in certain 
+# networking situations where there are multiple possible routes to the node, and the 
+# server doesn't know which one the client took. In this case, the server is expecting
+# the client to reach out on the same endpoint it used for making the last request, but use
+# the port provided in the response.
+#
+# cluster-preferred-endpoint-type ip
 
 # In order to setup your cluster make sure to read the documentation
 # available at https://redis.io web site.
-- 
cgit v1.2.1