Skip to content

Commit 918fa01

Browse files
authored
Add more cross-links about sniff/proxy modes (#112079) (#112101)
The info about remote cluster connection modes is a little disjointed. This commit adds some cross-links between the sections to help users find more relevant information.
1 parent 8ae4d7e commit 918fa01

File tree

2 files changed

+44
-25
lines changed

2 files changed

+44
-25
lines changed

docs/reference/modules/cluster/remote-clusters-settings.asciidoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ mode are described separately.
66

77
`cluster.remote.<cluster_alias>.mode`::
88
The mode used for a remote cluster connection. The only supported modes are
9-
`sniff` and `proxy`.
9+
`sniff` and `proxy`. The default is `sniff`. See <<sniff-proxy-modes>> for
10+
further information about these modes, and <<remote-cluster-sniff-settings>>
11+
and <<remote-cluster-proxy-settings>> for further information about their
12+
settings.
1013

1114
`cluster.remote.initial_connect_timeout`::
1215

@@ -97,6 +100,11 @@ you configure the remotes.
97100
[[remote-cluster-sniff-settings]]
98101
==== Sniff mode remote cluster settings
99102

103+
To use <<sniff-mode,sniff mode>> to connect to a remote cluster, set
104+
`cluster.remote.<cluster_alias>.mode: sniff` and then configure the following
105+
settings. You may also leave `cluster.remote.<cluster_alias>.mode` unset since
106+
`sniff` is the default mode.
107+
100108
`cluster.remote.<cluster_alias>.seeds`::
101109

102110
The list of seed nodes used to sniff the remote cluster state.
@@ -117,6 +125,10 @@ you configure the remotes.
117125
[[remote-cluster-proxy-settings]]
118126
==== Proxy mode remote cluster settings
119127

128+
To use <<proxy-mode,proxy mode>> to connect to a remote cluster, set
129+
`cluster.remote.<cluster_alias>.mode: proxy` and then configure the following
130+
settings.
131+
120132
`cluster.remote.<cluster_alias>.proxy_address`::
121133

122134
The address used for all remote connections.

docs/reference/modules/remote-clusters.asciidoc

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[remote-clusters]]
22
== Remote clusters
33
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
55
geographic regions, and contain indices or data streams that can be replicated
66
with {ccr} or searched by a local cluster using {ccs}.
77

@@ -30,9 +30,9 @@ capabilities, the local and remote cluster must be on the same
3030
[discrete]
3131
=== Add remote clusters
3232

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]
3636
or from an link:https://www.elastic.co/guide/en/cloud-enterprise/current/ece-enable-ccs.html[{ece} deployment].
3737

3838
To add remote clusters, you can choose between
@@ -52,7 +52,7 @@ controls. <<remote-clusters-api-key>>.
5252

5353
Certificate based security model::
5454
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
5656
remote cluster. In this model, a superuser on the local cluster gains total read
5757
access to the remote cluster, so it is only suitable for clusters that are in
5858
the same security domain. <<remote-clusters-cert>>.
@@ -63,15 +63,17 @@ the same security domain. <<remote-clusters-cert>>.
6363

6464
[[sniff-mode]]
6565
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.
7374
+
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.
7577
+
7678
[[gateway-nodes-selection]]
7779
The _gateway nodes_ selection depends on the following criteria:
@@ -86,18 +88,23 @@ However, such nodes still have to satisfy the two above requirements.
8688

8789
[[proxy-mode]]
8890
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.
97100
+
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.
101108

102109
include::cluster/remote-clusters-api-key.asciidoc[]
103110

0 commit comments

Comments
 (0)