github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 17:34:17 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add more cross-links about sniff/proxy modes (#112079)

Browse source 
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.
This commit is contained in:
David Turner 2024-08-22 14:13:56 +01:00 • committed by GitHub
parent f481b0722b
commit 615e084617
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 44 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/reference/modules/cluster/remote-clusters-settings.asciidoc
View file

@ -6,7 +6,10 @@ mode are described separately.
`cluster.remote.<cluster_alias>.mode`::
The mode used for a remote cluster connection. The only supported modes are
`sniff` and `proxy`.
`sniff` and `proxy`. The default is `sniff`. See <<sniff-proxy-modes>> for
further information about these modes, and <<remote-cluster-sniff-settings>>
and <<remote-cluster-proxy-settings>> for further information about their
settings.
`cluster.remote.initial_connect_timeout`::
@ -97,6 +100,11 @@ you configure the remotes.
[[remote-cluster-sniff-settings]]
==== Sniff mode remote cluster settings
To use <<sniff-mode,sniff mode>> to connect to a remote cluster, set
`cluster.remote.<cluster_alias>.mode: sniff` and then configure the following
settings. You may also leave `cluster.remote.<cluster_alias>.mode` unset since
`sniff` is the default mode.
`cluster.remote.<cluster_alias>.seeds`::
The list of seed nodes used to sniff the remote cluster state.
@ -117,6 +125,10 @@ you configure the remotes.
[[remote-cluster-proxy-settings]]
==== Proxy mode remote cluster settings
To use <<proxy-mode,proxy mode>> to connect to a remote cluster, set
`cluster.remote.<cluster_alias>.mode: proxy` and then configure the following
settings.
`cluster.remote.<cluster_alias>.proxy_address`::
The address used for all remote connections.

45
docs/reference/modules/remote-clusters.asciidoc
View file

@ -63,15 +63,17 @@ the same security domain. <<remote-clusters-cert>>.
[[sniff-mode]]
Sniff mode::
In sniff mode, a cluster is registered with a name of your choosing and a list
of addresses of _seed_ nodes. When you register a remote cluster using sniff
mode, {es} retrieves from one of the seed nodes the addresses of up to three
_gateway nodes_. Each `remote_cluster_client` node in the local {es} cluster
then opens several TCP connections to the publish addresses of the gateway
nodes. This mode therefore requires that the gateway nodes' publish addresses
are accessible to nodes in the local cluster.
In sniff mode, a cluster alias is registered with a name of your choosing and a
list of addresses of _seed_ nodes specified with the
`cluster.remote.<cluster_alias>.seeds` setting. When you register a remote
cluster using sniff mode, {es} retrieves from one of the seed nodes the
addresses of up to three _gateway nodes_. Each `remote_cluster_client` node in
the local {es} cluster then opens several TCP connections to the publish
addresses of the gateway nodes. This mode therefore requires that the gateway
nodes' publish addresses are accessible to nodes in the local cluster.
+
Sniff mode is the default connection mode.
Sniff mode is the default connection mode. See <<remote-cluster-sniff-settings>>
for more information about configuring sniff mode.
+
[[gateway-nodes-selection]]
The _gateway nodes_ selection depends on the following criteria:
@ -86,18 +88,23 @@ However, such nodes still have to satisfy the two above requirements.
[[proxy-mode]]
Proxy mode::
In proxy mode, a cluster is registered with a name of your choosing and the
address of a TCP (layer 4) reverse proxy which you must configure to route
connections to the nodes of the remote cluster. When you register a remote
cluster using proxy mode, {es} opens several TCP connections to the proxy
address and uses these connections to communicate with the remote cluster. In
proxy mode {es} disregards the publish addresses of the remote cluster nodes
which means that the publish addresses of the remote cluster nodes need not be
accessible to the local cluster.
In proxy mode, a cluster alias is registered with a name of your choosing and
the address of a TCP (layer 4) reverse proxy specified with the
`cluster.remote.<cluster_alias>.proxy_address` setting. You must configure this
proxy to route connections to one or more nodes of the remote cluster. When you
register a remote cluster using proxy mode, {es} opens several TCP connections
to the proxy address and uses these connections to communicate with the remote
cluster. In proxy mode {es} disregards the publish addresses of the remote
cluster nodes which means that the publish addresses of the remote cluster
nodes need not be accessible to the local cluster.
+
Proxy mode is not the default connection mode, so you must configure it
explicitly if desired. Proxy mode has the same <<gateway-nodes-selection,
version compatibility requirements>> as sniff mode.
Proxy mode is not the default connection mode, so you must set
`cluster.remote.<cluster_alias>.mode: proxy` to use it. See
<<remote-cluster-proxy-settings>> for more information about configuring proxy
mode.
+
Proxy mode has the same <<gateway-nodes-selection, version compatibility
requirements>> as sniff mode.
include::cluster/remote-clusters-api-key.asciidoc[]