Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add documentation on caching for the Snapshot’s RepositoryData #8629

Open
1 of 4 tasks
inpink opened this issue Oct 29, 2024 · 4 comments
Open
1 of 4 tasks

[DOC] Add documentation on caching for the Snapshot’s RepositoryData #8629

inpink opened this issue Oct 29, 2024 · 4 comments
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.19.0

Comments

@inpink
Copy link
Contributor

inpink commented Oct 29, 2024

What do you want to do?

  • 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.
opensearch-project/OpenSearch#16489

@inpink inpink changed the title [DOC] Snapshot의 Repository Data의 캐싱 관련 문서 추가 [DOC] Add documentation on caching for the Snapshot’s RepositoryData Oct 29, 2024
@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Oct 29, 2024
@Naarcha-AWS
Copy link
Collaborator

Hi @inpink! Do you have a link to the development PR you submitted?

@inpink
Copy link
Contributor Author

inpink commented Oct 29, 2024

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!

@dbwiddis
Copy link
Member

This will actually be no earlier than 2.19.

@inpink
Copy link
Contributor Author

inpink commented Oct 30, 2024

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.19.0
Projects
None yet
Development

No branches or pull requests

3 participants