You're viewing version 2.13 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Network settings
OpenSearch uses HTTP settings to configure communication with external clients through the REST API and transport settings for internal node-to-node communication within OpenSearch.
To learn more about static and dynamic settings, see Configuring OpenSearch.
OpenSearch supports the following common network settings:
-
network.host
(Static, list): Binds an OpenSearch node to an address. Use0.0.0.0
to include all available network interfaces, or specify an IP address assigned to a specific interface. Thenetwork.host
setting is a combination ofnetwork.bind_host
andnetwork.publish_host
if they are the same value. An alternative tonetwork.host
is to configurenetwork.bind_host
andnetwork.publish_host
separately as needed. See Advanced network settings. -
http.port
(Static, single value or range): Binds an OpenSearch node to a custom port or a range of ports for HTTP communication. You can specify an address or a range of addresses. Default is9200-9300
. -
transport.port
(Static, single value or range): Binds an OpenSearch node to a custom port for communication between nodes. You can specify an address or a range of addresses. Default is9300-9400
.
Advanced network settings
OpenSearch supports the following advanced network settings:
-
network.bind_host
(Static, list): Binds an OpenSearch node to an address or addresses for incoming connections. Default is the value innetwork.host
. -
network.publish_host
(Static, list): Specifies an address or addresses that an OpenSearch node publishes to other nodes in the cluster so that they can connect to it.
Advanced HTTP settings
OpenSearch supports the following advanced network settings for HTTP communication:
-
http.host
(Static, list): Sets the address of an OpenSearch node for HTTP communication. Thehttp.host
setting is a combination ofhttp.bind_host
andhttp.publish_host
if they are the same value. An alternative tohttp.host
is to configurehttp.bind_host
andhttp.publish_host
separately as needed. -
http.bind_host
(Static, list): Specifies an address or addresses to which an OpenSearch node binds to listen for incoming HTTP connections. -
http.publish_host
(Static, list): Specifies an address or addresses that an OpenSearch node publishes to other nodes for HTTP communication. -
http.compression
(Static, Boolean): Enables support for compression usingAccept-Encoding
when applicable. WhenHTTPS
is enabled, the default isfalse
, otherwise, the default istrue
. Disabling compression for HTTPS helps mitigate potential security risks, such asBREACH
attacks. To enable compression for HTTPS traffic, explicitly sethttp.compression
totrue
.
Advanced transport settings
OpenSearch supports the following advanced network settings for transport communication:
-
transport.host
(Static, list): Sets the address of an OpenSearch node for transport communication. Thetransport.host
setting is a combination oftransport.bind_host
andtransport.publish_host
if they are the same value. An alternative totransport.host
is to configuretransport.bind_host
andtransport.publish_host
separately as needed. -
transport.bind_host
(Static, list): Specifies an address or addresses to which an OpenSearch node binds to listen for incoming transport connections. -
transport.publish_host
(Static, list): Specifies an address or addresses that an OpenSearch node publishes to other nodes for transport communication.
Selecting the transport
The default OpenSearch transport is provided by the transport-netty4
module and uses the Netty 4 engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that can be used interchangeably:
Plugin | Description |
---|---|
transport-nio | The OpenSearch transport based on Java NIO. Installation: ./bin/opensearch-plugin install transport-nio Configuration (using opensearch.yml ): transport.type: nio-transport http.type: nio-http-transport |
transport-reactor-netty4 | The OpenSearch HTTP transport based on Project Reactor and Netty 4 (experimental) Installation: ./bin/opensearch-plugin install transport-reactor-netty4 Configuration (using opensearch.yml ): http.type: reactor-netty4 |