image build: add annotations in OCI image #2522
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alban
requested review from
burak-ok,
mauriciovasquezbernal and
flyth
as code owners
alban
force-pushed
the
alban_annotations
branch
2 times, most recently
from
cef2326
to
ab06f39
Compare
alban
commented
Feb 26, 2024
docs/reference/oci.md
Outdated
| - layer | ||
|
|
||
| Inspektor Gadget adds the following annotations at the manifest and config levels: | ||
| - `io.artifacthub.package.readme-url`: defined by [ArtifactHUB](https://artifacthub.io/docs/topics/repositories/container-images/#image-metadata) |
There was a problem hiding this comment.
Following the discussion on artifacthub/hub#3665 (#2175):
New kinds of artifacts are encouraged to use the file artifacthub-pkg.yml file. So gadget authors would publish their gadgets on Artifact Hub by adding this file in their git repository. Artifact Hub would not fetch the annotations from the OCI image.
So I will remove this artifacthub annotation for now.
Note that users can always add custom OCI annotations in the annotations field of gadget.yaml.
alban
force-pushed
the
alban_annotations
branch
from
ab06f39
to
d8d7ac0
Compare
mauriciovasquezbernal
approved these changes
Feb 26, 2024
alban
force-pushed
the
alban_annotations
branch
from
d8d7ac0
to
bee635e
Compare
OCI images can have annotations at different levels: - index - manifest - config - layer This patch adds annotations in the index, manifest and config levels. The following annotations are automatically defined: - org.opencontainers.image.title - org.opencontainers.image.description - org.opencontainers.image.created - org.opencontainers.image.url - org.opencontainers.image.documentation - org.opencontainers.image.source Users can add custom images with the annotations field in gadget.yaml. Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
Signed-off-by: Alban Crequy <albancrequy@linux.microsoft.com>
alban
force-pushed
the
alban_annotations
branch
from
bee635e
to
e6d4458
Compare
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OCI images can have annotations at different levels:
This patch adds annotations in the index, manifest and config levels.
artifacthub reads annotations at the manifest level. The 3 required annotations from artifacthub are defined:
Users can add custom images with the
annotationsfield in gadget.yaml.#2175