opensearch-project
[DOC] Add documentation on caching for the Snapshot’s RepositoryData
What do you want to do?
- [X] Request a change to existing documentation
- [ ] Add new documentation
- [ ] Report a technical problem with the documentation
- [ ] Other
Tell us about your request. Provide a summary of the request. The Snapshot feature improves performance by caching RepositoryData. I’d like to add documentation on caching to this page. Currently, up to 500KB of RepositoryData can be cached, with an option to disable caching entirely. I also submitted a PR to the OpenSearch Project to enable users to set the maximum cache size according to their needs, and I would like to include this update in the documentation as well.
Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all. 2.19
What other resources are available? Provide links to related issues, POCs, steps for testing, etc. https://github.com/opensearch-project/OpenSearch/pull/16489
Hello, @Naarcha-AWS! The PR I submitted is #16489, and the related issue is #16298. (I’ve also included links to these in the body of the post.)
I am discussing this topic in the two links above. Once the PR is merged, I’ll submit a PR to the documentation as well. Thank you for assigning me the issue! 😄🎉 Have a nice day!
This will actually be no earlier than 2.19.
Ah, got it! I’ve updated the content to version 2.19 as requested. Thank you for pointing that out, @dbwiddis.
@Naarcha-AWS, would you mind adjusting the label? Much appreciated!
@inpink Can you link the doc PR to this issue? It is blocking the release for 2.19 launch.
Hi @inpink ,
As part of the entrance criteria, all the documentation pull requests need to be drafted and in technical review. Since there is no pull request linked to this issue, please take one of the following actions:
- Create the pull request and link it to this issue.
- If you already have a pull request created, please link it to this issue.
- If this feature is not targeted for the currently labeled release version, please update the issue with the correct release version.
Please note: Missing documentation can block the release and cause delays in the overall process. Thank you!
@inpink: Any updates on the PR for this issue or anything the Documentation team can assist with? I see that the development PR you linked is merged in.