Skip to content

Commit

Permalink
[Docs] Indicate that CCR does not auto-follow existing indices, only …
Browse files Browse the repository at this point in the history
…newly created ones (#89498) (#89829)
  • Loading branch information
tlrx authored Sep 6, 2022
1 parent b19c2d7 commit 07c28bb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,10 @@ This API creates a new named collection of
<<ccr-auto-follow,auto-follow patterns>> against the remote cluster
specified in the request body. Newly created indices on the remote cluster
matching any of the specified patterns will be automatically configured as follower
indices. Additionally, this API can be used to update existing
indices. Indices on the remote cluster that were created before the auto-follow
pattern is created won't be auto-followed even if they match the pattern.

This API can also be used to update existing
<<ccr-auto-follow,auto-follow patterns>>. Note that follower indices that were configured automatically
before updating an auto-follow pattern will remain unchanged even if they don't match against
the new patterns.
Expand Down
10 changes: 6 additions & 4 deletions docs/reference/ccr/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ example, `cluster.es.eastus2.staging.azure.foundit.no:9400` or
[%collapsible%open]
.API example
====
You can also use the <<cluster-update-settings,cluster update settings API>> to
You can also use the <<cluster-update-settings,cluster update settings API>> to
add a remote cluster:
[source,console]
Expand Down Expand Up @@ -192,8 +192,8 @@ image::images/ccr-follower-index.png["The Cross-Cluster Replication page in {kib
[%collapsible%open]
.API example
====
You can also use the <<ccr-put-follow,create follower API>> to create follower
indices. When you create a follower index, you must reference the remote cluster
You can also use the <<ccr-put-follow,create follower API>> to create follower
indices. When you create a follower index, you must reference the remote cluster
and the leader index that you created in the remote cluster.
When initiating the follower request, the response returns before the
Expand Down Expand Up @@ -247,7 +247,9 @@ POST /server-metrics-follower/_ccr/unfollow
You use <<ccr-auto-follow,auto-follow patterns>> to automatically create new
followers for rolling time series indices. 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.
index is added to the local cluster. Note that only indices created on the
remote cluster after the auto-follow pattern is created will be auto-followed:
existing indices on the remote cluster are ignored even if they match the pattern.

An auto-follow pattern specifies the remote cluster you want to replicate from,
and one or more index patterns that specify the rolling time series indices you
Expand Down

0 comments on commit 07c28bb

Please sign in to comment.