Skip to content

Commit 26983d1

Browse files
committed
[DOCS] Replaces CCR terms with attributes (#39516)
1 parent efd7003 commit 26983d1

File tree

8 files changed

+31
-13
lines changed

8 files changed

+31
-13
lines changed

docs/reference/ccr/apis/ccr-apis.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-apis]]
4-
== Cross-cluster replication APIs
4+
== {ccr-cap} APIs
55

66
You can use the following APIs to perform {ccr} operations.
77

docs/reference/ccr/apis/get-ccr-stats.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-get-stats]]
4-
=== Get cross-cluster replication stats API
4+
=== Get {ccr} stats API
55
++++
66
<titleabbrev>Get CCR stats</titleabbrev>
77
++++

docs/reference/ccr/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[xpack-ccr]]
4-
= Cross-cluster replication
4+
= {ccr-cap}
55

66
[partintro]
77
--

docs/reference/ccr/overview.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
[[ccr-overview]]
44
== Overview
55

6-
Cross-cluster replication is done on an index-by-index basis. Replication is
6+
7+
{ccr-cap} is done on an index-by-index basis. Replication is
78
configured at the index level. For each configured replication there is a
89
replication source index called the _leader index_ and a replication target
910
index called the _follower index_.

docs/reference/ccr/requirements.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[[ccr-requirements]]
44
=== Requirements for leader indices
55

6-
Cross-cluster replication works by replaying the history of individual write
6+
{ccr-cap} works by replaying the history of individual write
77
operations that were performed on the shards of the leader index. This means that the
88
history of these operations needs to be retained on the leader shards so that
99
they can be pulled by the follower shard tasks. The underlying mechanism used to

docs/reference/glossary.asciidoc

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@
2626
same cluster name. Each cluster has a single master node which is
2727
chosen automatically by the cluster and which can be replaced if the
2828
current master node fails.
29+
30+
[[glossary-ccr]] {ccr} (CCR)::
31+
32+
The {ccr} feature enables you to replicate indices in remote clusters to your
33+
local cluster. For more information, see
34+
{stack-ov}/xpack-ccr.html[{ccr-cap}].
2935

3036
[[glossary-document]] document ::
3137

@@ -42,12 +48,6 @@
4248
<<glossary-source_field,`_source` field>>, which is returned by default when
4349
getting or searching for a document.
4450

45-
[[glossary-id]] id ::
46-
47-
The ID of a <<glossary-document,document>> identifies a document. The
48-
`index/id` of a document must be unique. If no ID is provided,
49-
then it will be auto-generated. (also see <<glossary-routing,routing>>)
50-
5151
[[glossary-field]] field ::
5252

5353
A <<glossary-document,document>> contains a list of fields, or key-value
@@ -69,6 +69,17 @@
6969
in a <<query-filter-context,filter context>>,
7070
hence it is called a filter. Filters are simple checks for set inclusion or exclusion.
7171
In most cases, the goal of filtering is to reduce the number of documents that have to be examined.
72+
73+
[[glossary-follower-index]] follower index ::
74+
75+
Follower indices are the target indices for <<glossary-ccr,{ccr}>>. They exist
76+
in your local cluster and replicate <<glossary-leader-index,leader indices>>.
77+
78+
[[glossary-id]] id ::
79+
80+
The ID of a <<glossary-document,document>> identifies a document. The
81+
`index/id` of a document must be unique. If no ID is provided,
82+
then it will be auto-generated. (also see <<glossary-routing,routing>>)
7283

7384
[[glossary-index]] index ::
7485

@@ -79,6 +90,12 @@
7990
An index is a logical namespace which maps to one or more
8091
<<glossary-primary-shard,primary shards>> and can have zero or more
8192
<<glossary-replica-shard,replica shards>>.
93+
94+
[[glossary-leader-index]] leader index ::
95+
96+
Leader indices are the source indices for <<glossary-ccr,{ccr}>>. They exist
97+
on remote clusters and are replicated to
98+
<<glossary-follower-index,follower indices>>.
8299

83100
[[glossary-mapping]] mapping ::
84101

docs/reference/modules/remote-clusters.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ 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
12-
{stack-ov}/xpack-ccr.html[cross-cluster replication] and
12+
{stack-ov}/xpack-ccr.html[{ccr}] and
1313
<<modules-cross-cluster-search,cross-cluster search>>.
1414
endif::[]
1515

docs/reference/rest-api/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
directly to configure and access {xpack} features.
99

1010
* <<info-api,Info API>>
11-
* <<ccr-apis,Cross-cluster replication APIs>>
11+
* <<ccr-apis,{ccr-cap} APIs>>
1212
* <<graph-explore-api,Graph Explore API>>
1313
* <<freeze-index-api>>, <<unfreeze-index-api>>
1414
* <<index-lifecycle-management-api,Index lifecycle management APIs>>

0 commit comments

Comments
 (0)