What kind of annotations does Artifacthub require for multi-arch container images?

[dploeger]

Hi!

I'm currently confused by the annotations, Artifacthub requires for container images as there are index manifest and image manifest annotations.

Apparently, GitHub requires index manifest annotations for multi-arch images (which we use) so that e.g. the description is shown in the package view.

Looking at ArtifactHub's code it seems that it only uses the available archs from the indexmanifest and the metadata from the image manifest.

Where should I put the required annotations?

Thanks!

Kind regards
Dennis

[tegioz]

Hi @dploeger 👋

You are right, at the moment AH only uses the annotations in the image manifest (of the default platform) and not the ones in the index manifest. This is something that we'd like to address, relying on the index manifest for multi-arch images. In the meantime, adding them to the image manifest of the linux/amd64 platform should do the trick.

Hope this helps 🙂

[dploeger]

But why doesn't it work then?

[tegioz]

I think it's because you're using the OCI manifest format.

% crane manifest ghcr.io/dodevops/cloudcontrol-azure:develop | jq .mediaType
"application/vnd.oci.image.index.v1+json"

As per the docs I linked before:

Depending on the image manifest format, metadata must be provided one way or another: images using OCI manifests must use annotations, whereas images using Docker V2 manifests must use config labels.

[dploeger]

Ah okay. I guess, the Github Action switches to that for whatever reason. Then I'm on the right path. Thanks. I'll just add those annotations anywhere I can find. 😆

[tegioz]

Hi @dploeger 👋

AH now supports annotations in the index manifest 🙂

Please note that they take precedence over the annotations/labels in the image, just in case you've them in both and they're different.

From https://artifacthub.io/docs/topics/repositories/container-images/:

[dploeger]

Great. Thanks! ♥️