mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-05 20:48:22 +00:00
af887be3e5
CCR follower stats can return information for persistent tasks that are in the process of being cleaned up. This is problematic for tests where CCR follower indices have been deleted, but their persistent follower task is only cleaned up asynchronously afterwards. If one of the following tests then accesses the follower stats, it might still get the stats for that follower task. In addition, some tests were not cleaning up their auto-follow patterns, leaving orphaned patterns behind. Other tests cleaned up their auto-follow patterns. As always the same name was used, it just depended on the test execution order whether this led to a failure or not. This commit fixes the offensive tests, and will also automatically remove auto-follow-patterns at the end of tests, like we do for many other features. Closes #48700
89 lines
2.7 KiB
Plaintext
89 lines
2.7 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ccr-pause-auto-follow-pattern]]
|
|
=== Pause auto-follow pattern API
|
|
++++
|
|
<titleabbrev>Pause auto-follow pattern</titleabbrev>
|
|
++++
|
|
|
|
Pauses an auto-follow pattern.
|
|
|
|
[[ccr-pause-auto-follow-pattern-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause`
|
|
|
|
[[ccr-pause-auto-follow-pattern-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
|
|
privileges on the cluster that contains the follower index. For more information,
|
|
see <<security-privileges>>.
|
|
|
|
[[ccr-pause-auto-follow-pattern-desc]]
|
|
==== {api-description-title}
|
|
|
|
This API pauses an <<ccr-auto-follow,auto-follow pattern>>. When this API returns, the auto-follow pattern
|
|
is inactive and ignores any new index created on the remote cluster that matches any of
|
|
the auto-follow's patterns. Paused auto-follow patterns appear with the `active` field
|
|
set to `false` in the <<ccr-get-auto-follow-pattern, GET auto-follow patterns API>>.
|
|
|
|
You can resume auto-following with the <<ccr-resume-auto-follow-pattern,resume auto-follow pattern API>>.
|
|
Once resumed, the auto-follow pattern is active again and automatically configure
|
|
follower indices for newly created indices on the remote cluster that match its patterns.
|
|
Remote indices created while the
|
|
pattern was paused will also be followed, unless they have been deleted or closed in the
|
|
meantime.
|
|
|
|
[[ccr-pause-auto-follow-pattern-path-parms]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<auto_follow_pattern_name>`::
|
|
(Required, string) Name of the auto-follow pattern to pause.
|
|
|
|
|
|
[[ccr-pause-auto-follow-pattern-examples]]
|
|
==== {api-examples-title}
|
|
|
|
This example pauses an auto-follow pattern named `my_auto_follow_pattern`:
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT /_ccr/auto_follow/my_auto_follow_pattern
|
|
{
|
|
"remote_cluster" : "remote_cluster",
|
|
"leader_index_patterns" :
|
|
[
|
|
"leader_index"
|
|
],
|
|
"follow_index_pattern" : "{{leader_index}}-follower"
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[setup:remote_cluster]
|
|
// TESTSETUP
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE /_ccr/auto_follow/my_auto_follow_pattern
|
|
--------------------------------------------------
|
|
// TEST
|
|
// TEARDOWN
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_ccr/auto_follow/my_auto_follow_pattern/pause
|
|
--------------------------------------------------
|
|
// TEST
|
|
|
|
The API returns the following result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
--------------------------------------------------
|