Skip to content

Commit 315e539

Browse files
committed
[DOCS] Replaces CCS terms with attributes (#40076)
1 parent af5e276 commit 315e539

File tree

9 files changed

+28
-23
lines changed

9 files changed

+28
-23
lines changed

docs/reference/cluster/remote-info.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ the configured remote cluster alias.
3333

3434
`skip_unavailable`::
3535
Whether the remote cluster is skipped in case it is searched through
36-
a cross cluster search request but none of its nodes are available.
36+
a {ccs} request but none of its nodes are available.

docs/reference/glossary.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232
The {ccr} feature enables you to replicate indices in remote clusters to your
3333
local cluster. For more information, see
3434
{stack-ov}/xpack-ccr.html[{ccr-cap}].
35+
36+
[[glossary-ccs]] {ccs} (CCS)::
37+
38+
The {ccs} feature enables any node to act as a federated client across
39+
multiple clusters. See <<modules-cross-cluster-search>>.
3540

3641
[[glossary-document]] document ::
3742

docs/reference/modules.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ The modules in this section are:
7878
Remote clusters are used in features that work by connecting across clusters
7979
on the transport layer.
8080

81-
<<modules-cross-cluster-search, Cross cluster Search>>::
81+
<<modules-cross-cluster-search, {ccs-cap}>>::
8282

83-
Cross cluster search enables executing search requests across more than one cluster without joining them and acts
84-
as a federated client across them.
83+
{ccs-cap} enables executing search requests across more than one cluster
84+
without joining them and acts as a federated client across them.
8585
--
8686

8787

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
[[modules-cross-cluster-search]]
2-
== Cross Cluster Search
2+
== {ccs-cap}
33

4-
The _cross cluster search_ feature allows any node to act as a federated client across
5-
multiple clusters. A cross cluster search node won't join the remote cluster, instead
4+
The _{ccs}_ feature allows any node to act as a federated client across
5+
multiple clusters. A {ccs} node won't join the remote cluster, instead
66
it connects to a remote cluster in a light fashion in order to execute
77
federated search requests.
88

99
[float]
10-
=== Using cross cluster search
10+
=== Using {ccs}
1111

12-
Cross-cluster search requires <<modules-remote-clusters,configuring remote clusters>>.
12+
{ccs-cap} requires <<modules-remote-clusters,configuring remote clusters>>.
1313

1414
[source,js]
1515
--------------------------------
@@ -185,7 +185,7 @@ will be prefixed with their remote cluster name:
185185
[float]
186186
=== Skipping disconnected clusters
187187

188-
By default all remote clusters that are searched via Cross Cluster Search need to be available when
188+
By default all remote clusters that are searched via {ccs} need to be available when
189189
the search request is executed, otherwise the whole request fails and no search results are returned
190190
despite some of the clusters are available. Remote clusters can be made optional through the
191191
boolean `skip_unavailable` setting, set to `false` by default.
@@ -278,9 +278,9 @@ GET /cluster_one:twitter,cluster_two:twitter,twitter/_search <1>
278278

279279
[float]
280280
[[ccs-reduction]]
281-
=== CCS reduction phase
281+
=== {ccs-cap} reduction phase
282282

283-
Cross-cluster search requests can be executed in two ways:
283+
{ccs-cap} (CCS) requests can be executed in two ways:
284284

285285
- the CCS coordinating node minimizes network round-trips by sending one search
286286
request to each cluster. Each cluster performs the search independently,

docs/reference/modules/ml-node.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ node.ml: false <5>
6464
<1> Disable the `node.master` role (enabled by default).
6565
<2> Disable the `node.data` role (enabled by default).
6666
<3> The `node.ingest` role is enabled by default.
67-
<4> Disable cross-cluster search (enabled by default).
67+
<4> Disable {ccs} (enabled by default).
6868
<5> Disable the `node.ml` role (enabled by default in {xpack}).
6969

7070
To create a dedicated coordinating node when {xpack} is installed, set:
@@ -80,7 +80,7 @@ node.ml: false <5>
8080
<1> Disable the `node.master` role (enabled by default).
8181
<2> Disable the `node.data` role (enabled by default).
8282
<3> Disable the `node.ingest` role (enabled by default).
83-
<4> Disable cross-cluster search (enabled by default).
83+
<4> Disable {ccs} (enabled by default).
8484
<5> Disable the `node.ml` role (enabled by default in {xpack}).
8585

8686
[float]
@@ -111,6 +111,6 @@ xpack.ml.enabled: true <6>
111111
<1> Disable the `node.master` role (enabled by default).
112112
<2> Disable the `node.data` role (enabled by default).
113113
<3> Disable the `node.ingest` role (enabled by default).
114-
<4> Disable cross-cluster search (enabled by default).
114+
<4> Disable {ccs} (enabled by default).
115115
<5> The `node.ml` role is enabled by default in {xpack}.
116116
<6> The `xpack.ml.enabled` setting is enabled by default in {xpack}.

docs/reference/modules/node.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ cluster.remote.connect: false <4>
9898
<1> The `node.master` role is enabled by default.
9999
<2> Disable the `node.data` role (enabled by default).
100100
<3> Disable the `node.ingest` role (enabled by default).
101-
<4> Disable cross-cluster search (enabled by default).
101+
<4> Disable {ccs} (enabled by default).
102102

103103
ifdef::include-xpack[]
104104
NOTE: These settings apply only when {xpack} is not installed. To create a
@@ -129,7 +129,7 @@ cluster.remote.connect: false <4>
129129
<1> Disable the `node.master` role (enabled by default).
130130
<2> The `node.data` role is enabled by default.
131131
<3> Disable the `node.ingest` role (enabled by default).
132-
<4> Disable cross-cluster search (enabled by default).
132+
<4> Disable {ccs} (enabled by default).
133133

134134
ifdef::include-xpack[]
135135
NOTE: These settings apply only when {xpack} is not installed. To create a
@@ -157,7 +157,7 @@ cluster.remote.connect: false <4>
157157
<1> Disable the `node.master` role (enabled by default).
158158
<2> Disable the `node.data` role (enabled by default).
159159
<3> The `node.ingest` role is enabled by default.
160-
<4> Disable cross-cluster search (enabled by default).
160+
<4> Disable {ccs} (enabled by default).
161161

162162
ifdef::include-xpack[]
163163
NOTE: These settings apply only when {xpack} is not installed. To create a
@@ -197,7 +197,7 @@ cluster.remote.connect: false <4>
197197
<1> Disable the `node.master` role (enabled by default).
198198
<2> Disable the `node.data` role (enabled by default).
199199
<3> Disable the `node.ingest` role (enabled by default).
200-
<4> Disable cross-cluster search (enabled by default).
200+
<4> Disable {ccs} (enabled by default).
201201

202202
ifdef::include-xpack[]
203203
NOTE: These settings apply only when {xpack} is not installed. To create a

docs/reference/modules/remote-clusters.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
ifndef::include-xpack[]
55
The _remote clusters_ module enables you to establish uni-directional
66
connections to a remote cluster. This functionality is used in
7-
<<modules-cross-cluster-search,cross-cluster search>>.
7+
<<modules-cross-cluster-search,{ccs}>>.
88
endif::[]
99
ifdef::include-xpack[]
1010
The _remote clusters_ module enables you to establish uni-directional
1111
connections to a remote cluster. This functionality is used in
1212
{stack-ov}/xpack-ccr.html[{ccr}] and
13-
<<modules-cross-cluster-search,cross-cluster search>>.
13+
<<modules-cross-cluster-search,{ccs}>>.
1414
endif::[]
1515

1616
Remote cluster connections work by configuring a remote cluster and connecting

docs/reference/search/request-body.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ And here is a sample response:
117117

118118
Defaults to `true`. Set to `false` to disable minimizing network round-trips
119119
between the coordinating node and the remote clusters when executing
120-
cross-cluster search requests. See <<ccs-reduction>> for more.
120+
{ccs} requests. See <<ccs-reduction>> for more.
121121

122122

123123
Out of the above, the `search_type`, `request_cache` and the `allow_partial_search_results`

docs/reference/sql/concepts.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Further more, an {es} `cluster` can be connected to other ++cluster++s in a _fed
5858
single cluster::
5959
Multiple {es} instances typically distributed across machines, running within the same namespace.
6060
multiple clusters::
61-
Multiple clusters, each with its own namespace, connected to each other in a federated setup (see <<modules-cross-cluster-search, Cross cluster Search>>).
61+
Multiple clusters, each with its own namespace, connected to each other in a federated setup (see <<modules-cross-cluster-search, {ccs-cap}>>).
6262

6363
|===
6464

0 commit comments

Comments
 (0)