[Doc] Add documentation for remote cluster connection mode for CCR (#…

…6920) * [Doc] Add documentation for remote cluster connection mode for CCR Signed-off-by: Sanjay Kumar <[email protected]> * [Doc] Add documentation for remote cluster connection mode for CCR Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Sanjay Kumar <[email protected]> * Update _tuning-your-cluster/replication-plugin/getting-started.md Co-authored-by: Melissa Vagi <[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: Melissa Vagi <[email protected]>
opensearch-project · Apr 16, 2024 · 7725142 · 7725142
1 parent 9a6bb8a
commit 7725142
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/_tuning-your-cluster/replication-plugin/getting-started.md b/_tuning-your-cluster/replication-plugin/getting-started.md
@@ -145,6 +145,12 @@ docker inspect --format='{% raw %}{{range .NetworkSettings.Networks}}{{.IPAddres
 
 Cross-cluster replication follows a "pull" model, so most changes occur on the follower cluster, not the leader cluster. 
 
+### Connection modes to a remote cluster
+
+The connection modes include _sniff mode_ and _proxy mode_.
+
+In sniff mode, the follower cluster establishes a remote connection to the leader cluster by specifying a name and a list of seed nodes from the leader cluster. During the connection setup, the follower cluster retrieves the leader cluster's state from one of the provided seed nodes. This mode requires that the publish addresses of the seed nodes in the leader cluster are accessible from the follower cluster. Sniff mode is the default connection mode.
+
 On the follower cluster, add the IP address (with port 9300) for each seed node. Because this is a single-node cluster, you only have one seed node. Provide a descriptive name for the connection, which you'll use in the request to start replication:
 
 ```bash
@@ -162,6 +168,25 @@ curl -XPUT -k -H 'Content-Type: application/json' -u 'admin:<custom-admin-passwo
 }'
 ```
 
+
+In proxy mode, the follower cluster establishes a remote connection to the leader cluster by specifying a name and a single proxy address. During the connection setup, a configurable number of socket connections are opened to the provided proxy address. The proxy's responsibility is to direct these connections to the appropriate nodes in the leader cluster. Unlike other connection modes, proxy mode does not require the nodes in the leader cluster to have publicly accessible publish addresses. 
+
+```bash
+curl -XPUT -k -H 'Content-Type: application/json' -u 'admin:<custom-admin-password>' 'https://localhost:9200/_cluster/settings?pretty' -d '
+{
+  "persistent": {
+    "cluster": {
+      "remote": {
+        "my-connection-alias": {
+          "mode": "proxy"
+          "proxy_address": "172.22.0.3:9300"
+        }
+      }
+    }
+  }
+}'
+```
+
 ## Start replication
 
 To get started, create an index called `leader-01` on the leader cluster: