1
1
[[remote-clusters]]
2
2
== Remote clusters
3
3
You can connect a local cluster to other {es} clusters, known as _remote
4
- clusters_. Remote clusters can be located in different datacenters or
4
+ clusters_. Remote clusters can be located in different datacenters or
5
5
geographic regions, and contain indices or data streams that can be replicated
6
6
with {ccr} or searched by a local cluster using {ccs}.
7
7
@@ -30,9 +30,9 @@ capabilities, the local and remote cluster must be on the same
30
30
[discrete]
31
31
=== Add remote clusters
32
32
33
- NOTE: The instructions that follow describe how to create a remote connection from a
34
- self-managed cluster. You can also set up {ccs} and {ccr} from an
35
- link:https://www.elastic.co/guide/en/cloud/current/ec-enable-ccs.html[{ess} deployment]
33
+ NOTE: The instructions that follow describe how to create a remote connection from a
34
+ self-managed cluster. You can also set up {ccs} and {ccr} from an
35
+ link:https://www.elastic.co/guide/en/cloud/current/ec-enable-ccs.html[{ess} deployment]
36
36
or from an link:https://www.elastic.co/guide/en/cloud-enterprise/current/ece-enable-ccs.html[{ece} deployment].
37
37
38
38
To add remote clusters, you can choose between
@@ -52,7 +52,7 @@ controls. <<remote-clusters-api-key>>.
52
52
53
53
Certificate based security model::
54
54
Uses mutual TLS authentication for cross-cluster operations. User authentication
55
- is performed on the local cluster and a user's role names are passed to the
55
+ is performed on the local cluster and a user's role names are passed to the
56
56
remote cluster. In this model, a superuser on the local cluster gains total read
57
57
access to the remote cluster, so it is only suitable for clusters that are in
58
58
the same security domain. <<remote-clusters-cert>>.
@@ -63,15 +63,17 @@ the same security domain. <<remote-clusters-cert>>.
63
63
64
64
[[sniff-mode]]
65
65
Sniff mode::
66
- In sniff mode, a cluster is registered with a name of your choosing and a list
67
- of addresses of _seed_ nodes. When you register a remote cluster using sniff
68
- mode, {es} retrieves from one of the seed nodes the addresses of up to three
69
- _gateway nodes_. Each `remote_cluster_client` node in the local {es} cluster
70
- then opens several TCP connections to the publish addresses of the gateway
71
- nodes. This mode therefore requires that the gateway nodes' publish addresses
72
- are accessible to nodes in the local cluster.
66
+ In sniff mode, a cluster alias is registered with a name of your choosing and a
67
+ list of addresses of _seed_ nodes specified with the
68
+ `cluster.remote.<cluster_alias>.seeds` setting. When you register a remote
69
+ cluster using sniff mode, {es} retrieves from one of the seed nodes the
70
+ addresses of up to three _gateway nodes_. Each `remote_cluster_client` node in
71
+ the local {es} cluster then opens several TCP connections to the publish
72
+ addresses of the gateway nodes. This mode therefore requires that the gateway
73
+ nodes' publish addresses are accessible to nodes in the local cluster.
73
74
+
74
- Sniff mode is the default connection mode.
75
+ Sniff mode is the default connection mode. See <<remote-cluster-sniff-settings>>
76
+ for more information about configuring sniff mode.
75
77
+
76
78
[[gateway-nodes-selection]]
77
79
The _gateway nodes_ selection depends on the following criteria:
@@ -86,18 +88,23 @@ However, such nodes still have to satisfy the two above requirements.
86
88
87
89
[[proxy-mode]]
88
90
Proxy mode::
89
- In proxy mode, a cluster is registered with a name of your choosing and the
90
- address of a TCP (layer 4) reverse proxy which you must configure to route
91
- connections to the nodes of the remote cluster. When you register a remote
92
- cluster using proxy mode, {es} opens several TCP connections to the proxy
93
- address and uses these connections to communicate with the remote cluster. In
94
- proxy mode {es} disregards the publish addresses of the remote cluster nodes
95
- which means that the publish addresses of the remote cluster nodes need not be
96
- accessible to the local cluster.
91
+ In proxy mode, a cluster alias is registered with a name of your choosing and
92
+ the address of a TCP (layer 4) reverse proxy specified with the
93
+ `cluster.remote.<cluster_alias>.proxy_address` setting. You must configure this
94
+ proxy to route connections to one or more nodes of the remote cluster. When you
95
+ register a remote cluster using proxy mode, {es} opens several TCP connections
96
+ to the proxy address and uses these connections to communicate with the remote
97
+ cluster. In proxy mode {es} disregards the publish addresses of the remote
98
+ cluster nodes which means that the publish addresses of the remote cluster
99
+ nodes need not be accessible to the local cluster.
97
100
+
98
- Proxy mode is not the default connection mode, so you must configure it
99
- explicitly if desired. Proxy mode has the same <<gateway-nodes-selection,
100
- version compatibility requirements>> as sniff mode.
101
+ Proxy mode is not the default connection mode, so you must set
102
+ `cluster.remote.<cluster_alias>.mode: proxy` to use it. See
103
+ <<remote-cluster-proxy-settings>> for more information about configuring proxy
104
+ mode.
105
+ +
106
+ Proxy mode has the same <<gateway-nodes-selection, version compatibility
107
+ requirements>> as sniff mode.
101
108
102
109
include::cluster/remote-clusters-api-key.asciidoc[]
103
110
0 commit comments