Skip to content

Add cache plugin and tiered cache documentation#7052

Merged
Naarcha-AWS merged 50 commits intoopensearch-project:mainfrom
sgup432:tiered_cache_doc2
May 8, 2024
Merged

Add cache plugin and tiered cache documentation#7052
Naarcha-AWS merged 50 commits intoopensearch-project:mainfrom
sgup432:tiered_cache_doc2

Conversation

@sgup432
Copy link
Copy Markdown
Contributor

@sgup432 sgup432 commented Apr 29, 2024 •
edited
Loading

Description

Adding a new doc for cache plugins introduced as part of 2.14.
Also adding a doc for tiered cache which is one of the implementation provided via cache plugin.

Note: This is an experimental feature.

Issues Resolved

Closes #6300

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@sgup432
Copy link
Copy Markdown
Contributor Author

sgup432 commented Apr 29, 2024

@hdhalter This is almost the same as the previous one which got reverted. I have changed 2.13 to 2.14, hope it should be okay?
There are few items/features missing but we will take those separately as the changes are not yet fully merged in.

@hdhalter hdhalter added Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v2.14.0 labels Apr 30, 2024
@hdhalter
Copy link
Copy Markdown
Contributor

hdhalter commented Apr 30, 2024

Thanks, @sgup432 !

@Naarcha-AWS Naarcha-AWS self-assigned this May 1, 2024
Naarcha-AWS
Naarcha-AWS suggested changes May 2, 2024
View reviewed changes
Naarcha-AWS
Naarcha-AWS reviewed May 7, 2024
View reviewed changes
Naarcha-AWS
Naarcha-AWS reviewed May 7, 2024
View reviewed changes
@Naarcha-AWS Naarcha-AWS added 5 - Final Editorial Review and removed Doc review PR: Doc review in progress labels May 8, 2024
natebower
natebower reviewed May 8, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sgup432 @Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

@kiranprakash154 kiranprakash154 mentioned this pull request May 8, 2024
Closed
4 tasks
sgup432 and others added 6 commits May 8, 2024 11:02
@sgup432
Add cache plugin and tiered cache documentation
c37276e 
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@Naarcha-AWS @sgup432
Apply suggestions from code review
56ced9e 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@Naarcha-AWS @sgup432
Apply suggestions from code review
702114c 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@Naarcha-AWS @sgup432
Update index.md
6701a1c 
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@Naarcha-AWS @sgup432
Update concepts.md (opensearch-project#7049)
0b13f6f 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@hdhalter @sgup432
Update alert-finding-api.md (opensearch-project#7036)
1082316 
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
Naarcha-AWS and others added 18 commits May 8, 2024 11:02
@Naarcha-AWS @sgup432
Update tiered-cache.md
f6846e1 
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@Naarcha-AWS @sgup432
Apply suggestions from code review
8232d46 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@Naarcha-AWS @sgup432
Apply suggestions from code review
6cec39a 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/index.md
af6f2db 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/index.md
d19124f 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/index.md
583fad7 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/index.md
ec51008 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/index.md
cc352a8 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
5bef385 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
44bb9ec 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
b01a0fd 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
596c5c1 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
5750948 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
078ec0d 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
b87bfb7 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
1e78284 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
69c4f48 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 @natebower
Update _search-plugins/caching/tiered-cache.md
6e4c5d7 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sagar <99425694+sgup432@users.noreply.github.com>
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432 sgup432 force-pushed the tiered_cache_doc2 branch from dca8642 to 6e4c5d7 Compare May 8, 2024 18:02
@sgup432
Copy link
Copy Markdown
Contributor Author

sgup432 commented May 8, 2024 •
edited
Loading

I messed up a bit(other commits are added to this PR) trying to fix DCO check. Fixing it now.

sgup432 added 2 commits May 8, 2024 11:11
@sgup432
Merge branch 'main' into tiered_cache_doc2
09e7da0 
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432
Addressing comments
bfe1fbb 
Signed-off-by: Sagar Upadhyaya <sagar.upadhyaya.121@gmail.com>
@sgup432
Copy link
Copy Markdown
Contributor Author

sgup432 commented May 8, 2024 •
edited
Loading

@natebower I have addressed your comments. Looks good to me.

Naarcha-AWS
Naarcha-AWS reviewed May 8, 2024
View reviewed changes
@Naarcha-AWS
Apply suggestions from code review
1186c37 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS merged commit 6397916 into opensearch-project:main May 8, 2024
@peteralfonsi peteralfonsi mentioned this pull request May 15, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hdhalter hdhalter Awaiting requested review from hdhalter

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford

@epugh epugh Awaiting requested review from epugh epugh is a code owner

3 more reviewers

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@natebower natebower natebower left review comments

@jainankitk jainankitk jainankitk approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Naarcha-AWS Naarcha-AWS

Labels

experimental release-notes PR: Include this PR in the automated release notes v2.14.0

Projects

Performance Roadmap
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[DOC] Tiered caching in OpenSearch