Skip to content

Commit d6c08cf

Browse files
committed
[DOCS] Add 'Selecting gateway and seed nodes' section to CCS docs (#48297)
1 parent 00f17ff commit d6c08cf

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

docs/reference/modules/cross-cluster-search.asciidoc

+25-5
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,31 @@ PUT _cluster/settings
250250
If `cluster_two` is disconnected or unavailable during a {ccs}, {es} won't
251251
include matching documents from that cluster in the final results.
252252

253-
[float]
253+
[discrete]
254254
[[ccs-works]]
255255
== How {ccs} works
256+
257+
include::./remote-clusters.asciidoc[tag=how-remote-clusters-work]
258+
259+
[discrete]
260+
[[ccs-gateway-seed-nodes]]
261+
=== Selecting gateway and seed nodes
262+
263+
Gateway and seed nodes need to be accessible from the local cluster via your
264+
network.
265+
266+
By default, any master-ineligible node can act as a gateway node. If wanted,
267+
you can define the gateway nodes for a cluster by setting
268+
`cluster.remote.node.attr.gateway` to `true`.
269+
270+
For {ccs}, we recommend you use gateway nodes that are capable of serving as
271+
<<coordinating-node,coordinating nodes>> for search requests. If
272+
wanted, the seed nodes for a cluster can be a subset of these gateway nodes.
273+
274+
[discrete]
275+
[[ccs-network-delays]]
276+
=== How {ccs} handles network delays
277+
256278
Because {ccs} involves sending requests to remote clusters, any network delays
257279
can impact search speed. To avoid slow searches, {ccs} offers two options for
258280
handling network delays:
@@ -276,11 +298,9 @@ latency.
276298
+
277299
See <<ccs-unmin-roundtrips>> to learn how this option works.
278300

279-
280-
281301
[float]
282302
[[ccs-min-roundtrips]]
283-
=== Minimize network roundtrips
303+
==== Minimize network roundtrips
284304

285305
Here's how {ccs} works when you minimize network roundtrips.
286306

@@ -305,7 +325,7 @@ image:images/ccs/ccs-min-roundtrip-client-response.png[]
305325

306326
[float]
307327
[[ccs-unmin-roundtrips]]
308-
=== Don't minimize network roundtrips
328+
==== Don't minimize network roundtrips
309329

310330
Here's how {ccs} works when you don't minimize network roundtrips.
311331

docs/reference/modules/remote-clusters.asciidoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@ connections to a remote cluster. This functionality is used in
1313
<<modules-cross-cluster-search,{ccs}>>.
1414
endif::[]
1515

16+
// tag::how-remote-clusters-work[]
1617
Remote cluster connections work by configuring a remote cluster and connecting
1718
only to a limited number of nodes in that remote cluster. Each remote cluster
1819
is referenced by a name and a list of seed nodes. When a remote cluster is
1920
registered, its cluster state is retrieved from one of the seed nodes and up
2021
to three _gateway nodes_ are selected to be connected to as part of remote
21-
cluster requests. All the communication required between different clusters
22+
cluster requests.
23+
// end::how-remote-clusters-work[]
24+
25+
All the communication required between different clusters
2226
goes through the <<modules-transport,transport layer>>. Remote cluster
2327
connections consist of uni-directional connections from the coordinating
2428
node to the selected remote _gateway nodes_ only.

0 commit comments

Comments
 (0)