doc/containerized-gadgets: Update Packaging chapter to reflect current status #1968
Conversation
burak-ok
force-pushed
the
burak/cg/doc_spec
branch
from
6d4d87f
to
5a5defa
Compare
Signed-off-by: Burak Ok <burakok@microsoft.com>
burak-ok
force-pushed
the
burak/cg/doc_spec
branch
from
5a5defa
to
76b0ea0
Compare
|
|
||
| TODO: How the user could specify these annotations when using the build command? | ||
|
|
||
| ### Definition File | ||
| ### Definition File <a name="def-file"></a> |
There was a problem hiding this comment.
nit: This change is not needed, you can create anchor links in md files just by doing [Tittle of link](#name-of-section-to-link), in this case [the definition file](#definition-file), see more here.
| The OCI image should contain the following [OCI annotations](https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys): | ||
| - `org.opencontainers.image.title` | ||
| - `org.opencontainers.image.description` | ||
| - `org.opencontainers.image.url` | ||
|
|
||
| TODO: How the user could specify these annotations when using the build command? |
There was a problem hiding this comment.
I suggest to allow specifying them in the build command like fpm that allows specifying --license, --url, --description, etc.
However, I was wondering why not to move the author and description info into the definition file? Or maybe the convention is to have this info as annotations?
There was a problem hiding this comment.
Nothing is set in stone and everything is still experimental - I also don't know the best place :D
I have chosen to put it in an annotation on the eBPF layer so the author is tied to the eBPF code. The definition file is "just" a file which tells Inspektor Gadget which fields of the struct should be shown -> Nothing "to author" here
There was a problem hiding this comment.
Makes sense, so we can go with the same approach of fpm.
| "mediaType": "application/vnd.gadget.config.v1+yaml", | ||
| "digest": "sha256:eb71861c0a5d5ca9a706fffa20fead54f64a1624dfeef5d334a8a3c2462c4c37", | ||
| "size": 628, | ||
| "annotations": { | ||
| "org.opencontainers.image.title": "config.yaml" |
There was a problem hiding this comment.
It is called "Definition file" in the documentation but config here. I think it might lead to confusion when ppl will start referring to it some times as configuration or and some others as definition file. Maybe definition.yaml or def.yaml?
There was a problem hiding this comment.
I am also confused by it a lot xD I would change that in another PR which also modifies the ig image build command
doc/containerized-gadgets: Update Packaging chapter to reflect current status
Updates the documentation about the packaging of containerized gadgets.