Improve shard allocation awareness documentation - part 2 #8339
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patelsmit32123
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
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. |
|
@Naarcha-AWS I wanted to suggest some more changes w.r.t to the last PR. Please take a look. |
patelsmit32123
force-pushed
the
improve-shard-allocation-awareness-docs-2
branch
from
4f0b132 to
55495b0
Compare
Signed-off-by: Smit Patel <[email protected]>
patelsmit32123
force-pushed
the
improve-shard-allocation-awareness-docs-2
branch
from
55495b0 to
74b2682
Compare
Naarcha-AWS
reviewed
Sep 19, 2024
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Sep 19, 2024
natebower
reviewed
Sep 19, 2024
|
|
||
| Shard allocation awareness attempts to separate primary and replica shards across multiple zones because 2 shard copies cannot be placed on the same node. When only 1 zone is available, such as after a zone failure, OpenSearch allocates replica shards to the only remaining zone. For example, if your index has a total of 5 shard copies (1 primary and 4 replicas) and nodes in 3 distinct zones, then OpenSearch will perform the following to allocate all 5 shard copies: | ||
| OpenSearch, by default, allocates shard copies of a single shard across different nodes. When only 1 zone is available, such as after a zone failure, OpenSearch allocates replica shards to the only remaining zone i.e. it considers only available zones (attribute values) for calculating maximum allowed shard copies per zone. |
There was a problem hiding this comment.
Suggested change
| OpenSearch, by default, allocates shard copies of a single shard across different nodes. When only 1 zone is available, such as after a zone failure, OpenSearch allocates replica shards to the only remaining zone i.e. it considers only available zones (attribute values) for calculating maximum allowed shard copies per zone. | |
| OpenSearch, by default, allocates shard copies of a single shard across different nodes. When only 1 zone is available, such as after a zone failure, OpenSearch allocates replica shards to the only remaining zone---it considers only available zones (attribute values) when calculating the maximum number of allowed shard copies per zone. |
|
|
||
| - Allocate fewer than 2 shards per zone, which will require at least 2 nodes in 2 zones. | ||
| - Allocate not more than 2 shards per zone, which will require at least 2 nodes in 2 zones. |
There was a problem hiding this comment.
Suggested change
| - Allocate not more than 2 shards per zone, which will require at least 2 nodes in 2 zones. | |
| - Allocate no more than 2 shards per zone, which will require at least 2 nodes in 2 zones. |
noahstaveley
pushed a commit
to noahstaveley/documentation-website
that referenced
this pull request
Sep 23, 2024
…-project#8339) * Improve shard allocation awareness documentation - part 2 Signed-off-by: Smit Patel <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Smit Patel <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Smit Patel <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
noahstaveley
pushed a commit
to noahstaveley/documentation-website
that referenced
this pull request
Sep 23, 2024
…-project#8339) * Improve shard allocation awareness documentation - part 2 Signed-off-by: Smit Patel <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Smit Patel <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Smit Patel <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Shard allocation awareness attributes documentation was lacking information regarding how the allocation actually functions and in what conditions the shard can remain unallocated.
Issues Resolved
Closes #[insert issue number]
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.