Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: --host incorrectly documented as main command flag #1754

Closed
HariSekhon opened this issue May 16, 2023 · 3 comments · Fixed by #1760
Closed

docs: --host incorrectly documented as main command flag #1754

HariSekhon opened this issue May 16, 2023 · 3 comments · Fixed by #1760
Assignees
Labels
triaged The maintainers have seen this issue

Comments

@HariSekhon
Copy link

HariSekhon commented May 16, 2023

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
@samq-ws
Copy link

samq-ws commented May 16, 2023

Try putting --host after calling report

./clairctl  report alpine:latest --host clair

@hdonnay
Copy link
Member

hdonnay commented May 16, 2023

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

@hdonnay hdonnay self-assigned this May 16, 2023
@hdonnay hdonnay added the triaged The maintainers have seen this issue label May 16, 2023
@hdonnay hdonnay changed the title Docs Wrong? clairctl 4.6.0: "Incorrect Usage. flag provided but not defined: -host" docs: --host incorrectly documented as main command flag May 16, 2023
@HariSekhon
Copy link
Author

Yes, that worked, thanks.

The doc just needs updating to reflect this.

@hdonnay hdonnay linked a pull request May 17, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triaged The maintainers have seen this issue
Development

Successfully merging a pull request may close this issue.

3 participants