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

Improved shard allocation awareness attributes documentation #8268

Conversation

patelsmit32123
Copy link
Contributor

@patelsmit32123 patelsmit32123 commented Sep 16, 2024

Description

Shard allocation awareness attributes documentation was lacking information regarding how the allocation actually functions and in what conditions the shard can remain unallocated.

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.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@patelsmit32123
Copy link
Contributor Author

@RS146BIJAY please review the documentation changes too

@patelsmit32123 patelsmit32123 force-pushed the improve-shard-allocation-awareness-docs branch 2 times, most recently from f1c568e to 8c4ea94 Compare September 16, 2024 08:37
@patelsmit32123 patelsmit32123 force-pushed the improve-shard-allocation-awareness-docs branch from 8c4ea94 to 43a61f7 Compare September 16, 2024 18:32
@patelsmit32123 patelsmit32123 force-pushed the improve-shard-allocation-awareness-docs branch from 43a61f7 to e8a513a Compare September 16, 2024 18:35
@patelsmit32123
Copy link
Contributor Author

@natebower can you please review?

@natebower
Copy link
Collaborator

@natebower can you please review?

@Naarcha-AWS 😄

@Naarcha-AWS
Copy link
Collaborator

@patelsmit32123: I'll take a look at this today.

@Naarcha-AWS Naarcha-AWS added backport 2.17 Backport for version 2.17 4 - Doc review PR: Doc review in progress labels Sep 17, 2024
Naarcha-AWS and others added 2 commits September 17, 2024 07:11
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Smit Patel <psmit@uber.com>
@patelsmit32123 patelsmit32123 force-pushed the improve-shard-allocation-awareness-docs branch from 0ac6956 to 2b931de Compare September 17, 2024 14:37
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Sep 17, 2024
@Naarcha-AWS
Copy link
Collaborator

@natebower: Ready for editorial.

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 @patelsmit32123 Please see my changes and let me know if you have any questions. Thanks!

_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
_tuning-your-cluster/index.md Outdated Show resolved Hide resolved
patelsmit32123 and others added 9 commits September 18, 2024 01:00
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS
Copy link
Collaborator

@patelsmit32123: We'll merge this in after the release later this afternoon.

@natebower natebower added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Editorial review PR: Editorial review in progress labels Sep 18, 2024
@Naarcha-AWS Naarcha-AWS merged commit ac40282 into opensearch-project:main Sep 18, 2024
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 18, 2024
* Added more details regarding shard allocation awareness attributes

Signed-off-by: Smit Patel <psmit@uber.com>

* Update index.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Addressed linter recommendations

Signed-off-by: Smit Patel <psmit@uber.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _tuning-your-cluster/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Smit Patel <psmit@uber.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Smit Patel <39486815+patelsmit32123@users.noreply.github.com>
Co-authored-by: Smit Patel <psmit@uber.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit ac40282)
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
6 - Done but waiting to merge PR: The work is done and ready to merge backport 2.17 Backport for version 2.17 v2.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants