Skip to content

Commit f7d180d

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

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

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

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,31 @@ PUT _cluster/settings
246246
If `cluster_two` is disconnected or unavailable during a {ccs}, {es} won't
247247
include matching documents from that cluster in the final results.
248248

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

275-
276-
277297
[float]
278298
[[ccs-min-roundtrips]]
279-
=== Minimize network roundtrips
299+
==== Minimize network roundtrips
280300

281301
Here's how {ccs} works when you minimize network roundtrips.
282302

@@ -301,7 +321,7 @@ image:images/ccs/ccs-min-roundtrip-client-response.png[]
301321

302322
[float]
303323
[[ccs-unmin-roundtrips]]
304-
=== Don't minimize network roundtrips
324+
==== Don't minimize network roundtrips
305325

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

docs/reference/modules/remote-clusters.asciidoc

Lines changed: 5 additions & 1 deletion
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)