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

spec: Multi-arch image management with ORAS #1514

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

FeynmanZhou
Copy link
Member

@FeynmanZhou FeynmanZhou commented Oct 15, 2024

What this PR does / why we need it:

Add a spec: Multi-arch image management with ORAS

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

Preview: https://github.com/FeynmanZhou/oras/blob/multi-arch/docs/proposals/multi-arch-image-mgmt.md

Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.34%. Comparing base (1d60e22) to head (c41d8f6).
Report is 46 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1514      +/-   ##
==========================================
- Coverage   85.97%   84.34%   -1.63%     
==========================================
  Files         118      120       +2     
  Lines        4228     5449    +1221     
==========================================
+ Hits         3635     4596     +961     
- Misses        354      606     +252     
- Partials      239      247       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

To make the spec more professional, please proofread the spec and fix formatting issues.

docs/proposals/img/multi-arch.png Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
@FeynmanZhou FeynmanZhou requested a review from shizhMSFT December 9, 2024 08:58
Signed-off-by: Feynman Zhou <[email protected]>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM but you need to fix the check failure.

@@ -63,16 +63,15 @@ The proposed CLI commands for managing a multi-arch image are listed below. The

- Create a multi-arch image: `oras manifest index create`
- Update a multi-arch image: `oras manifest index update`
- Inspect a multi-arch image: `oras manifest fetch`. Add two alias `oras manifest inspect` and `oras manifest show` for usability
- Add annotations to a multi-arch image: `oras manifest create --annotation`
- Add annotations to a multi-arch image during creation: `oras manifest index create --annotation`
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: do you want to make it a sub-item of "Create a multi-arch image: oras manifest index create"?

Copy link

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

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

thank you for drawing my attention to this, @FeynmanZhou ! 🙏

some very optional comments below, I hope these helps!

docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved
docs/proposals/multi-arch-image-mgmt.md Outdated Show resolved Hide resolved

### Inspect a multi-arch image

Add two alias `show` and `inspect`:
Copy link
Member

Choose a reason for hiding this comment

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

Can we elaborate more on why this is needed? Is it to inform users the purpose of the command or is it more intuitive for users to input the command?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. The purpose is to make the inspection operation more intuitive to users. fetch or get is more like download operation to users.

@TerryHowe
Copy link
Member

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.

Support multi-arch image/artifact push
9 participants