From 55271d6c0b3b06c194229476bb59fa670576bc68 Mon Sep 17 00:00:00 2001 From: Liz Snyder Date: Thu, 9 Dec 2021 09:57:06 -0800 Subject: [PATCH] Clarify stop autofollow behavior Signed-off-by: Liz Snyder --- _replication-plugin/api.md | 2 +- _replication-plugin/auto-follow.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/_replication-plugin/api.md b/_replication-plugin/api.md index df4a34b3..3247b78a 100644 --- a/_replication-plugin/api.md +++ b/_replication-plugin/api.md @@ -361,7 +361,7 @@ Options | Description | Type | Required Introduced 1.1 {: .label .label-purple } -Deletes the specified replication rule. This operation prevents any new indices from being replicated but does not stop existing replication that the rule has already initiated. +Deletes the specified replication rule. This operation prevents any new indices from being replicated but does not stop existing replication that the rule has already initiated. Replicated indices remain read-only until you stop replication. Send this request to the follower cluster. diff --git a/_replication-plugin/auto-follow.md b/_replication-plugin/auto-follow.md index 0098d4e4..f2c7367b 100644 --- a/_replication-plugin/auto-follow.md +++ b/_replication-plugin/auto-follow.md @@ -92,7 +92,7 @@ curl -XGET -u 'admin:admin' -k 'https://localhost:9200/_plugins/_replication/aut ## Delete a replication rule -When you delete a replication rule, OpenSearch stops replicating *new* indices that match the pattern, but existing indices that the rule previously created continue to replicate. If you need to stop existing replication activity, use the [stop replication API operation]({{site.url}}{{site.baseurl}}/replication-plugin/api/#stop-replication). +To delete a replication rule, send the following request: ```bash curl -XDELETE -k -H 'Content-Type: application/json' -u 'admin:admin' 'https://localhost:9200/_plugins/_replication/_autofollow?pretty' -d ' @@ -102,3 +102,5 @@ curl -XDELETE -k -H 'Content-Type: application/json' -u 'admin:admin' 'https://l }' ``` +OpenSearch stops replicating *new* indices that match the pattern, but existing indices that the rule previously created remain read-only and continue to replicate. If you need to stop existing replication activity and open the indices up for writes, use the [stop replication API operation]({{site.url}}{{site.baseurl}}/replication-plugin/api/#stop-replication). +