Skip to content

Commit a7c1321

Browse files
committed
[Docs] Indicate that CCR does not auto-follow existing indices, only newly created ones (elastic#89498)
1 parent ee1671f commit a7c1321

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@ This API creates a new named collection of
5858
<<ccr-auto-follow,auto-follow patterns>> against the remote cluster
5959
specified in the request body. Newly created indices on the remote cluster
6060
matching any of the specified patterns will be automatically configured as follower
61-
indices. Additionally, this API can be used to update existing
61+
indices. Indices on the remote cluster that were created before the auto-follow
62+
pattern is created won't be auto-followed even if they match the pattern.
63+
64+
This API can also be used to update existing
6265
<<ccr-auto-follow,auto-follow patterns>>. Note that follower indices that were configured automatically
6366
before updating an auto-follow pattern will remain unchanged even if they don't match against
6467
the new patterns.

docs/reference/ccr/getting-started.asciidoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ example, `cluster.es.eastus2.staging.azure.foundit.no:9400` or
9999
[%collapsible%open]
100100
.API example
101101
====
102-
You can also use the <<cluster-update-settings,cluster update settings API>> to
102+
You can also use the <<cluster-update-settings,cluster update settings API>> to
103103
add a remote cluster:
104104
105105
[source,console]
@@ -200,8 +200,8 @@ image::images/ccr-follower-index.png["The Cross-Cluster Replication page in {kib
200200
[%collapsible%open]
201201
.API example
202202
====
203-
You can also use the <<ccr-put-follow,create follower API>> to create follower
204-
indices. When you create a follower index, you must reference the remote cluster
203+
You can also use the <<ccr-put-follow,create follower API>> to create follower
204+
indices. When you create a follower index, you must reference the remote cluster
205205
and the leader index that you created in the remote cluster.
206206
207207
When initiating the follower request, the response returns before the
@@ -255,7 +255,9 @@ POST /server-metrics-follower/_ccr/unfollow
255255
You use <<ccr-auto-follow,auto-follow patterns>> to automatically create new
256256
followers for rolling time series indices. Whenever the name of a new index on
257257
the remote cluster matches the auto-follow pattern, a corresponding follower
258-
index is added to the local cluster.
258+
index is added to the local cluster. Note that only indices created on the
259+
remote cluster after the auto-follow pattern is created will be auto-followed:
260+
existing indices on the remote cluster are ignored even if they match the pattern.
259261

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

0 commit comments

Comments
 (0)