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

Support pulling an OCI artifact/image from registry to a local OCI archive #1160

Open
1 task
FeynmanZhou opened this issue Nov 1, 2023 · 5 comments
Open
1 task
Labels
duplicate This issue or pull request already exists enhancement New feature or request spec required Issues that require specifications
Milestone

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Nov 1, 2023

What is the version of your ORAS CLI

v1.1.0

What would you like to be added?

We have seen multiple ORAS users who wanted to pull OCI artifact or container images from a remote registry to a local OCI archive or an OCI layout. oras copy has options to pull the subject/referrer from remote registry to OCI layout (or from OCI layout to registry).

However, Pull is commonly understood but Copy is an extra cognitive step for most of the new ORAS users. We need to design and provide a way to enable users easily pull an OCI artifact/image from registry to a local OCI archive or an OCI layout.

Why is this needed for ORAS?

In order to provide a natural experience of pulling content from registry to local and make the design principle conforms to users’ default habits.

We received several ORAS user requests on this feature. Related discussion: https://cloud-native.slack.com/archives/CJ1KHJM5Z/p1697701836678159?thread_ts=1697645768.389369&cid=CJ1KHJM5Z

Are you willing to submit PRs to contribute to this feature?

  • Yes, I am willing to implement it.
@FeynmanZhou FeynmanZhou added enhancement New feature or request triage New issues or PRs to be acknowledged by maintainers labels Nov 1, 2023
@yizha1 yizha1 removed the triage New issues or PRs to be acknowledged by maintainers label Nov 14, 2023
@yizha1 yizha1 added this to the v1.3.0 milestone Nov 14, 2023
@shizhMSFT
Copy link
Contributor

In terms of local OCI archive, does it mean a .tar tarball, a gzip one .tar.gz, or simply a .zip file?

What if there is already an existing OCI archive? For example pulling a bar:latest image to foo.tar, which contains foo:latest. Will it overwrite or store both foo:latest and bar:latest in a single foo.tar file?

@shizhMSFT
Copy link
Contributor

Since oras pull is about pulling extracted artifact files, do we need a new command like oras export or oras save or oras dump for pulling an image from registry to a local archive?

@shizhMSFT
Copy link
Contributor

Or consider something like oras pull --output-oci-layout <file_path>.

@shizhMSFT shizhMSFT added the spec required Issues that require specifications label Mar 14, 2024
@fsdrw08
Copy link

fsdrw08 commented May 11, 2024

maybe oras save, just like what docker/podman does, but also need to add --format flag like podman to save the image as oci-archive

@shizhMSFT
Copy link
Contributor

shizhMSFT commented Jul 24, 2024

@FeynmanZhou FeynmanZhou modified the milestones: v1.3.0, v1.4.0 Jul 24, 2024
@shizhMSFT shizhMSFT added the duplicate This issue or pull request already exists label Jul 24, 2024
@shizhMSFT shizhMSFT modified the milestones: v1.4.0, v1.3.0 Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists enhancement New feature or request spec required Issues that require specifications
Projects
None yet
Development

No branches or pull requests

4 participants