Adding reader writer separation doc page #9795
Merged
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
Signed-off-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.com>
vinaykpud
requested review from
AMoo-Miki,
Naarcha-AWS,
dlvenable,
epugh,
kolchfa-aws and
natebower
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. |
| By using `_scale` API user can choose to turn off primary shards and write-replicas in case they don’t expect any writing to that index. | ||
| In write-once, read-many scenarios (like log analytics), you can scale down primary and write replicas, leaving only search replicas active. This will free up the resources. | ||
|
|
||
| Turn Off Writers: |
There was a problem hiding this comment.
Thanks @vinaykpud I already have this scale API added to the API section #9762.
For Turn Off Writers: section should we just talk about the process of scale to zero and point this doc to scale API?
There was a problem hiding this comment.
Sure, we can add a 2 line description and link to API doc from here.
Naarcha-AWS
added
Tech review
1 task
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
|
@vinaykpud and @prudhvigodithi: Let me know if my changes work for you. |
vinaykpud
commented
May 1, 2025
…rkloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
reviewed
May 2, 2025
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
|
@vinaykpud or @prudhvigodithi: Are the any additional adjustments we should make to this one? |
Naarcha-AWS
added
Doc review
vinaykpud
commented
May 2, 2025
|
|
||
| You can use the `_scale` API to turn off primary shards and write replicas if you don't expect any writes to an index. In write-once, read-many scenarios (like log analytics), you can scale down primary and write replicas, leaving only search replicas active to free up resources. | ||
|
|
||
| The following request turns off writers: |
There was a problem hiding this comment.
As @prudhvigodithi mentioned earlier do we need API example here or should we just give link to the API doc for _scale?
There was a problem hiding this comment.
I think we can add the link once the scale PR gets merged in.
Naarcha-AWS
reviewed
May 2, 2025
Naarcha-AWS
added
Editorial review
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
reviewed
May 2, 2025
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
|
@natebower: This is ready for editorial review. |
natebower
reviewed
May 5, 2025
There was a problem hiding this comment.
@Naarcha-AWS @vinaykpud Please see my comment and changes and let me know if you have any questions. Thanks!
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| - `true` (default): Route only to search replicas. |
There was a problem hiding this comment.
These bullet points appear to be floating (not connected to anything). Should they be introduced by a brief sentence ending in a colon?
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
approved these changes
May 5, 2025
KishoreKicha14
pushed a commit
to KishoreKicha14/documentation-website
that referenced
this pull request
Jun 13, 2025
* Adding reader writer separation doc page Signed-off-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.com> * Add technical writer edits Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update segregating-indexing-search.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Rename segregating-indexing-search.md to seperate-index-and-search-workloads.md 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> * Update _tuning-your-cluster/seperate-index-and-search-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update seperate-index-and-search-workloads.md 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> * Update seperate-index-and-search-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.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>
epugh
pushed a commit
to o19s/documentation-website
that referenced
this pull request
Jul 2, 2025
* Adding reader writer separation doc page Signed-off-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.com> * Add technical writer edits Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update segregating-indexing-search.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Rename segregating-indexing-search.md to seperate-index-and-search-workloads.md 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> * Update _tuning-your-cluster/seperate-index-and-search-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update seperate-index-and-search-workloads.md 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> * Update seperate-index-and-search-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.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
5 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
Adding documentation for Reader Writer separation changes.
META: opensearch-project/OpenSearch#15306
Design: opensearch-project/OpenSearch#15237
RFC: opensearch-project/OpenSearch#7258
Issues Resolved
Closes #9670
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
3.0
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.
NA
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.