Enhanced the documentation for the convert_index_to_remote ISM action with comprehensive details and examples: #11491 #11495
+90
−4
Conversation
This file contains hidden or 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
- Add detailed description of searchable snapshot conversion process - Document three optional parameters: include_aliases, ignore_index_settings, number_of_replicas - Add Prerequisites and Usage notes sections - Include three examples: basic, advanced configuration, and complete policy - Provide guidance on automatic deletion, repository matching, and replica considerations Signed-off-by: Seung Yeon Joo <[email protected]>
…entation Enhance convert_index_to_remote documentation with comprehensive details
wntmddus
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
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. |
This was referenced Nov 5, 2025
Collaborator
|
@vikasvb90 Could you review this PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Enhanced the documentation for the
convert_index_to_remoteISM action with comprehensive details and examples:include_aliases: Control whether to restore index aliases along with the indexignore_index_settings: Specify settings to ignore during restore for customized configurationnumber_of_replicas: Set replica count during conversion to prevent cluster yellow stateThe resolved documentation provides more explicit guidance for users implementing searchable snapshots with ISM policies.
Issues Resolved
Closes opensearch-project/index-management#1487, opensearch-project/index-management#808 (comment)
Version
All versions with ISM searchable snapshot support.
Frontend features
N/A - Documentation only change.
Checklist