imageverifier plugin CLI Arguments format issue

[arronwy]

Description

https://github.com/containerd/containerd/blob/main/docs/image-verification.md#cli-arguments

https://github.com/containerd/containerd/blob/main/pkg/imageverifier/bindir/bindir.go#L118-L121

normally the command line should support short or long two types flags:

-n: The given reference to the image that may be pulled.
-d: The resolved digest of the image that may be pulled.
-s: The media type of the JSON data passed to stdin.

--name: The given reference to the image that may be pulled.
--digest: The resolved digest of the image that may be pulled.
--stdin-media-type: The media type of the JSON data passed to stdin.

But current CLI Arguments use single-dash arguments with longer names, it may not suitable as binary API

Steps to reproduce the issue

Describe the results you received and expected

--name: The given reference to the image that may be pulled.
--digest: The resolved digest of the image that may be pulled.
--stdin-media-type: The media type of the JSON data passed to stdin.

What version of containerd are you using?

latest main branch

Any other relevant information

No response

Show configuration if it is related to CRI plugin.

No response

[Anish-M]

Hi, I'd like to take on this issue if possible.

[arronwy]

Hi, I'd like to take on this issue if possible.

@Anish-M sure, Thanks a lot!

[Anish-M]

@arronwy I have some local containerd code I'm trying to test out, how do I run the default image-verifier plugin? Also I launched the build env with codespaces by I don't see any /opt/containerd/config.toml though I do believe that the image-verifier plugin is already setup correctly

[arronwy]

Hi @Anish-M ， we can build the containerd from main branch:

containerd --version
containerd github.com/containerd/containerd v2.0.0-rc.0-71-g831795901.m 8317959018015f6a1756ec8cd08be1093fd630a2.m

Check whether containerd image-verifier plugin status:

 ctr plugin ls
TYPE                                   ID                       PLATFORMS      STATUS
io.containerd.image-verifier.v1        bindir                   -              ok

Check contianerd default config:

containerd config default

  [plugins.'io.containerd.image-verifier.v1.bindir']
    bin_dir = '/opt/containerd/image-verifier/bin'
    max_verifiers = 10
    per_verifier_timeout = '10s'

The image-verifier binary should under directory: /opt/containerd/image-verifier/bin

[Anish-M]

I don't see any image-verifier directory at that location, how can I build or compile the image-verifier plugin to get the binary there?

[dmcgowan]

But current CLI Arguments use single-dash arguments with longer names, it may not suitable as binary API

@arronwy Can you give more detail why it may not be suitable?