You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.
The mode used for a remote cluster connection. The only supported modes are
The time to wait for remote connections to be established when the node
starts. The default is
By default, any node in the cluster can act as a cross-cluster client and
connect to remote clusters. To prevent a node from connecting to remote
clusters, specify the node.roles setting in
remote_cluster_clientfrom the listed roles. Search requests targeting remote clusters must be sent to a node that is allowed to act as a cross-cluster client. Other features such as machine learning data feeds, transforms, and cross-cluster replication require the
Per cluster boolean setting that allows to skip specific clusters when no
nodes belonging to them are available and they are the target of a remote
cluster request. Default is
false, meaning that all clusters are mandatory by default, but they can selectively be made optional by setting this setting to
Sets the time interval between regular application-level ping messages that
are sent to try and keep remote cluster connections alive. If set to
-1, application-level ping messages to this remote cluster are not sent. If unset, application-level ping messages are sent according to the global
transport.ping_schedulesetting, which defaults to
-1meaning that pings are not sent. It is preferable to correctly configure TCP keep-alives instead of configuring a
ping_schedule, because TCP keep-alives are handled by the operating system and not by Elasticsearch. By default Elasticsearch enables TCP keep-alives on remote cluster connections. Remote cluster connections are transport connections so the
transport.tcp.*advanced settings regarding TCP keep-alives apply to them.
Per cluster setting that enables you to configure compression for requests
to a specific remote cluster. This setting impacts only requests
sent to the remote cluster. If the inbound request is compressed,
Elasticsearch compresses the response. The setting options are
false. If unset, the global
transport.compressis used as the fallback setting.
Per cluster setting that enables you to configure compression scheme for
requests to a specific remote cluster. This setting impacts only requests
sent to the remote cluster. If an inbound request is compressed, Elasticsearch
compresses the response using the same compression scheme. The setting options
lz4. If unset, the global
transport.compression_schemeis used as the fallback setting.
- [beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. Per cluster setting for configuring remote clusters with the API Key based model. This setting takes the encoded value of a cross-cluster API key and must be set in the Elasticsearch keystore on each node in the cluster. The presence (or not) of this setting determines which model a remote cluster uses. If present, the remote cluster uses the API key based model. Otherwise, it uses the certificate based model.
- The list of seed nodes used to sniff the remote cluster state.
The number of gateway nodes to connect to for this remote cluster. The default
- The address used for all remote connections.
The number of socket connections to open per remote cluster. The default is
An optional hostname string which is sent in the
server_namefield of the TLS Server Name Indication extension if TLS is enabled. The TLS transport will fail to open remote connections if this field is not a valid hostname as defined by the TLS SNI specification.