spec: Multi-arch image management with ORAS #1514
Open
+542
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FeynmanZhou
requested review from
sajayantony,
shizhMSFT,
SteveLasker,
qweeah and
TerryHowe
as code owners
sajayantony
reviewed
Oct 16, 2024
qweeah
reviewed
Oct 16, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1514 +/- ##
==========================================
+ Coverage 84.35% 84.39% +0.03%
==========================================
Files 123 123
Lines 5638 5638
==========================================
+ Hits 4756 4758 +2
+ Misses 627 625 -2
Partials 255 255 ☔ View full report in Codecov by Sentry. |
shizhMSFT
requested changes
Oct 21, 2024
FeynmanZhou
requested review from
shizhMSFT,
sajayantony,
qweeah and
wangxiaoxuan273
1 task
shizhMSFT
reviewed
Dec 6, 2024
shizhMSFT
approved these changes
Dec 10, 2024
tarilabs
reviewed
Dec 11, 2024
There was a problem hiding this comment.
thank you for drawing my attention to this, @FeynmanZhou ! 🙏
some very optional comments below, I hope these helps!
sudo-bmitch
reviewed
Dec 12, 2024
Wwwsylvia
requested changes
Feb 24, 2025
FeynmanZhou
force-pushed
the
multi-arch
branch
from
71c2d12 to
909bb3f
Compare
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]>
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]>
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]>
Signed-off-by: feynmanzhou <[email protected]>
Signed-off-by: feynmanzhou <[email protected]>
Signed-off-by: feynmanzhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
FeynmanZhou
force-pushed
the
multi-arch
branch
from
909bb3f to
64b200a
Compare
1 task
Wwwsylvia
requested changes
Feb 25, 2025
|
|
||
| #### Create a multi-arch image from a registry only | ||
|
|
||
| Create a multi-arch image using two arch-specific images stored in a registry only, tag it with `v1` and push the tagged image index to an OCI image layout `layout-dir` automatically. |
There was a problem hiding this comment.
The result image index should be pushed to the localhost registry as well.
| Create a multi-arch image using two arch-specific images stored in a registry only, tag it with `v1` and push the tagged image index to an OCI image layout `layout-dir` automatically. | ||
|
|
||
| ```console | ||
| $ oras manifest index create localhost:5000/v1-linux-arm64 localhost:5000/v1-linux-arm64 --oci-layout layout-dir:v1 |
There was a problem hiding this comment.
Suggested change
| $ oras manifest index create localhost:5000/v1-linux-arm64 localhost:5000/v1-linux-arm64 --oci-layout layout-dir:v1 | |
| $ oras manifest index create localhost:5000/example:v1 v1-linux-arm64 v1-linux-arm64 |
| 2. Create a multi-arch image by combining two image manifests into an image index, tag it with `v1` and push the tagged image index to an OCI image layout `layout-dir` automatically. Add annotations to this image index at the same time: | ||
|
|
||
| ```console | ||
| $ oras manifest index create v1-linux-amd64 v1-linux-arm64 --annotation "com.example.key=value" --oci-layout layout-dir:v1 |
There was a problem hiding this comment.
Suggested change
| $ oras manifest index create v1-linux-amd64 v1-linux-arm64 --annotation "com.example.key=value" --oci-layout layout-dir:v1 | |
| $ oras manifest index create --oci-layout layout-dir:v1 v1-linux-amd64 v1-linux-arm64 --annotation "com.example.key=value" |
There was a problem hiding this comment.
The index to created must be in the first argument
Comment on lines
+170
to
+178
| Fetching v1-linux-amd64 | ||
| Fetched sha256:42c524c48e0672568dbd2842d3a0cb34a415347145ee9fe1c8abaf65e7455b46 v1-linux-amd64 | ||
| Fetching v1-linux-arm64 | ||
| Fetched sha256:965945e1a08031a63d5970c1da7c39af231c36e4c0a5a3cc276d02a3e06513ee v1-linux-arm64 | ||
| Packed edb5bc1f0b5c application/vnd.oci.image.index.v1+json | ||
| Pushed [oci-layout] layout-dir:v1 | ||
| Digest: sha256:edb5bc1f0b5c21e9321b34e50c92beae739250fb88409056e8719d9759f6b5b4 | ||
|
|
||
| Status: An image index has been created and pushed to layout-dir:v1 |
There was a problem hiding this comment.
We need to fix the output as well
| Update the image index by adding a new architecture from a registry in the OCI image layout: | ||
|
|
||
| ```console | ||
| $ oras manifest index update --add localhost:5000/v1-linux-arm64 --oci-layout layout-dir:v1 |
There was a problem hiding this comment.
Suggested change
| $ oras manifest index update --add localhost:5000/v1-linux-arm64 --oci-layout layout-dir:v1 | |
| $ oras manifest index update --oci-layout layout-dir:v1 --add v1-linux-arm64 |
|
|
||
| #### Update an existing multi-Arch image | ||
|
|
||
| Update the image index by adding a new architecture from a registry in the OCI image layout: |
There was a problem hiding this comment.
The source and the target must be either a registry or an OCI image layout
Comment on lines
+204
to
+253
| ### Create a multi-arch image | ||
|
|
||
| ```bash | ||
| # Create an index from source manifests tagged 'linux-amd64' and 'linux-arm64', and push without tagging: | ||
| oras manifest index create localhost:5000/hello linux-amd64 linux-arm64 | ||
|
|
||
| # Create an index from source manifests tagged 'linux-amd64' and 'linux-arm64', and push with the tag 'v1': | ||
| oras manifest index create localhost:5000/hello:v1 linux-amd64 linux-arm64 | ||
|
|
||
| # Create an index from source manifests using both tags and digests, and push with tag 'v1': | ||
| oras manifest index create localhost:5000/hello:v1 linux-amd64 sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | ||
|
|
||
| # Create an index and push it with multiple tags: | ||
| oras manifest index create localhost:5000/hello:tag1,tag2,tag3 linux-amd64 linux-arm64 sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | ||
|
|
||
| # Create and push an index with annotations: | ||
| oras manifest index create localhost:5000/hello:v1 linux-amd64 --annotation "key=val" | ||
|
|
||
| # Create an index and push to an OCI image layout folder 'layout-dir' and tag with 'v1': | ||
| oras manifest index create layout-dir:v1 linux-amd64 sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | ||
|
|
||
| # Create an index and save it locally to index.json, auto push will be disabled: | ||
| oras manifest index create --output index.json localhost:5000/hello linux-amd64 linux-arm64 | ||
|
|
||
| # Create an index and output the index to stdout, auto push will be disabled: | ||
| oras manifest index create localhost:5000/hello linux-arm64 --output - --pretty | ||
|
|
||
| ``` | ||
|
|
||
| ### Update a multi-arch image | ||
|
|
||
| ```bash | ||
| # Remove a manifest and add two manifests from an index tagged 'v1'. The tag will point to the updated index: | ||
| oras manifest index update localhost:5000/hello:v1 --add linux-amd64 --add linux-arm64 --remove sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | ||
|
|
||
| # Create a new index by updating an existing index specified by its digest: | ||
| oras manifest index update localhost:5000/hello@sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 --add linux-amd64 --remove sha256:fd6ed2f36b5465244d5dc86cb4e7df0ab8a9d24adc57825099f522fe009a22bb | ||
|
|
||
| # Merge manifests from the index 'v2-windows' to the index 'v2': | ||
| oras manifest index update localhost:5000/hello:v2 --merge v2-windows | ||
|
|
||
| # Update an index and tag the updated index as 'v2.1.0' and 'v2': | ||
| oras manifest index update localhost:5000/hello@sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 --add linux-amd64 --tag "v2.1.0" --tag "v2" | ||
|
|
||
| # Update an index and save it locally to index.json, auto push will be disabled: | ||
| oras manifest index update --output index.json localhost:5000/hello:v2 --add v2-linux-amd64 | ||
|
|
||
| # Update an index and output the index to stdout, auto push will be disabled: | ||
| oras manifest index update --output - --pretty localhost:5000/hello:v2 --remove sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | ||
| ``` |
There was a problem hiding this comment.
Wondering if the detailed command examples are really necessary in the spec?
Wwwsylvia
reviewed
Feb 25, 2025
| oras manifest index create localhost:5000/hello:v1 linux-amd64 --annotation "key=val" | ||
|
|
||
| # Create an index and push to an OCI image layout folder 'layout-dir' and tag with 'v1': | ||
| oras manifest index create layout-dir:v1 linux-amd64 sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 |
There was a problem hiding this comment.
Suggested change
| oras manifest index create layout-dir:v1 linux-amd64 sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | |
| oras manifest index create --oci-layout layout-dir:v1 linux-amd64 sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 |
BTW, we have fixed this example in main branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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