Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 7 commits into from
Apr 16, 2024

Conversation

skumarp7
Copy link
Contributor

@skumarp7 skumarp7 commented Apr 8, 2024

Description

This PR involves addition of documentation for remote cluster connection modes for CCR

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

skumarp7 added 2 commits April 8, 2024 20:23
Signed-off-by: Sanjay Kumar <sanjay.kumar_p@nokia.com>
Signed-off-by: Sanjay Kumar <sanjay.kumar_p@nokia.com>
@hdhalter
Copy link
Contributor

Thanks so much for creating this PR, @skumarp7! I will start the review process.

@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress backport 2.13 PR: Backport label for 2.13 labels Apr 10, 2024
@nisgoel-amazon
Copy link

@ankitkala can you take a look

Copy link
Member

@ankitkala ankitkala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Apr 11, 2024
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc review is complete. Once the edits are reviewed and accepted, I'll move this forward to editorial review. Thank you, Melissa

skumarp7 and others added 5 commits April 15, 2024 15:10
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@skumarp7 @vagimeli Please see my changes and let me know if you have any questions. Thanks!

@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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 to the provided proxy address are opened. 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:

Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed editorial feedback. Permission to push line 172 change is blocked. Will open new PR to make that change.

@vagimeli vagimeli merged commit 7725142 into opensearch-project:main Apr 16, 2024
7 checks passed
@vagimeli vagimeli removed the 4 - Doc review PR: Doc review in progress label Apr 16, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 16, 2024
…6920)

* [Doc] Add documentation for remote cluster connection mode for CCR

Signed-off-by: Sanjay Kumar <sanjay.kumar_p@nokia.com>

* [Doc] Add documentation for remote cluster connection mode for CCR

Signed-off-by: Sanjay Kumar <sanjay.kumar_p@nokia.com>

* Update _tuning-your-cluster/replication-plugin/getting-started.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>

* Update _tuning-your-cluster/replication-plugin/getting-started.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>

* Update _tuning-your-cluster/replication-plugin/getting-started.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>

* Update _tuning-your-cluster/replication-plugin/getting-started.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>

---------

Signed-off-by: Sanjay Kumar <sanjay.kumar_p@nokia.com>
Signed-off-by: Sanjay Kumar <93825455+skumarp7@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
(cherry picked from commit 7725142)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.13 PR: Backport label for 2.13
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants