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.

Sign up for GitHub

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

Jump to bottom

feat: add how-to for multiple architecture #395

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add how-to for multiple architecture #395

wants to merge 1 commit into from

Conversation

TerryHowe
Copy link
Member

@TerryHowe TerryHowe commented Sep 17, 2024 •
edited
Loading

Add a how-to guilde for multiple architecture artifact management.

Closes: #247

@sajayantony
Copy link
Contributor

Only if OCI gave a way to not use the config blobs for archs, but I guess this is what we have today and IMHO we should publish this and chase a better experience in some brighter future.

/cc @shizhMSFT

@TerryHowe TerryHowe force-pushed the multiple-architecture branch 4 times, most recently from f8bc97e to 718885d Compare September 17, 2024 19:05
@shizhMSFT shizhMSFT changed the title feature: add how-to for multiple architecture feat\: add how-to for multiple architecture Sep 18, 2024
@shizhMSFT shizhMSFT changed the title feat\: add how-to for multiple architecture feat: add how-to for multiple architecture Sep 18, 2024
shizhMSFT
shizhMSFT requested changes Sep 18, 2024
View reviewed changes
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.

Thank @TerryHowe for the contribution and I agree with @sajayantony.

This PR depends on oras-project/oras#1500. Mark Request changes to prevent accidental merge.

Linking oras-project/oras#1066

shizhMSFT
shizhMSFT reviewed Sep 18, 2024
View reviewed changes
netlify.toml Outdated Show resolved Hide resolved
versioned_docs/version-1.2/how_to_guides/multiarch.mdx Outdated Show resolved Hide resolved
versioned_docs/version-1.2/how_to_guides/multiarch.mdx Outdated

First we push a Linux ARM64 executable:
```shell
% oras push --plain-http localhost:15000/oras:linux,arm64 --platform linux/arm64 --artifact-type 'application/vnd.oci.image.config.v1+json' bin/linux/arm64/oras:application/octet-stream
Copy link
Contributor

Choose a reason for hiding this comment

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

The flag name depends on the discussion of oras-project/oras#1500

Copy link
Member Author

Choose a reason for hiding this comment

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

changed to --artifact-platform

@TerryHowe TerryHowe force-pushed the multiple-architecture branch 2 times, most recently from 083bd12 to 0604e76 Compare September 19, 2024 14:42
@TerryHowe TerryHowe force-pushed the multiple-architecture branch from 0604e76 to fffaf6b Compare September 27, 2024 19:25
FeynmanZhou
FeynmanZhou reviewed Oct 25, 2024
View reviewed changes
versioned_docs/version-1.2/how_to_guides/multiarch.mdx Outdated
sidebar_position: 110
---

# Multiple Architecture Image Support for ORAS
Copy link
Member

Choose a reason for hiding this comment

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

Should the title be Multi-platform Image/Artifact Support with ORAS?

Copy link
Member Author

Choose a reason for hiding this comment

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

I made this change, but I think "architecture" communicates more than "platform"

FeynmanZhou
FeynmanZhou reviewed Oct 25, 2024
View reviewed changes
versioned_docs/version-1.2/how_to_guides/multiarch.mdx Outdated
ORAS can help you manage multiple architecture artifacts such as configurations, executables, and container images.
This example shows how you can use ORAS to manage executables for different operating systems and architectures.

## Pushing the artifacts
Copy link
Member

Choose a reason for hiding this comment

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

As there are several features demonstrated in this doc are a part of ORAS v1.3.0, we need to create a new version of documentation before merging this PR. This article is supposed to be v1.3.0.

FeynmanZhou
FeynmanZhou reviewed Oct 25, 2024
View reviewed changes
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

Thanks @TerryHowe . We will hold on this PR before ORAS v1.3 documentation folder created.

@TerryHowe TerryHowe force-pushed the multiple-architecture branch from fffaf6b to 923b780 Compare December 18, 2024 12:28
@TerryHowe
Copy link
Member Author

https://deploy-preview-395--oras-project.netlify.app/docs/1.3.0-beta.1/how_to_guides/multiarch

@TerryHowe TerryHowe force-pushed the multiple-architecture branch from 923b780 to 62ce8f8 Compare December 21, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FeynmanZhou FeynmanZhou FeynmanZhou left review comments

@shizhMSFT shizhMSFT shizhMSFT requested changes

@qweeah qweeah qweeah left review comments

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

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

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

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

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Documentation Feedback]: Add use case of non-container articacts to OCI concepts
5 participants
@TerryHowe @sajayantony @qweeah @shizhMSFT @FeynmanZhou