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

Document output of oci_image more clearly #668

Open
reddaly opened this issue Aug 6, 2024 · 3 comments
Open

Document output of oci_image more clearly #668

reddaly opened this issue Aug 6, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@reddaly
Copy link

reddaly commented Aug 6, 2024

The output of an oci_image and oci_image_rule is not clearly documented.

The only reference to the output as of today (taken from here) is

Produces a target [name].digest, whose default output is a file containing the sha256 digest of the resulting image. This is similar to the same-named target created by rules_docker's container_image macro.


The output of the rule seems to be a directory. When I inspect the directory, I don't see much content. I would have expected to single file with an image file I could run though crane export <image> <image.tar> so I can inspect the file system contents of the image.

@thesayyn thesayyn added the documentation Improvements or additions to documentation label Aug 7, 2024
@thesayyn
Copy link
Collaborator

thesayyn commented Aug 7, 2024

Output of an oci_image is an OCI Image Layout which is defined by the oci-spec.

@reddaly
Copy link
Author

reddaly commented Aug 7, 2024

Thanks. Adding that sentence to the docstring for oci_image and oci_image_rule is pretty much all I'm looking for.

It might also be worth giving a pointer to guide that explains how to consume the image with other tools. For example, how can a rules_oci output directory be used by docker, e.g. the docker load command,

@thesayyn
Copy link
Collaborator

I'd be happy review a PR :)

For example, how can a rules_oci output directory be used by docker

https://github.com/bazel-contrib/rules_oci/blob/main/docs/load.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants