diff --git a/docs/reference/ccr/apis/ccr-apis.asciidoc b/docs/reference/ccr/apis/ccr-apis.asciidoc index 3a745f23986..b737167ce31 100644 --- a/docs/reference/ccr/apis/ccr-apis.asciidoc +++ b/docs/reference/ccr/apis/ccr-apis.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="platinum"] [[ccr-apis]] -== Cross-cluster replication APIs +== {ccr-cap} APIs You can use the following APIs to perform {ccr} operations. diff --git a/docs/reference/ccr/apis/get-ccr-stats.asciidoc b/docs/reference/ccr/apis/get-ccr-stats.asciidoc index 5f1844f167b..03f2f3eee0c 100644 --- a/docs/reference/ccr/apis/get-ccr-stats.asciidoc +++ b/docs/reference/ccr/apis/get-ccr-stats.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="platinum"] [[ccr-get-stats]] -=== Get cross-cluster replication stats API +=== Get {ccr} stats API ++++ Get CCR stats ++++ diff --git a/docs/reference/ccr/index.asciidoc b/docs/reference/ccr/index.asciidoc index 48cba8259c1..4e38806feb4 100644 --- a/docs/reference/ccr/index.asciidoc +++ b/docs/reference/ccr/index.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="platinum"] [[xpack-ccr]] -= Cross-cluster replication += {ccr-cap} [partintro] -- diff --git a/docs/reference/ccr/overview.asciidoc b/docs/reference/ccr/overview.asciidoc index 98083507e83..4457c0a6f74 100644 --- a/docs/reference/ccr/overview.asciidoc +++ b/docs/reference/ccr/overview.asciidoc @@ -3,7 +3,8 @@ [[ccr-overview]] == Overview -Cross-cluster replication is done on an index-by-index basis. Replication is + +{ccr-cap} is done on an index-by-index basis. Replication is configured at the index level. For each configured replication there is a replication source index called the _leader index_ and a replication target index called the _follower index_. diff --git a/docs/reference/ccr/requirements.asciidoc b/docs/reference/ccr/requirements.asciidoc index f759dfaef02..7b24385e63c 100644 --- a/docs/reference/ccr/requirements.asciidoc +++ b/docs/reference/ccr/requirements.asciidoc @@ -3,7 +3,7 @@ [[ccr-requirements]] === Requirements for leader indices -Cross-cluster replication works by replaying the history of individual write +{ccr-cap} works by replaying the history of individual write operations that were performed on the shards of the leader index. This means that the history of these operations needs to be retained on the leader shards so that they can be pulled by the follower shard tasks. The underlying mechanism used to diff --git a/docs/reference/glossary.asciidoc b/docs/reference/glossary.asciidoc index c6b9309fa32..431f9951f26 100644 --- a/docs/reference/glossary.asciidoc +++ b/docs/reference/glossary.asciidoc @@ -26,6 +26,12 @@ same cluster name. Each cluster has a single master node which is chosen automatically by the cluster and which can be replaced if the current master node fails. + +[[glossary-ccr]] {ccr} (CCR):: + + 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-document]] document :: @@ -42,12 +48,6 @@ <>, which is returned by default when getting or searching for a document. -[[glossary-id]] id :: - - The ID of a <> identifies a document. The - `index/id` of a document must be unique. If no ID is provided, - then it will be auto-generated. (also see <>) - [[glossary-field]] field :: A <> contains a list of fields, or key-value @@ -69,6 +69,17 @@ in a <>, hence it is called a filter. Filters are simple checks for set inclusion or exclusion. In most cases, the goal of filtering is to reduce the number of documents that have to be examined. + +[[glossary-follower-index]] follower index :: + + Follower indices are the target indices for <>. They exist + in your local cluster and replicate <>. + +[[glossary-id]] id :: + + The ID of a <> identifies a document. The + `index/id` of a document must be unique. If no ID is provided, + then it will be auto-generated. (also see <>) [[glossary-index]] index :: @@ -79,6 +90,12 @@ An index is a logical namespace which maps to one or more <> and can have zero or more <>. + +[[glossary-leader-index]] leader index :: + + Leader indices are the source indices for <>. They exist + on remote clusters and are replicated to + <>. [[glossary-mapping]] mapping :: diff --git a/docs/reference/modules/remote-clusters.asciidoc b/docs/reference/modules/remote-clusters.asciidoc index 9de8c8ec963..d31920404f0 100644 --- a/docs/reference/modules/remote-clusters.asciidoc +++ b/docs/reference/modules/remote-clusters.asciidoc @@ -9,7 +9,7 @@ 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[cross-cluster replication] and +{stack-ov}/xpack-ccr.html[{ccr}] and <>. endif::[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index e834249724a..c33397f7c14 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -8,7 +8,7 @@ directly to configure and access {xpack} features. * <> -* <> +* <> * <> * <>, <> * <>