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

Airgap documentation lists incorrect commands #1122

Closed
dmc5179 opened this issue Nov 12, 2020 · 2 comments · Fixed by #1157
Closed

Airgap documentation lists incorrect commands #1122

dmc5179 opened this issue Nov 12, 2020 · 2 comments · Fixed by #1157
Assignees
Labels
area/usability related to improving user experience

Comments

@dmc5179
Copy link

dmc5179 commented Nov 12, 2020

Description of Problem / Feature Request

Documentation here: https://github.com/quay/clair/blob/main/Documentation/concepts/updatersandairgap.md

shows the clairctl commands as:

clairctl updater-export
clairctl updater-import

But the clairctl command shows them as:

export-updaters run updaters and export results
import-updaters import updates

Expected Outcome

Doc and command to match

Actual Outcome

Doc and command do not match

Environment

  • Clair version/image: latest as of right now
  • Clair client name/version: clairctl 0.1.0
  • Host OS: fedora 31
  • Kernel (e.g. uname -a): Linux localhost.localdomain 5.7.15-100.fc31.x86_64 Docs: fix some typos in README.md #1 SMP Tue Aug 11 17:18:01 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
  • Kubernetes version (use kubectl version): Client Version: 4.6.3
    Server Version: 4.6.3
    Kubernetes Version: v1.19.0+9f84db3
  • Network/Firewall setup: firewalld running
@dmc5179
Copy link
Author

dmc5179 commented Nov 12, 2020

The documentation also doesn't seem to mention that I need to have my config.yaml in order to run this command. I tried using the config.yaml.sample in this repo but that failed:

export CLAIR_CONF=/home/danclark/workspace/clair/config.yaml.sample
clairctl export-updaters --strict updates.sample.tgz
2020/11/11 21:24:25 yaml: line 30: found character that cannot start any token

That issue appears to be because the config.yaml.sample file has tabs instead of space in it. It also appears to have other issues that prevent me from using it:

clairctl export-updaters --strict updates.sample.tgz
updating errors:
	alpine-main-v3.8-updater: failed to parse the fetched vulnerability database: yaml: unmarshal errors:
  line 838: mapping key "1.8.3-r1" already defined at line 836
	alpine-main-v3.7-updater: failed to parse the fetched vulnerability database: yaml: unmarshal errors:
  line 707: mapping key "1.8.3-r1" already defined at line 705

So I just pulled the config.yaml from quay/clair running in my OpenShift cluster. When I use that with clairctl the export works just fine.

@ldelossa ldelossa added the area/usability related to improving user experience label Nov 12, 2020
@ldelossa
Copy link
Contributor

ldelossa commented Jan 4, 2021

@hdonnay ping on this.

hdonnay added a commit that referenced this issue Jan 6, 2021
It seems I didn't check I used the real subcommand names when writing this.

Closes #1122
@hdonnay hdonnay closed this as completed in a3bb1b6 Jan 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/usability related to improving user experience
Development

Successfully merging a pull request may close this issue.

3 participants