Skip to content

Commit de8261f

Browse files
authored
[6.8][DOCS] Add CCR docs to the Elasticsearch Reference Guide (#45704) (#49952)
1 parent 9a1bde2 commit de8261f

File tree

7 files changed

+45
-13
lines changed

7 files changed

+45
-13
lines changed

docs/reference/ccr/auto-follow.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-auto-follow]]
4-
=== Automatically following indices
4+
== Automatically following indices
55

66
In time series use cases where you want to follow new indices that are
77
periodically created (such as daily Beats indices), manually configuring follower
@@ -10,7 +10,7 @@ functionality in {ccr} is aimed at easing this burden. With the auto-follow
1010
functionality, you can specify that new indices in a remote cluster that have a
1111
name that matches a pattern are automatically followed.
1212

13-
==== Managing auto-follow patterns
13+
=== Managing auto-follow patterns
1414

1515
You can add a new auto-follow pattern configuration with the
1616
{ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. When you create

docs/reference/ccr/getting-started.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This getting-started guide for {ccr} shows you how to:
2020

2121
. Obtain a license that includes the {ccr} features. See
2222
https://www.elastic.co/subscriptions[subscriptions] and
23-
<<license-management>>.
23+
{stack-ov}/license-management.html[License-management].
2424

2525
. If the Elastic {security-features} are enabled in your local and remote
2626
clusters, you need a user that has appropriate authority to perform the steps
@@ -34,7 +34,7 @@ to control which users have authority to manage {ccr}.
3434
By default, you can perform all of the steps in this tutorial by
3535
using the built-in `elastic` user. However, a password must be set for this user
3636
before the user can do anything. For information about how to set that password,
37-
see <<security-getting-started>>.
37+
see {stack-ov}/security-getting-started.html[Tutorial: Getting started with security].
3838

3939
If you are performing these steps in a production environment, take extra care
4040
because the `elastic` user has the `superuser` role and you could inadvertently

docs/reference/ccr/index.asciidoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
[[xpack-ccr]]
44
= {ccr-cap}
55

6-
[partintro]
7-
--
8-
96
The {ccr} (CCR) feature enables replication of indices in remote clusters to a
107
local cluster. This functionality can be used in some common production use
118
cases:
@@ -22,7 +19,6 @@ This guide provides an overview of {ccr}:
2219
* <<ccr-getting-started>>
2320
* <<ccr-upgrading>>
2421

25-
--
2622

2723
include::overview.asciidoc[]
2824
include::requirements.asciidoc[]

docs/reference/ccr/requirements.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-requirements]]
4-
=== Requirements for leader indices
4+
== Requirements for leader indices
55

66
{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
@@ -26,7 +26,7 @@ enabled.
2626

2727
[float]
2828
[[ccr-overview-soft-deletes]]
29-
==== Soft delete settings
29+
=== Soft delete settings
3030

3131
`index.soft_deletes.enabled`::
3232

@@ -46,7 +46,7 @@ For more information about index settings, see {ref}/index-modules.html[Index mo
4646

4747
[float]
4848
[[ccr-overview-beats]]
49-
==== Setting soft deletes on indices created by APM Server or Beats
49+
=== Setting soft deletes on indices created by APM Server or Beats
5050

5151
If you want to replicate indices created by APM Server or Beats, and are
5252
allowing APM Server or Beats to manage index templates, you need to enable
@@ -68,7 +68,7 @@ index template.
6868

6969
[float]
7070
[[ccr-overview-logstash]]
71-
==== Setting soft deletes on indices created by Logstash
71+
=== Setting soft deletes on indices created by Logstash
7272

7373
If you want to replicate indices created by Logstash, and are using Logstash to
7474
manage index templates, you need to configure soft deletes on a custom Logstash
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[[high-availability]]
2+
= Set up a cluster for high availability
3+
4+
[partintro]
5+
--
6+
As with any software that stores data,
7+
it is important to routinely back up your data.
8+
{es}'s <<glossary-replica-shard,replica shards>> provide high availability
9+
during runtime;
10+
they enable you to tolerate sporadic node loss
11+
without an interruption of service.
12+
13+
However, replica shards do not protect an {es} cluster
14+
from catastrophic failure.
15+
You need a backup of your cluster—
16+
a copy in case something goes wrong.
17+
18+
19+
{es} offers two features to support high availability for a cluster:
20+
21+
* <<modules-snapshots,Snapshot and restore>>,
22+
which you can use to back up individual indices or entire clusters.
23+
You can automatically store these backups in a repository on a shared filesystem.
24+
25+
* <<xpack-ccr,Cross-cluster replication (CCR)>>,
26+
which you can use to copy indices in remote clusters to a local cluster.
27+
You can use {ccr} to recover from the failure of a primary cluster
28+
or serve data locally based on geo-proximity.
29+
--
30+
31+
:leveloffset: +1
32+
include::ccr/index.asciidoc[]
33+
:leveloffset: -1

docs/reference/index.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ include::rollup/index.asciidoc[]
6666

6767
include::frozen-indices.asciidoc[]
6868

69-
include::rest-api/index.asciidoc[]
69+
include::high-availability.asciidoc[]
7070

7171
include::{xes-repo-dir}/security/index.asciidoc[]
7272

@@ -80,6 +80,8 @@ include::testing.asciidoc[]
8080

8181
include::glossary.asciidoc[]
8282

83+
include::rest-api/index.asciidoc[]
84+
8385
include::release-notes/highlights.asciidoc[]
8486

8587
include::migration/index.asciidoc[]

docs/reference/redirects.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -603,3 +603,4 @@ See <<monitoring-overview>>.
603603
=== Monitoring {es}
604604

605605
See <<monitor-elasticsearch-cluster>>.
606+

0 commit comments

Comments
 (0)