mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
8c156ed47c
This commit introduces the forget follower API. This API is needed in cases that unfollowing a following index fails to remove the shard history retention leases on the leader index. This can happen explicitly through user action, or implicitly through an index managed by ILM. When this occurs, history will be retained longer than necessary. While the retention lease will eventually expire, it can be expensive to allow history to persist for that long, and also prevent ILM from performing actions like shrink on the leader index. As such, we introduce an API to allow for manual removal of the shard history retention leases in this case.
49 lines
1.4 KiB
Text
49 lines
1.4 KiB
Text
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ccr-apis]]
|
|
== Cross-cluster replication APIs
|
|
|
|
You can use the following APIs to perform {ccr} operations.
|
|
|
|
[float]
|
|
[[ccr-api-top-level]]
|
|
=== Top-Level
|
|
|
|
* <<ccr-get-stats,Get {ccr} stats>>
|
|
|
|
[float]
|
|
[[ccr-api-follow]]
|
|
=== Follow
|
|
|
|
* <<ccr-put-follow,Create follower index>>
|
|
* <<ccr-post-pause-follow,Pause follower>>
|
|
* <<ccr-post-resume-follow,Resume follower>>
|
|
* <<ccr-post-unfollow,Convert follower index to a regular index>>
|
|
* <<ccr-post-forget-follower,Remove follower retention leases from the leader>>
|
|
* <<ccr-get-follow-stats,Get stats about follower indices>>
|
|
* <<ccr-get-follow-info,Get info about follower indices>>
|
|
|
|
[float]
|
|
[[ccr-api-auto-follow]]
|
|
=== Auto-follow
|
|
|
|
* <<ccr-put-auto-follow-pattern,Create auto-follow pattern>>
|
|
* <<ccr-delete-auto-follow-pattern,Delete auto-follow pattern>>
|
|
* <<ccr-get-auto-follow-pattern,Get auto-follow patterns>>
|
|
|
|
// top-level
|
|
include::get-ccr-stats.asciidoc[]
|
|
|
|
// follow
|
|
include::follow/put-follow.asciidoc[]
|
|
include::follow/post-pause-follow.asciidoc[]
|
|
include::follow/post-resume-follow.asciidoc[]
|
|
include::follow/post-unfollow.asciidoc[]
|
|
include::follow/post-forget-follower.asciidoc[]
|
|
include::follow/get-follow-stats.asciidoc[]
|
|
include::follow/get-follow-info.asciidoc[]
|
|
|
|
// auto-follow
|
|
include::auto-follow/put-auto-follow-pattern.asciidoc[]
|
|
include::auto-follow/delete-auto-follow-pattern.asciidoc[]
|
|
include::auto-follow/get-auto-follow-pattern.asciidoc[]
|