opencontainers / image-spec

OCI Image Format
https://www.opencontainers.org/
Apache License 2.0
3.5k stars 649 forks source link

org.opencontainers.image.url label definition is ambiguous #802

Open jpeach opened 4 years ago

jpeach commented 4 years ago

The org.opencontainers.image.url label is defined as "URL to find more information on the image", but it is also documented as being compatible with label-schema, which defines this field as "URL of website with more information about the product or service provided by the container".

So in the OCI case, I could reasonably interpret this as a link to information about this image itself (not a link to the software provided by the image). I don't think that this is the intention, but the label-schema language is much clearer.

clarkbw commented 4 years ago

I've hit this same issue.

According to examples from label schema org.opencontainers.image.url is a more generic service url like github.com where as org.opencontainers.image.source is intended to be the URL to the source repository (ex. https://github.com/opencontainers/image-spec/ ).

If these are correct it would be good to update with examples such that it is more clear.

MindTooth commented 8 months ago

@clarkbw care to share l link to this example? I feel this is still a bit ambiguous. 😔

tianon commented 8 months ago

I don't know the full original context/thought process behind this annotation, but I imagine the intent was along the lines of "a useful URL" and thus intentionally vague so it could be used for either use case (image details OR software details).