quay / clair

Vulnerability Static Analysis for Containers

Home Page:https://quay.github.io/clair/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docs: `--host` incorrectly documented as main command flag

HariSekhon opened this issue · comments

Description of Problem / Feature Request

Clairctl at this page seems wrong:

https://quay.github.io/clair/howto/getting_started.html#submitting-a-manifest

Expected Outcome

Output of CVEs

Actual Outcome

$ curl -L https://github.com/quay/clair/releases/download/v4.6.1/clairctl-linux-amd64 -o clairctl && chmod +x clairctl

$ ./clairctl --version
clairctl version v4.6.0-7-g36990912

From this doc:

https://quay.github.io/clair/howto/getting_started.html#submitting-a-manifest

$ ./clairctl --host clair report alpine:latest
Incorrect Usage. flag provided but not defined: -host

NAME:
   clairctl - interact with a clair API

USAGE:
   clairctl [global options] command [command options] [arguments...]

VERSION:
   v4.6.0-7-g36990912

DESCRIPTION:
   A command-line tool for clair v4.

COMMANDS:
   manifest         print a clair manifest for the named container
   report           request vulnerability reports for the named containers
   export-updaters  run updaters and export results
   import-updaters  import updates
   delete           deletes index reports for given manifest digests
   help, h          Shows a list of commands or help for one command

GLOBAL OPTIONS:
   -D                           print debugging logs (default: false)
   -q                           quieter log output (default: false)
   --config value, -c value     clair configuration file (default: "config.yaml") [$CLAIR_CONF]
   --issuer value, --iss value  jwt "issuer" to use when making authenticated requests (default: "clairctl")
   --help, -h                   show help (default: false)
   --version, -v                print the version (default: false)

Environment

  • Clair version/image: N/A
  • Clair client name/version: 4.6.0-7
  • Host OS: Linux
  • Kernel (e.g. uname -a): Linux 5.10.162+
  • Kubernetes version (use kubectl version): v1.22.17-gke.5400
  • Network/Firewall setup: GKE

Try putting --host after calling report

./clairctl  report alpine:latest --host clair

Yeah, the docs have the flag in the wrong spot.

Yes, that worked, thanks.

The doc just needs updating to reflect this.