|
1 | 1 | [role="xpack"]
|
2 | 2 | [testenv="platinum"]
|
3 | 3 | [[ccr-ov-auto-follow]]
|
4 |
| -=== Automatically Following Indices |
| 4 | +=== Automatically following indices |
5 | 5 |
|
6 | 6 | beta[]
|
7 | 7 |
|
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 |
10 | 10 | indices for each new leader index can be an operational burden. The auto-follow
|
11 | 11 | 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. |
15 | 14 |
|
16 | 15 | ==== Managing auto-follow patterns
|
17 | 16 |
|
18 |
| -You can add a new auto-follow pattern configuration using the |
| 17 | +You can add a new auto-follow pattern configuration with the |
19 | 18 | {ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. When you create
|
20 | 19 | 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 |
24 | 23 | new index as its leader index.
|
25 | 24 |
|
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 |
29 | 28 | {ref}ccr-delete-auto-follow-pattern.html[delete auto-follow pattern API].
|
30 | 29 |
|
31 | 30 | 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 |
33 | 32 | and through the {ref}/ccr-get-stats.html[{ccr} stats API].
|
0 commit comments