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

Add UDS CLI OCI repo detection superpowers #881

Open
docandrew opened this issue Aug 28, 2024 · 1 comment
Open

Add UDS CLI OCI repo detection superpowers #881

docandrew opened this issue Aug 28, 2024 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@docandrew
Copy link

Is your feature request related to a problem? Please describe

There's no easy way to inspect an OCI repo and determine whether it contains a Zarf package, or a UDS package, or a UDS bundle, or a Helm OCI chart, etc. You can curl the OCI URL endpoint and manually inspect layers looking for indicative files, but this is error-prone and time-consuming.

Describe the solution you'd like

I propose the addition of capabilities to uds inspect to allow it to determine what type of image/package is contained in an OCI repo. Initially, being able to determine if a Zarf package is a UDS package or not would be helpful.

Later, detecting other OCI image types such as Helm charts, Snaps, and even some types of VM images would be a powerful addition to UDS CLI as well.

@docandrew docandrew added the enhancement New feature or request label Aug 28, 2024
@UncleGedd UncleGedd added this to the v0.16.0 milestone Aug 28, 2024
@bburky
Copy link
Member

bburky commented Aug 28, 2024

Related:

Zarf uses a specific application/vnd.zarf.config.v1+json mime type on the config layer. This allows easily identifying a zarf package from its OCI metadata.

Uds-cli however, uses a application/vnd.zarf.layer.v1.blob mime type for it's config (this is arguably incorrect, this is not supposed to be used for config, it's also used for all the layers). So you can't really identify if your OCI thing is a UDS bundle from the obvious metadata. (for now, you can look for a uds-bundle.yaml layer, but as this issue says, this is tricky and maybe error prone)

In addition to maybe improving some CLI commands like uds inspect as this issue requests, I'd suggest changing the config mime type for UDS bundles to something UDS bundle specific?

@catsby catsby modified the milestones: v0.16.0, v0.17.0 Sep 20, 2024
@catsby catsby modified the milestones: v0.17.0, vNext Oct 4, 2024
@catsby catsby assigned catsby and unassigned catsby Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants