honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/modules/network.asciidoc

102 lines
4.1 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[modules-network]]
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
== Basic Settings
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
Commonly used network settings:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[cols="<,<",options="header",]
|=======================================================================
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|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_`.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|`discovery.zen.ping.unicast.hosts`|Initial list other nodes. Can be set to IP addresses or hostnames. Defaults to `["127.0.0.1", "[::1]"]`.
Allow binding to multiple addresses * Allow for multiple host specifications (e.g. _en0_,192.168.1.2,_site_). * Add _site_ and _global_ scopes as counterparts to _local_. * Warn on heuristic selection of publish address. * Remove the arbitrary _non_loopback_ setting. Closes #13954
2015-10-23 23:43:37 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|`http.port` |Port to bind for incoming http requests. Can be set to a single value or a range. Defaults to `9200-9300`.
Allow binding to multiple addresses * Allow for multiple host specifications (e.g. _en0_,192.168.1.2,_site_). * Add _site_ and _global_ scopes as counterparts to _local_. * Warn on heuristic selection of publish address. * Remove the arbitrary _non_loopback_ setting. Closes #13954
2015-10-23 23:43:37 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|`transport.tcp.port` |Port to bind for communication between nodes. Can be set to a single value or a range. Defaults to `9300-9400`.
fix tables
2015-12-09 14:04:44 -05:00
|=======================================================================
Allow binding to multiple addresses * Allow for multiple host specifications (e.g. _en0_,192.168.1.2,_site_). * Add _site_ and _global_ scopes as counterparts to _local_. * Warn on heuristic selection of publish address. * Remove the arbitrary _non_loopback_ setting. Closes #13954
2015-10-23 23:43:37 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
Be careful with network configuration! Never expose an unprotected instance
to the public internet.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
[cols="<,<",options="header",]
|=======================================================================
|Special Host Value |Description
|`_[networkInterface]_` |Resolves to the addresses of the provided
network interface. For example `_en0_`.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|`_local_` |Will be resolved to loopback addresses (e.g. 127.0.0.1)
Fix network binding for ipv4/ipv6 When elasticsearch is configured by interface (or default: loopback interfaces), bind to all addresses on the interface rather than an arbitrary one. If the publish address is not specified, default it from the bound addresses based on the following sort ordering: * ipv4/ipv6 (java.net.preferIPv4Stack, defaults to true) * ordinary addresses * site-local addresses * link local addresses * loopback addresses One one address is published, and multicast is still always over ipv4: these need to be future improvements. Closes #12906 Closes #12915 Squashed commit of the following: commit 7e60833312f329a5749f9a256b9c1331a956d98f Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 14:45:33 2015 -0400 fix java 7 compilation oops commit c7b9f3a42058beb061b05c6dd67fd91477fd258a Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 14:24:16 2015 -0400 Cleanup/fix logic around custom resolvers commit bd7065f1936e14a29c9eb8fe4ecab0ce512ac08e Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 13:29:42 2015 -0400 Add some unit tests for utility methods commit 0faf71cb0ee9a45462d58af3d1bf214e8a79347c Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 12:11:48 2015 -0400 localhost all the way down commit e198bb2bc0d1673288b96e07e6e6ad842179978c Merge: b55d092 b93a75f Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 12:05:02 2015 -0400 Merge branch 'master' into network_cleanup commit b55d092811d7832bae579c5586e171e9cc1ebe9d Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 12:03:03 2015 -0400 fix docs, fix another bug in multicast (publish host = bad here!) commit 88c462eb302b30a82585f95413927a5cbb7d54c4 Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 11:50:49 2015 -0400 remove nocommit commit 89547d7b10d68b23d7f24362e1f4782f5e1ca03c Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 11:49:35 2015 -0400 fix http too commit 9b9413aca8a3f6397b5031831f910791b685e5be Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 11:06:02 2015 -0400 Fix transport / interface code Next up: multicast and then http
2015-08-17 15:37:07 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|`_site_` |Will be resolved to site-local addresses (e.g. 192.168.0.1)
Fix network binding for ipv4/ipv6 When elasticsearch is configured by interface (or default: loopback interfaces), bind to all addresses on the interface rather than an arbitrary one. If the publish address is not specified, default it from the bound addresses based on the following sort ordering: * ipv4/ipv6 (java.net.preferIPv4Stack, defaults to true) * ordinary addresses * site-local addresses * link local addresses * loopback addresses One one address is published, and multicast is still always over ipv4: these need to be future improvements. Closes #12906 Closes #12915 Squashed commit of the following: commit 7e60833312f329a5749f9a256b9c1331a956d98f Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 14:45:33 2015 -0400 fix java 7 compilation oops commit c7b9f3a42058beb061b05c6dd67fd91477fd258a Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 14:24:16 2015 -0400 Cleanup/fix logic around custom resolvers commit bd7065f1936e14a29c9eb8fe4ecab0ce512ac08e Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 13:29:42 2015 -0400 Add some unit tests for utility methods commit 0faf71cb0ee9a45462d58af3d1bf214e8a79347c Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 12:11:48 2015 -0400 localhost all the way down commit e198bb2bc0d1673288b96e07e6e6ad842179978c Merge: b55d092 b93a75f Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 12:05:02 2015 -0400 Merge branch 'master' into network_cleanup commit b55d092811d7832bae579c5586e171e9cc1ebe9d Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 12:03:03 2015 -0400 fix docs, fix another bug in multicast (publish host = bad here!) commit 88c462eb302b30a82585f95413927a5cbb7d54c4 Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 11:50:49 2015 -0400 remove nocommit commit 89547d7b10d68b23d7f24362e1f4782f5e1ca03c Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 11:49:35 2015 -0400 fix http too commit 9b9413aca8a3f6397b5031831f910791b685e5be Author: Robert Muir <rmuir@apache.org> Date: Mon Aug 17 11:06:02 2015 -0400 Fix transport / interface code Next up: multicast and then http
2015-08-17 15:37:07 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
|`_global_` |Will be resolved to globally-scoped addresses (e.g. 8.8.8.8)
fix tables
2015-12-09 14:04:44 -05:00
|=======================================================================
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
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`.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[discovery-ec2] network.host must be set With 2.0, we now bind to `localhost` by default instead of binding to the network card and use its IP address. When the discovery plugin gets from AWS API the list of nodes that should form the cluster, this list is pinged then. But as each node is bound to `localhost`, ping does not get an answer and the node elects itself as the master node. `network.host` must be set. Closes #13589.
2015-09-16 02:38:34 -04:00
When the `discovery-ec2` plugin is installed, you can use
{plugins}/discovery-ec2-discovery.html#discovery-ec2-network-host[ec2 specific host settings].
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Replace cloud-gce with discovery-gce Related to #13815
2015-10-08 02:53:54 -04:00
When the `discovery-gce` plugin is installed, you can use
[discovery-gce] add _gce_ network host setting When running in GCE platform, an instance has access to: http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/0/ip Which gives back the private IP address, for example `10.240.0.2`. http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/0/externalIp Gives back the public Ip address, for example `130.211.108.21`. As we have for `ec2`, we can support new network host settings: * `_gce:privateIp:X_`: The private IP address of the machine for a given network interface. * `_gce:hostname_`: The hostname of the machine. * `_gce_`: Same as `_gce:privateIp:0_` (recommended). Closes #13605. Closes #13590. BTW resolveIfPossible now throws IOException so code is also updated for ec2 discovery and some basic tests have been added.
2015-09-16 06:56:28 -04:00
{plugins}/discovery-gce-network-host.html[gce specific host settings].
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
[float]
[[advanced]]
=== Advanced network settings
`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`).
The `network.publish_host` setting allows to control 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:
[discovery-gce] add _gce_ network host setting When running in GCE platform, an instance has access to: http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/0/ip Which gives back the private IP address, for example `10.240.0.2`. http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/0/externalIp Gives back the public Ip address, for example `130.211.108.21`. As we have for `ec2`, we can support new network host settings: * `_gce:privateIp:X_`: The private IP address of the machine for a given network interface. * `_gce:hostname_`: The hostname of the machine. * `_gce_`: Same as `_gce:privateIp:0_` (recommended). Closes #13605. Closes #13590. BTW resolveIfPossible now throws IOException so code is also updated for ec2 discovery and some basic tests have been added.
2015-09-16 06:56:28 -04:00
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[tcp-settings]]
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
=== Advanced TCP Settings
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Any component that uses TCP (like the HTTP, Transport and Memcached)
share the following allowed settings:
[cols="<,<",options="header",]
|=======================================================================
|Setting |Description
|`network.tcp.no_delay` |Enable or disable tcp no delay setting.
Docs: Removed all the added/deprecated tags from 1.x
2014-09-26 15:04:42 -04:00
Defaults to `true`.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Support "default" for tcpNoDelay and tcpKeepAlive Allow to set the value default to network.tcp.no_delay and network.tcp.keep_alive so they won't be set at all, since on solaris, setting tcpNoDelay can actually cause failure relates to #7115
2014-08-02 11:26:48 -04:00
|`network.tcp.keep_alive` |Enable or disable tcp keep alive. Defaults
Docs: Removed all the added/deprecated tags from 1.x
2014-09-26 15:04:42 -04:00
to `true`.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
|`network.tcp.reuse_address` |Should an address be reused or not.
[DOCS] fix typo in network module docs
2014-05-22 03:15:38 -04:00
Defaults to `true` on non-windows machines.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
|`network.tcp.send_buffer_size` |The size of the tcp send buffer size
(in size setting format). By default not explicitly set.
|`network.tcp.receive_buffer_size` |The size of the tcp receive buffer
size (in size setting format). By default not explicitly set.
|=======================================================================
Improve network docs This makes some minor improvements (does not fix all problems!) It reorders unicast disco in elasticsearch.yml to be right after the network host, for better locality. It removes the warning (unreleased) about publish addresses, lets try to really discourage setting that unless you need to (behind a proxy server). Most people should be fine with `network.host` Finally it reorganizes the network docs page a bit: We add a table of 4 "basic" settings at the very beginning: * network.host * discovery.zen.ping.unicast.hosts * http.port * transport.tcp.port The first two being the most important, which addresses to bind and talk to, and the other two being the port numbers. The rest of the stuff I tried to simplify and reorder under "advanced" headers. This is just a quick stab, I still think we need more effort into this thing, but we gotta start somewhere.
2015-12-09 13:22:14 -05:00
[float]
[[module-settings]]
=== Module-specific Settings
There are several modules within a Node that use network based
configuration, for example, the
<<modules-transport,transport>> and
<<modules-http,http>> modules. Node level
network settings allows to set common settings that will be shared among
all network based modules (unless explicitly overridden in each module).