Remote clusters
editRemote clusters
editThe remote clusters module enables you to establish uni-directional connections to a remote cluster. This functionality is used in cross-cluster replication and cross-cluster search.
Remote cluster connections work by configuring a remote cluster and connecting only to a limited number of nodes in the remote cluster. Each remote cluster is referenced by a name and a list of seed nodes. When a remote cluster is registered, its cluster state is retrieved from one of the seed nodes so that by default up to three gateway nodes are selected to be connected to as part of remote cluster requests. Remote cluster connections consist of uni-directional connections from the coordinating node to the previously selected remote nodes only. It is possible to tag which nodes should be selected through node attributes (see Remote cluster settings).
Each node in a cluster that has remote clusters configured connects to one or more gateway nodes and uses them to federate requests to the remote cluster.
Configuring Remote Clusters
editRemote clusters can be specified globally using
cluster settings (which can be updated dynamically),
or local to individual nodes using the elasticsearch.yml
file.
If a remote cluster is configured via elasticsearch.yml
only the nodes with
that configuration will be able to connect to the remote cluster. In other
words, functionality that relies on remote cluster requests will have to be
driven specifically from those nodes. Remote clusters set via the
cluster settings API will be available on every node
in the cluster.
The elasticsearch.yml
config file for a node that connects to remote clusters
needs to list the remote clusters that should be connected to, for instance:
|
The equivalent example using the cluster settings API to add remote clusters to all nodes in the cluster would look like the following:
PUT _cluster/settings { "persistent": { "cluster": { "remote": { "cluster_one": { "seeds": [ "127.0.0.1:9300" ] }, "cluster_two": { "seeds": [ "127.0.0.1:9301" ] }, "cluster_three": { "seeds": [ "127.0.0.1:9302" ] } } } } }
A remote cluster can be deleted from the cluster settings by setting its seeds
to null
:
PUT _cluster/settings { "persistent": { "cluster": { "remote": { "cluster_three": { "seeds": null } } } } }
|
Remote cluster settings
edit-
cluster.remote.connections_per_cluster
-
The number of gateway nodes to connect to per remote cluster. The default is
3
. -
cluster.remote.initial_connect_timeout
-
The time to wait for remote connections to be established when the node
starts. The default is
30s
. -
cluster.remote.node.attr
-
A node attribute to filter out nodes that are eligible as a gateway node in
the remote cluster. For instance a node can have a node attribute
node.attr.gateway: true
such that only nodes with this attribute will be connected to ifcluster.remote.node.attr
is set togateway
. -
cluster.remote.connect
-
By default, any node in the cluster can act as a cross-cluster client and
connect to remote clusters. The
cluster.remote.connect
setting can be set tofalse
(defaults totrue
) to prevent certain nodes from connecting to remote clusters. Remote cluster requests must be sent to a node that is allowed to act as a cross-cluster client. -
cluster.remote.${cluster_alias}.skip_unavailable
-
Per cluster boolean setting that allows to skip specific clusters when no
nodes belonging to them are available and they are the targetof 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 totrue
. -
cluster.remote.${cluster_alias}.transport.ping_schedule
-
Sets the time interval between regular application-level ping messages that
are sent to ensure that transport connections to nodes belonging to remote
clusters are kept 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 globaltransport.ping_schedule
setting, which defaults to ``-1` meaning that pings are not sent.
Retrieving remote clusters info
editThe Remote Cluster Info API allows to retrieve information about the configured remote clusters, as well as the remote nodes that the node is connected to.