summaryrefslogtreecommitdiff
path: root/redis.conf
diff options
context:
space:
mode:
authorMadelyn Olson <34459052+madolson@users.noreply.github.com>2022-01-02 19:48:29 -0800
committerGitHub <noreply@github.com>2022-01-02 19:48:29 -0800
commit5460c100471fda537468d1f1fa43258638c8a1ce (patch)
treefb35dbd18cbab8c0b9e6b094d61521d20e800169 /redis.conf
parent9f8885760b53e6d3952b9c9b41f9e6c48dfa6cec (diff)
downloadredis-5460c100471fda537468d1f1fa43258638c8a1ce.tar.gz
Implement clusterbus message extensions and cluster hostname support (#9530)
Implement the ability for cluster nodes to advertise their location with extension messages.
Diffstat (limited to 'redis.conf')
-rw-r--r--redis.conf26
1 files changed, 26 insertions, 0 deletions
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.