Skip to content

Commit 0c39a76

Browse files
aggarwalShivanibowenlan-amznkolchfa-aws
authored
Adding stop_replication action to ism documentation (#9371)
* Adding stop_replication action to ism documentation Signed-off-by: aggarwalShivani <[email protected]> * Apply suggestions from code review Co-authored-by: bowenlan-amzn <[email protected]> Signed-off-by: aggarwalShivani <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: aggarwalShivani <[email protected]> --------- Signed-off-by: aggarwalShivani <[email protected]> Signed-off-by: aggarwalShivani <[email protected]> Co-authored-by: bowenlan-amzn <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
1 parent ba08b52 commit 0c39a76

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

_im-plugin/ism/policies.md

+16
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ ISM supports the following operations:
112112
- [index_priority](#index_priority)
113113
- [allocation](#allocation)
114114
- [rollup](#rollup)
115+
- [stop_replication](#stop_replication)
115116

116117
### force_merge
117118

@@ -485,6 +486,21 @@ Parameter | Description | Type | Required
485486
Rollup jobs can be continuous or non-continuous. A rollup job created using an ISM policy can only be non-continuous.
486487
{: .note }
487488

489+
### stop_replication
490+
491+
Stops replication and converts the follower index to a regular index.
492+
493+
```json
494+
{
495+
"stop_replication": {}
496+
}
497+
```
498+
499+
When cross-cluster replication is enabled, the follower index becomes read-only, preventing all write operations. To manage replicated indexes on a follower cluster, you can perform the `stop_replication` action before performing other write operations. For example, you can define a policy that first runs `stop_replication` and then deletes the index by running a `delete` action.
500+
501+
If security is enabled, in addition to [stop replication permissions]({{site.url}}{{site.baseurl}}/tuning-your-cluster/replication-plugin/permissions/#replication-permissions), you must have the `indices:internal/plugins/replication/index/stop` permission in order to use the `stop_replication` action.
502+
{: .note}
503+
488504
#### Endpoints
489505

490506
````bash

0 commit comments

Comments
 (0)