[Doc] Add documentation for .replication-metadata-index for cross-clu…

…ster-replication. (#6082) * [Doc] Add documentation for .replication-metadata-index for cross-cluster-replication. Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> --------- Signed-off-by: Sanjay Kumar <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Jan 16, 2024 · 63afd67 · 63afd67
1 parent 28189d0
commit 63afd67
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/_tuning-your-cluster/replication-plugin/getting-started.md b/_tuning-your-cluster/replication-plugin/getting-started.md
@@ -237,6 +237,14 @@ curl -XGET -k -u 'admin:admin' 'https://localhost:9200/follower-01/_search?prett
   }]
 }
 ```
+### `.replication-metadata-store` index
+
+The `.replication-metadata-store` index is a persistent data store for replication-related metadata and auto-follow rules inside of a cluster. It stores the replication metadata of each index being replicated from the leader cluster to the follower cluster.
+
+After the first replication API trigger, the `.replication-metadata-store` index is created inside the follower cluster. Any updates or additions to replication jobs or rules are also updated in the index. This enables the plugin to maintain a comprehensive record of replication status and rules across clusters.
+
+ `.replication-metdata-store` is a hidden index.
+ {: .note}
 
 ## Pause and resume replication