Create documentation for snapshots with hashed prefix path type #8196
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
Signed-off-by: Ashish Singh <ssashish@amazon.com>
ashking94
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. |
Signed-off-by: Ashish Singh <ssashish@amazon.com>
gbbafna
approved these changes
Sep 9, 2024
Naarcha-AWS
reviewed
Sep 10, 2024
Naarcha-AWS
reviewed
Sep 10, 2024
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
requested changes
Sep 10, 2024
There was a problem hiding this comment.
A couple of follow up questions for you @gbbafna and @ashking94.
Naarcha-AWS
added
4 - Doc review
Naarcha-AWS
reviewed
Sep 10, 2024
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Thanks for working on this PR @Naarcha-AWS. I have responded to your question. |
Naarcha-AWS
reviewed
Sep 10, 2024
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
reviewed
Sep 10, 2024
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
reviewed
Sep 10, 2024
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
5 - Editorial review
Naarcha-AWS
approved these changes
Sep 11, 2024
natebower
reviewed
Sep 11, 2024
There was a problem hiding this comment.
@ashking94 @Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
|
|
||
| - `FIXED`: Keeps the path structure in the existing hierarchical manner, such as, `<ROOT>/<BASE_PATH>/indices/<index-id>/0/<SHARD_BLOBS>` | ||
| - `HASHED_PREFIX`: Prepends a hashed prefix at the start of path for each unique shard ID, for example, `<ROOT>/<HASH-OF-INDEX-ID-AND-SHARD-ID>/<BASE_PATH>/indices/<index-id>/0/<SHARD_BLOBS>`. | ||
| - `HASHED_INFIX`: Appends a hashed prefix after the base path for each unique shard ID, for example, `<ROOT>/<BASE-PATH>/<HASH-OF-INDEX-ID-AND-SHARD-ID>/indices/<index-id>/0/<SHARD_BLOBS>`. The hash method used is `fnv_1a_composite_1, which uses the `FNV1a` hash function and generates a custom-encoded 64-bit hash value that scales well with most remote store options. `FNV1a` takes the most significant 6 bits to create a url-safe base64 character and the next 14 bits to create a binary string. | ||
|
|
There was a problem hiding this comment.
Line above: Same question re: fnv_1a_composite_1. I believe it may have been in all caps in a previous PR. Also, it looks like you have an unclosed tic mark here.
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
_install-and-configure/configuring-opensearch/index-settings.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
epugh
pushed a commit
to o19s/documentation-website
that referenced
this pull request
Sep 12, 2024
…search-project#8196) * Create documentation for snapshots with hashed prefix path type Signed-off-by: Ashish Singh <ssashish@amazon.com> * Add documentation on new cluster settings for fixed prefix Signed-off-by: Ashish Singh <ssashish@amazon.com> * Update create-repository.md * Update create-repository.md * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Ashish Singh <ssashish@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
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
This PR aims to add documentation for the following features -
Issues Resolved
Closes #8143
Version
This PR applies to version 2.17 and later.
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.
NONE
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.