diff --git a/docs/reference/cluster/remote-info.asciidoc b/docs/reference/cluster/remote-info.asciidoc index a53a26873ce98..4d2af7b6e8f01 100644 --- a/docs/reference/cluster/remote-info.asciidoc +++ b/docs/reference/cluster/remote-info.asciidoc @@ -33,4 +33,4 @@ the configured remote cluster alias. `skip_unavailable`:: Whether the remote cluster is skipped in case it is searched through - a cross cluster search request but none of its nodes are available. + a {ccs} request but none of its nodes are available. diff --git a/docs/reference/glossary.asciidoc b/docs/reference/glossary.asciidoc index 431f9951f262c..5e58778031f06 100644 --- a/docs/reference/glossary.asciidoc +++ b/docs/reference/glossary.asciidoc @@ -32,6 +32,11 @@ The {ccr} feature enables you to replicate indices in remote clusters to your local cluster. For more information, see {stack-ov}/xpack-ccr.html[{ccr-cap}]. + +[[glossary-ccs]] {ccs} (CCS):: + + The {ccs} feature enables any node to act as a federated client across + multiple clusters. See <>. [[glossary-document]] document :: diff --git a/docs/reference/modules.asciidoc b/docs/reference/modules.asciidoc index f8b6c2784a075..5928c676b1e46 100644 --- a/docs/reference/modules.asciidoc +++ b/docs/reference/modules.asciidoc @@ -78,10 +78,10 @@ The modules in this section are: Remote clusters are used in features that work by connecting across clusters on the transport layer. -<>:: +<>:: - Cross cluster search enables executing search requests across more than one cluster without joining them and acts - as a federated client across them. + {ccs-cap} enables executing search requests across more than one cluster + without joining them and acts as a federated client across them. -- diff --git a/docs/reference/modules/cross-cluster-search.asciidoc b/docs/reference/modules/cross-cluster-search.asciidoc index 658530b372acc..803e2ba5864bc 100644 --- a/docs/reference/modules/cross-cluster-search.asciidoc +++ b/docs/reference/modules/cross-cluster-search.asciidoc @@ -1,15 +1,15 @@ [[modules-cross-cluster-search]] -== Cross Cluster Search +== {ccs-cap} -The _cross cluster search_ feature allows any node to act as a federated client across -multiple clusters. A cross cluster search node won't join the remote cluster, instead +The _{ccs}_ feature allows any node to act as a federated client across +multiple clusters. A {ccs} node won't join the remote cluster, instead it connects to a remote cluster in a light fashion in order to execute federated search requests. [float] -=== Using cross cluster search +=== Using {ccs} -Cross-cluster search requires <>. +{ccs-cap} requires <>. [source,js] -------------------------------- @@ -185,7 +185,7 @@ will be prefixed with their remote cluster name: [float] === Skipping disconnected clusters -By default all remote clusters that are searched via Cross Cluster Search need to be available when +By default all remote clusters that are searched via {ccs} need to be available when the search request is executed, otherwise the whole request fails and no search results are returned despite some of the clusters are available. Remote clusters can be made optional through the boolean `skip_unavailable` setting, set to `false` by default. @@ -278,9 +278,9 @@ GET /cluster_one:twitter,cluster_two:twitter,twitter/_search <1> [float] [[ccs-reduction]] -=== CCS reduction phase +=== {ccs-cap} reduction phase -Cross-cluster search requests can be executed in two ways: +{ccs-cap} (CCS) requests can be executed in two ways: - the CCS coordinating node minimizes network round-trips by sending one search request to each cluster. Each cluster performs the search independently, diff --git a/docs/reference/modules/ml-node.asciidoc b/docs/reference/modules/ml-node.asciidoc index 5a907adfbbf3a..365a08dfe7bb1 100644 --- a/docs/reference/modules/ml-node.asciidoc +++ b/docs/reference/modules/ml-node.asciidoc @@ -64,7 +64,7 @@ node.ml: false <5> <1> Disable the `node.master` role (enabled by default). <2> Disable the `node.data` role (enabled by default). <3> The `node.ingest` role is enabled by default. -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). <5> Disable the `node.ml` role (enabled by default in {xpack}). To create a dedicated coordinating node when {xpack} is installed, set: @@ -80,7 +80,7 @@ node.ml: false <5> <1> Disable the `node.master` role (enabled by default). <2> Disable the `node.data` role (enabled by default). <3> Disable the `node.ingest` role (enabled by default). -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). <5> Disable the `node.ml` role (enabled by default in {xpack}). [float] @@ -111,6 +111,6 @@ xpack.ml.enabled: true <6> <1> Disable the `node.master` role (enabled by default). <2> Disable the `node.data` role (enabled by default). <3> Disable the `node.ingest` role (enabled by default). -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). <5> The `node.ml` role is enabled by default in {xpack}. <6> The `xpack.ml.enabled` setting is enabled by default in {xpack}. diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index a94f76c55de1f..e9f171cce8b4a 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -98,7 +98,7 @@ cluster.remote.connect: false <4> <1> The `node.master` role is enabled by default. <2> Disable the `node.data` role (enabled by default). <3> Disable the `node.ingest` role (enabled by default). -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). ifdef::include-xpack[] NOTE: These settings apply only when {xpack} is not installed. To create a @@ -129,7 +129,7 @@ cluster.remote.connect: false <4> <1> Disable the `node.master` role (enabled by default). <2> The `node.data` role is enabled by default. <3> Disable the `node.ingest` role (enabled by default). -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). ifdef::include-xpack[] NOTE: These settings apply only when {xpack} is not installed. To create a @@ -157,7 +157,7 @@ cluster.remote.connect: false <4> <1> Disable the `node.master` role (enabled by default). <2> Disable the `node.data` role (enabled by default). <3> The `node.ingest` role is enabled by default. -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). ifdef::include-xpack[] NOTE: These settings apply only when {xpack} is not installed. To create a @@ -197,7 +197,7 @@ cluster.remote.connect: false <4> <1> Disable the `node.master` role (enabled by default). <2> Disable the `node.data` role (enabled by default). <3> Disable the `node.ingest` role (enabled by default). -<4> Disable cross-cluster search (enabled by default). +<4> Disable {ccs} (enabled by default). ifdef::include-xpack[] NOTE: These settings apply only when {xpack} is not installed. To create a diff --git a/docs/reference/modules/remote-clusters.asciidoc b/docs/reference/modules/remote-clusters.asciidoc index d31920404f03f..314d95cc79eeb 100644 --- a/docs/reference/modules/remote-clusters.asciidoc +++ b/docs/reference/modules/remote-clusters.asciidoc @@ -4,13 +4,13 @@ ifndef::include-xpack[] The _remote clusters_ module enables you to establish uni-directional connections to a remote cluster. This functionality is used in -<>. +<>. endif::[] ifdef::include-xpack[] The _remote clusters_ module enables you to establish uni-directional connections to a remote cluster. This functionality is used in {stack-ov}/xpack-ccr.html[{ccr}] and -<>. +<>. endif::[] Remote cluster connections work by configuring a remote cluster and connecting diff --git a/docs/reference/search/request-body.asciidoc b/docs/reference/search/request-body.asciidoc index 120c4c6757599..a721b3938fc8e 100644 --- a/docs/reference/search/request-body.asciidoc +++ b/docs/reference/search/request-body.asciidoc @@ -117,7 +117,7 @@ And here is a sample response: Defaults to `true`. Set to `false` to disable minimizing network round-trips between the coordinating node and the remote clusters when executing - cross-cluster search requests. See <> for more. + {ccs} requests. See <> for more. Out of the above, the `search_type`, `request_cache` and the `allow_partial_search_results` diff --git a/docs/reference/sql/concepts.asciidoc b/docs/reference/sql/concepts.asciidoc index d9b40922fbd60..49faaa9cf9b06 100644 --- a/docs/reference/sql/concepts.asciidoc +++ b/docs/reference/sql/concepts.asciidoc @@ -58,7 +58,7 @@ Further more, an {es} `cluster` can be connected to other ++cluster++s in a _fed single cluster:: Multiple {es} instances typically distributed across machines, running within the same namespace. multiple clusters:: -Multiple clusters, each with its own namespace, connected to each other in a federated setup (see <>). +Multiple clusters, each with its own namespace, connected to each other in a federated setup (see <>). |===