honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 10:25:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

simplify wording

Browse Source
This commit is contained in:
Robert Muir 2015-12-09 14:27:49 -05:00 committed by Clinton Gormley
parent 3049b14f6b
commit f578254ca7
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/reference/modules/network.asciidoc
View File

@ -6,13 +6,13 @@ Commonly used network settings:
[cols="<,<",options="header",] [cols="<,<",options="header",]
|======================================================================= |=======================================================================
|Name |Description |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 Be careful with network configuration! Never expose an unprotected instance
@ -25,19 +25,18 @@ to the public internet.
[cols="<,<",options="header",] [cols="<,<",options="header",]
|======================================================================= |=======================================================================
|Special Host Value |Description |Special Host Value |Description
|`_[networkInterface]_` |Resolves to the addresses of the provided |`_[networkInterface]_` |Addresses of a network interface, for example `_en0_`.
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, 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 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`. example, `_en0:ipv4_` would only bind to the ipv4 addresses of interface `en0`.
When the `discovery-ec2` plugin is installed, you can use When the `discovery-ec2` plugin is installed, you can use
{plugins}/discovery-ec2-discovery.html#discovery-ec2-network-host[ec2 specific host settings]. {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` `network.bind_host` and `network.publish_host` can be set instead of `network.host`
for advanced cases such as when behind a proxy server. for advanced cases such as when behind a proxy server.
The `network.bind_host` setting allows to control the host different network `network.bind_host` sets the host different network
components will bind on. By default, the bind host will be `_local_` components will bind on.
(loopback addresses such as `127.0.0.1`, `::1`).
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. 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 Currently an elasticsearch node may be bound to multiple addresses, but only
publishes one. If not specified, this defaults to the "best" address from publishes one. If not specified, this defaults to the "best" address from
`network.bind_host`, sorted by IPv4/IPv6 stack preference, then by reachability. `network.bind_host`, sorted by IPv4/IPv6 stack preference, then by reachability.
Both settings allows to be configured with either explicit host address(es) Both settings can be configured just like `network.host`: they accept ip
or host name(s). The settings also accept logical setting value(s) explained addresses, host names, and special values.
in the following table:
[float] [float]
[[tcp-settings]] [[tcp-settings]]