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

docs: init design doc for OCI Store Cache Worker #1578

Draft
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

junczhu
Copy link
Collaborator

@junczhu junczhu commented Jun 17, 2024

Description

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Design for #1110

Todos:

  • create memory backed content store for ORAS store in ratify
  • create task queue in cache provider
  • create cache worker, link cache worker with ORAS store, cache provider
  • link OCI store with cache provider task queue (using cache worker interface)
  • check cache data flow

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Copy link

codecov bot commented Jun 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

see 33 files with indirect coverage changes

@junczhu junczhu marked this pull request as ready for review June 24, 2024 13:22
docs/design/OCI Store Cache Worker.md Outdated Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
- Cache Provider: Set up to cache data for `GetSubjectDescriptor`, `GetReferenceManifest`.

- OCI Store(local cache): A content store based on file system with the OCI-Image layout.
- Both executor and plugin initiation would `CreateStoresFromConfig`, add cache check can help avoid duplication.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I feel some simple code sample would help explain it.

docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Outdated Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Outdated Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Outdated Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Show resolved Hide resolved
docs/design/OCI Store Cache Worker.md Outdated Show resolved Hide resolved
@junczhu junczhu marked this pull request as draft June 27, 2024 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants