From f578254ca746009ac1b0274e213f58b1975d47cb Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Wed, 9 Dec 2015 14:27:49 -0500 Subject: [PATCH] simplify wording --- docs/reference/modules/network.asciidoc | 33 +++++++++++-------------- 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/docs/reference/modules/network.asciidoc b/docs/reference/modules/network.asciidoc index 6c16d846d95..0352e1d327c 100644 --- a/docs/reference/modules/network.asciidoc +++ b/docs/reference/modules/network.asciidoc @@ -6,13 +6,13 @@ Commonly used network settings: [cols="<,<",options="header",] |======================================================================= |Name |Description -|`network.host` |Host to bind and publish to other nodes. Can be set to an IP address, hostname, or special value (see table below). Defaults to `_local_`. +|`network.host` |Host to bind and publish to other nodes. Accepts an IP address, hostname, or special value (see table below). Defaults to `_local_`. -|`discovery.zen.ping.unicast.hosts`|Initial list of other nodes. Can be set to IP addresses or hostnames. Defaults to `["127.0.0.1", "[::1]"]`. +|`discovery.zen.ping.unicast.hosts`|Initial list of other nodes. Accepts IP addresses or hostnames. Defaults to `["127.0.0.1", "[::1]"]`. -|`http.port` |Port to bind for incoming http requests. Can be set to a single value or a range. Defaults to `9200-9300`. +|`http.port` |Port to bind for incoming http requests. Accepts a single value or a range. Defaults to `9200-9300`. -|`transport.tcp.port` |Port to bind for communication between nodes. Can be set to a single value or a range. Defaults to `9300-9400`. +|`transport.tcp.port` |Port to bind for communication between nodes. Accepts a single value or a range. Defaults to `9300-9400`. |======================================================================= Be careful with network configuration! Never expose an unprotected instance @@ -25,19 +25,18 @@ to the public internet. [cols="<,<",options="header",] |======================================================================= |Special Host Value |Description -|`_[networkInterface]_` |Resolves to the addresses of the provided -network interface. For example `_en0_`. +|`_[networkInterface]_` |Addresses of a network interface, for example `_en0_`. -|`_local_` |Will be resolved to loopback addresses (e.g. 127.0.0.1) +|`_local_` |Any loopback addresses on the system, for example `127.0.0.1`. -|`_site_` |Will be resolved to site-local addresses (e.g. 192.168.0.1) +|`_site_` |Any site-local addresses on the system, for example `192.168.0.1`. -|`_global_` |Will be resolved to globally-scoped addresses (e.g. 8.8.8.8) +|`_global_` |Any globally-scoped addresses on the system, for example `8.8.8.8`. |======================================================================= These special values will work over both IPv4 and IPv6 by default, -but you can also limit this with the use of `:ipv4` of `:ipv6` specifiers, for -example `_en0:ipv4_` would only bind to the ipv4 addresses of interface `en0`. +but you can also limit this with the use of `:ipv4` of `:ipv6` specifiers. For +example, `_en0:ipv4_` would only bind to the ipv4 addresses of interface `en0`. When the `discovery-ec2` plugin is installed, you can use {plugins}/discovery-ec2-discovery.html#discovery-ec2-network-host[ec2 specific host settings]. @@ -52,19 +51,17 @@ When the `discovery-gce` plugin is installed, you can use `network.bind_host` and `network.publish_host` can be set instead of `network.host` for advanced cases such as when behind a proxy server. -The `network.bind_host` setting allows to control the host different network -components will bind on. By default, the bind host will be `_local_` -(loopback addresses such as `127.0.0.1`, `::1`). +`network.bind_host` sets the host different network +components will bind on. -The `network.publish_host` setting allows to control the host the node will +`network.publish_host` sets the host the node will publish itself within the cluster so other nodes will be able to connect to it. Currently an elasticsearch node may be bound to multiple addresses, but only publishes one. If not specified, this defaults to the "best" address from `network.bind_host`, sorted by IPv4/IPv6 stack preference, then by reachability. -Both settings allows to be configured with either explicit host address(es) -or host name(s). The settings also accept logical setting value(s) explained -in the following table: +Both settings can be configured just like `network.host`: they accept ip +addresses, host names, and special values. [float] [[tcp-settings]]