Skip to content

Commit 20c4995

Browse files
committed
[DOCS] More minor edits
1 parent 3a22d99 commit 20c4995

File tree

4 files changed

+29
-26
lines changed

4 files changed

+29
-26
lines changed
Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-ov-auto-follow]]
4-
=== Automatically Following Indices
4+
=== Automatically following indices
55

66
beta[]
77

8-
In time-series use-cases where new indices that you want to follow are
9-
periodically created (e.g., daily Beats indices), manually configuring follower
8+
In time series use cases where you want to follow new indices that are
9+
periodically created (such as daily Beats indices), manually configuring follower
1010
indices for each new leader index can be an operational burden. The auto-follow
1111
functionality in {ccr} is aimed at easing this burden. With the auto-follow
12-
functionality, you can configure that newly created indices in a remote cluster
13-
with a name that matches a pattern are automatically followed as they are
14-
created.
12+
functionality, you can specify that new indices in a remote cluster that have a
13+
name that matches a pattern are automatically followed.
1514

1615
==== Managing auto-follow patterns
1716

18-
You can add a new auto-follow pattern configuration using the
17+
You can add a new auto-follow pattern configuration with the
1918
{ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. When you create
2019
a new auto-follow pattern configuration, you are configuring a collection of
21-
patterns against a single remote cluster. Any time a new index with a name
22-
matching one of the patterns in the collection is created in the remote cluster,
23-
a follower index will be configured in the local cluster to replicate with the
20+
patterns against a single remote cluster. Any time a new index with a name that
21+
matches one of the patterns in the collection is created in the remote cluster,
22+
a follower index is configured in the local cluster. The follower index uses the
2423
new index as its leader index.
2524

26-
You can inspect all configured auto-follow pattern collections using the
27-
{ref}/ccr-get-auto-follow-pattern.html[get auto-follow pattern API], and delete a
28-
configured auto-follow pattern collection using the
25+
You can inspect all configured auto-follow pattern collections with the
26+
{ref}/ccr-get-auto-follow-pattern.html[get auto-follow pattern API]. To delete a
27+
configured auto-follow pattern collection, use the
2928
{ref}ccr-delete-auto-follow-pattern.html[delete auto-follow pattern API].
3029

3130
Since auto-follow functionality is handled automatically in the background on
32-
your behalf, error reporting is done through logs on the elected master node,
31+
your behalf, error reporting is done through logs on the elected master node
3332
and through the {ref}/ccr-get-stats.html[{ccr} stats API].

docs/reference/ccr/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ local cluster. This functionality can be used in some common production use case
1818
This guide provides an overview of {ccr}:
1919

2020
* <<ccr-overview>>
21-
* <<ccr-ov-soft-deletes>>
21+
* <<ccr-requirements>>
2222
* <<ccr-ov-auto-follow>>
2323
* <<ccr-getting-started>>
2424

docs/reference/ccr/overview.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Replication can be configured in two ways:
2929
* Automatically using
3030
<<ccr-ov-auto-follow,auto-follow patterns>>
3131

32-
NOTE: You must also <<ccr-ov-soft-deletes,configure the leader index>>.
32+
NOTE: You must also <<ccr-requirements,configure the leader index>>.
3333

3434
[float]
3535
=== The mechanics of replication
Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,44 @@
11
[role="xpack"]
22
[testenv="platinum"]
3-
[[ccr-ov-soft-deletes]]
4-
=== Requirements for Leader Indices
3+
[[ccr-requirements]]
4+
=== Requirements for leader indices
55

66
beta[]
77

88
Cross-cluster replication works by replaying the history of individual write
9-
operations performed on the shards of the leader index. This means that the
9+
operations that were performed on the shards of the leader index. This means that the
1010
history of these operations needs to be retained on the leader shards so that
1111
they can be pulled by the follower shard tasks. The underlying mechanism used to
12-
retain these operations is soft deletes. A soft delete occurs whenever an
12+
retain these operations is _soft deletes_. A soft delete occurs whenever an
1313
existing document is deleted or updated. By retaining these soft deletes up to
1414
configurable limits, the history of operations can be retained on the leader
1515
shards and made available to the follower shard tasks as it replays the history
1616
of operations.
1717

1818
Soft deletes must be enabled for indices that you want to use as leader
1919
indices. Enabling soft deletes requires the addition of some index settings at
20-
index creation time. You will need to add these settings to your create index
21-
requests, or to the index templates that you use to manage creation of new
20+
index creation time. You must add these settings to your create index
21+
requests or to the index templates that you use to manage the creation of new
2222
indices.
2323

24-
NOTE: This means that {ccr} can not be used on existing indices. If you have
24+
IMPORTANT: This means that {ccr} can not be used on existing indices. If you have
2525
existing data that you want to replicate from another cluster, you must
26-
{ref}/docs-reindex.html[reindex] your data into a new index with soft-deletes enabled.
26+
{ref}/docs-reindex.html[reindex] your data into a new index with soft deletes
27+
enabled.
2728

2829
[float]
29-
==== Soft-delete settings
30+
[[ccr-ov-soft-deletes]]
31+
==== Soft delete settings
3032

3133
`index.soft_deletes.enabled`::
3234

3335
Whether or not soft deletes are enabled on the index. Soft deletes can only be
34-
configured at index creation, and only on indices created on or after 6.5.0.
36+
configured at index creation and only on indices created on or after 6.5.0.
3537

3638
`index.soft_deletes.retention.operations`::
3739

3840
The number of soft deletes to retain. Soft deletes are collected during merges
3941
on the underlying Lucene index yet retained up to the number of operations
4042
configured by this setting.
43+
44+
For more information about index settings, see {ref}/index-modules.html[Index modules].

0 commit comments

Comments
 (0)