Skip to content

Commit 9eab11c

Browse files
authored
Clarify use of special values for publish addresses (#114551)
Special values like `0.0.0.0` may resolve to multiple IP addresses just like hostnames, so the same considerations apply when using such values as a publish address. This commit spells this case out in the docs and cleans up the nearby wording a little.
1 parent b0aa39f commit 9eab11c

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

docs/reference/modules/network.asciidoc

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -153,23 +153,34 @@ The only requirements are that each node must be:
153153

154154
* Accessible at its transport publish address by all other nodes in its
155155
cluster, and by any remote clusters that will discover it using
156-
<<sniff-mode>>.
156+
<<sniff-mode,sniff mode>>.
157157

158158
Each node must have its own distinct publish address.
159159

160160
If you specify the transport publish address using a hostname then {es} will
161161
resolve this hostname to an IP address once during startup, and other nodes
162162
will use the resulting IP address instead of resolving the name again
163-
themselves. To avoid confusion, use a hostname which resolves to the node's
164-
address in all network locations.
163+
themselves. You must use a hostname such that all of the addresses to which it
164+
resolves are addresses at which the node is accessible from all other nodes. To
165+
avoid confusion, it is simplest to use a hostname which resolves to a single
166+
address.
167+
168+
If you specify the transport publish address using a
169+
<<network-interface-values,special value>> then {es} will resolve this value to
170+
a single IP address during startup, and other nodes will use the resulting IP
171+
address instead of resolving the value again themselves. You must use a value
172+
such that all of the addresses to which it resolves are addresses at which the
173+
node is accessible from all other nodes. To avoid confusion, it is simplest to
174+
use a value which resolves to a single address. It is usually a mistake to use
175+
`0.0.0.0` as a publish address on hosts with more than one network interface.
165176

166177
===== Using a single address
167178

168179
The most common configuration is for {es} to bind to a single address at which
169-
it is accessible to clients and other nodes. In this configuration you should
170-
just set `network.host` to that address. You should not separately set any bind
171-
or publish addresses, nor should you separately configure the addresses for the
172-
HTTP or transport interfaces.
180+
it is accessible to clients and other nodes. To use this configuration, set
181+
only `network.host` to the desired address. Do not separately set any bind or
182+
publish addresses. Do not separately specify the addresses for the HTTP or
183+
transport interfaces.
173184

174185
===== Using multiple addresses
175186

0 commit comments

Comments
 (0)