forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Update CCR docs to focus on Kibana (elastic#60555)
* First crack at rewriting the CCR introduction. * Emphasizing Kibana in configuring CCR (part one). * Many more edits, plus new files. * Fixing test case. * Removing overview page and consolidating that information in the main page. * Adding redirects for moved and deleted pages. * Removing, consolidating, and adding redirects. * Fixing duplicate ID in redirects and removing outdated reference. * Adding test case and steps for recreating a follower index. * Adding steps for managing CCR tasks in Kibana. * Adding tasks for managing auto-follow patterns. * Fixing glossary link. * Fixing glossary link, again. * Updating the upgrade information and other stuff. * Apply suggestions from code review * Incorporating review feedback. * Adding more edits. * Fixing link reference. * Adding use cases for elastic#59812. * Incorporating feedback from reviewers. * Apply suggestions from code review * Incorporating more review comments. * Condensing some of the steps for accessing Kibana. * Incorporating small changes from reviewers. Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
- Loading branch information
1 parent
7dce85d
commit 610a47c
Showing
24 changed files
with
876 additions
and
585 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,82 @@ | ||
[role="xpack"] | ||
[testenv="platinum"] | ||
[[ccr-auto-follow]] | ||
=== Automatically following indices | ||
|
||
In time series use cases where you want to follow new indices that are | ||
periodically created (such as daily Beats indices), manually configuring follower | ||
indices for each new leader index can be an operational burden. The auto-follow | ||
functionality in {ccr} is aimed at easing this burden. With the auto-follow | ||
functionality, you can specify that new indices in a remote cluster that have a | ||
name that matches a pattern are automatically followed. | ||
|
||
==== Managing auto-follow patterns | ||
|
||
You can add a new auto-follow pattern configuration with the | ||
{ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. When you create | ||
a new auto-follow pattern configuration, you are configuring a collection of | ||
patterns against a single remote cluster. Any time a new index with a name that | ||
matches one of the patterns in the collection is created in the remote cluster, | ||
a follower index is configured in the local cluster. The follower index uses the | ||
new index as its leader index. | ||
|
||
You can inspect all configured auto-follow pattern collections with the | ||
{ref}/ccr-get-auto-follow-pattern.html[get auto-follow pattern API]. Auto-follow patterns | ||
can be paused using the {ref}/ccr-pause-auto-follow-pattern.html[pause auto-follow pattern API] | ||
and can be resumed using the {ref}/ccr-resume-auto-follow-pattern.html[resume auto-follow pattern API]. | ||
To delete a configured auto-follow pattern collection, use the | ||
{ref}/ccr-delete-auto-follow-pattern.html[delete auto-follow pattern API]. | ||
|
||
Since auto-follow functionality is handled automatically in the background on | ||
your behalf, error reporting is done through logs on the elected master node | ||
and through the {ref}/ccr-get-stats.html[{ccr} stats API]. | ||
=== Manage auto-follow patterns | ||
To replicate time series indices, you configure an auto-follow pattern so that | ||
each new index in the series is replicated automatically. Whenever the name of | ||
a new index on the remote cluster matches the auto-follow pattern, a | ||
corresponding follower index is added to the local cluster. | ||
|
||
Auto-follow patterns are especially useful with | ||
<<index-lifecycle-management,{ilm-cap}>>, which might continually create | ||
new indices on the cluster containing the leader index. | ||
|
||
[[ccr-access-ccr-auto-follow]] | ||
To start using {ccr} auto-follow patterns, access {kib} and go to | ||
*Management > Stack Management*. In the side navigation, select | ||
*Cross-Cluster Replication* and choose the *Auto-follow patterns* tab | ||
|
||
[[ccr-auto-follow-create]] | ||
==== Create auto-follow patterns | ||
When you <<ccr-getting-started-auto-follow,create an auto-follow pattern>>, | ||
you are configuring a collection of patterns against a single remote cluster. | ||
When an index is created in the remote cluster with a name that matches one of | ||
the patterns in the collection, a follower index is configured in the local | ||
cluster. The follower index uses the new index as its leader index. | ||
|
||
[%collapsible] | ||
.Use the API | ||
==== | ||
Use the <<ccr-put-auto-follow-pattern,create auto-follow pattern API>> to add a | ||
new auto-follow pattern configuration. | ||
==== | ||
|
||
[[ccr-auto-follow-retrieve]] | ||
==== Retrieve auto-follow patterns | ||
To view existing auto-follow patterns and make changes to the backing | ||
patterns, <<ccr-access-ccr-auto-follow,access {kib}>> on your _remote_ cluster. | ||
|
||
Select the auto-follow pattern that you want to view details about. From there, | ||
you can make changes to the auto-follow pattern. You can also view your | ||
follower indices included in the auto-follow pattern. | ||
|
||
[%collapsible] | ||
.Use the API | ||
==== | ||
Use the <<ccr-get-auto-follow-pattern,get auto-follow pattern API>> to inspect | ||
all configured auto-follow pattern collections. | ||
==== | ||
|
||
[[ccr-auto-follow-pause]] | ||
==== Pause and resume auto-follow patterns | ||
To pause and resume replication of auto-follow pattern collections, | ||
<<ccr-access-ccr-auto-follow,access {kib}>>, select the auto-follow pattern, | ||
and pause replication. | ||
|
||
To resume replication, select the pattern and choose | ||
*Manage pattern > Resume replication*. | ||
|
||
[%collapsible] | ||
.Use the API | ||
==== | ||
Use the <<ccr-pause-auto-follow-pattern,pause auto-follow pattern API>> to | ||
pause auto-follow patterns. | ||
Use the <<ccr-resume-auto-follow-pattern,resume auto-follow pattern API>> to | ||
resume auto-follow patterns. | ||
==== | ||
|
||
[[ccr-auto-follow-delete]] | ||
==== Delete auto-follow patterns | ||
To delete an auto-follow pattern collection, | ||
<<ccr-access-ccr-auto-follow,access {kib}>>, select the auto-follow pattern, | ||
and pause replication. | ||
|
||
When the pattern status changes to Paused, choose | ||
*Manage pattern > Delete pattern*. | ||
|
||
[%collapsible] | ||
.Use the API | ||
==== | ||
Use the <<ccr-delete-auto-follow-pattern,delete auto-follow pattern API>> to | ||
delete a configured auto-follow pattern collection. | ||
==== |
Oops, something went wrong.