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

Add cluster awareness and decommission docs #2438

Merged
merged 30 commits into from
Jan 23, 2023
Merged

Add cluster awareness and decommission docs #2438

merged 30 commits into from
Jan 23, 2023

Conversation

Naarcha-AWS
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS commented Jan 19, 2023

Signed-off-by: Naarcha-AWS naarcha@amazon.com

Description

Fixes #1811 and #1812

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
@Naarcha-AWS Naarcha-AWS added the v2.5.0 'Issues and PRs related to version v2.5.0' label Jan 19, 2023
@Naarcha-AWS Naarcha-AWS requested a review from a team as a code owner January 19, 2023 17:44
@Naarcha-AWS Naarcha-AWS added the 3 - Tech review PR: Tech review in progress label Jan 19, 2023
@Naarcha-AWS Naarcha-AWS self-assigned this Jan 19, 2023
Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
@Naarcha-AWS Naarcha-AWS added the release-notes PR: Include this PR in the automated release notes label Jan 19, 2023
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Copy link
Contributor

@carolxob carolxob left a comment

Choose a reason for hiding this comment

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

LGTM with a couple of very minor changes.

Copy link
Contributor

@alicejw1 alicejw1 left a comment

Choose a reason for hiding this comment

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

Looks good!


## Example: Weighted round robin search

The following sample request creates a round robin shard allocation for search traffic, using an undefined ratio.
Copy link
Contributor

Choose a reason for hiding this comment

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

we're using colons to precede code blocks again. "The following example. ..:"

_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits January 23, 2023 11:47
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels Jan 23, 2023
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Copy link
Contributor

@hdhalter hdhalter left a comment

Choose a reason for hiding this comment

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

Looks good, just a few nit-picky things.

_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-decommission.md Outdated Show resolved Hide resolved
_api-reference/cluster-decommission.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
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.

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_api-reference/cluster-awareness.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
_ml-commons-plugin/cluster-settings.md Outdated Show resolved Hide resolved
@natebower natebower removed the 5 - Editorial review PR: Editorial review in progress label Jan 23, 2023
Naarcha-AWS and others added 2 commits January 23, 2023 14:25
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Naarcha-AWS and others added 19 commits January 23, 2023 14:27
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
@Naarcha-AWS Naarcha-AWS merged commit 1589201 into main Jan 23, 2023
@Naarcha-AWS Naarcha-AWS deleted the weighted-zonal branch January 23, 2023 23:13
vagimeli pushed a commit that referenced this pull request Jan 25, 2023
* Add cluster awareness and decommission docs

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>

* Edit technical feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add new cluster awareness examples

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add technical feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>

* Add Caroline's feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add one more tweak

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-decommission.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _api-reference/cluster-decommission.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Add editoiral feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix typos

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Final editorial note

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nate Bower <nbower@amazon.com>
vagimeli added a commit that referenced this pull request Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v2.5.0 'Issues and PRs related to version v2.5.0'
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Weighted Round Robin shard routing
6 participants