-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: update info about config file #6547
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
Changes from 3 commits
9999365
6fc9a55
80d3a4f
15e6fca
6136a99
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -81,6 +81,15 @@ severity: | |||||||||||||
| - MEDIUM | ||||||||||||||
| - HIGH | ||||||||||||||
| - CRITICAL | ||||||||||||||
|
|
||||||||||||||
| scan: | ||||||||||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We use trivy/pkg/flag/report_flags.go Line 101 in fae710d
But looks like it should be report.@knqyf263 wdyt?
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, agree. Also, trivy/pkg/flag/report_flags.go Line 106 in fae710d
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. hm... there is 1 problem: trivy/pkg/flag/report_flags.go Line 35 in fae710d
We can add
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Flags frequently used can be global without the
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Ah, I missed it. Hmm... it's a problem... |
||||||||||||||
| # Same as '--compliance' | ||||||||||||||
| # Default is empty | ||||||||||||||
| compliance: | ||||||||||||||
|
|
||||||||||||||
| # Same as '--show-suppressed' | ||||||||||||||
| # Default is false | ||||||||||||||
| show-suppressed: false | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Scan Options | ||||||||||||||
|
|
@@ -106,7 +115,7 @@ scan: | |||||||||||||
|
|
||||||||||||||
| # Same as '--offline-scan' | ||||||||||||||
| # Default is false | ||||||||||||||
| offline-scan: false | ||||||||||||||
| offline: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--scanners' | ||||||||||||||
| # Default depends on subcommand | ||||||||||||||
|
|
@@ -115,6 +124,24 @@ scan: | |||||||||||||
| - misconfig | ||||||||||||||
| - secret | ||||||||||||||
| - license | ||||||||||||||
| - | ||||||||||||||
| # Same as '--parallel' | ||||||||||||||
| # Default is 5 | ||||||||||||||
| parallel: 1 | ||||||||||||||
|
|
||||||||||||||
| # Same as '--sbom-sources' | ||||||||||||||
| # Default is empty | ||||||||||||||
| sbom-sources: | ||||||||||||||
| - oci | ||||||||||||||
| - rekor | ||||||||||||||
|
|
||||||||||||||
| # Same as '--rekor-url' | ||||||||||||||
| # Default is 'https://rekor.sigstore.dev' | ||||||||||||||
| rekor-url: https://rekor.sigstore.dev | ||||||||||||||
|
|
||||||||||||||
| # Same as '--include-dev-deps' | ||||||||||||||
| # Default is false | ||||||||||||||
| include-dev-deps: false | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Cache Options | ||||||||||||||
|
|
@@ -131,6 +158,9 @@ cache: | |||||||||||||
|
|
||||||||||||||
| # Redis options | ||||||||||||||
| redis: | ||||||||||||||
| # Same as '--redis-tls' | ||||||||||||||
| # Default is false | ||||||||||||||
| tls: | ||||||||||||||
| # Same as '--redis-ca' | ||||||||||||||
| # Default is empty | ||||||||||||||
| ca: | ||||||||||||||
|
|
@@ -148,21 +178,25 @@ cache: | |||||||||||||
|
|
||||||||||||||
| ```yaml | ||||||||||||||
| db: | ||||||||||||||
| # Same as '--skip-db-update' | ||||||||||||||
| # Default is false | ||||||||||||||
| skip-update: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--no-progress' | ||||||||||||||
| # Default is false | ||||||||||||||
| no-progress: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--skip-db-update' | ||||||||||||||
| # Default is false | ||||||||||||||
| skip-update: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--db-repository' | ||||||||||||||
| # Default is 'ghcr.io/aquasecurity/trivy-db' | ||||||||||||||
| repository: ghcr.io/aquasecurity/trivy-db | ||||||||||||||
| # Default is 'ghcr.io/aquasecurity/trivy-db:2' | ||||||||||||||
| repository: ghcr.io/aquasecurity/trivy-db:2 | ||||||||||||||
|
|
||||||||||||||
| # Same as '--skip-java-db-update' | ||||||||||||||
| # Default is false | ||||||||||||||
| java-skip-update: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--java-db-repository' | ||||||||||||||
| # Default is 'ghcr.io/aquasecurity/trivy-java-db' | ||||||||||||||
| java-repository: ghcr.io/aquasecurity/trivy-java-db | ||||||||||||||
| # Default is 'ghcr.io/aquasecurity/trivy-java-db:1' | ||||||||||||||
| java-repository: ghcr.io/aquasecurity/trivy-java-db:1 | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Registry Options | ||||||||||||||
|
|
@@ -197,7 +231,19 @@ image: | |||||||||||||
|
|
||||||||||||||
| # Same as '--platform' | ||||||||||||||
| # Default is empty | ||||||||||||||
| platform: | ||||||||||||||
| platform: | ||||||||||||||
|
|
||||||||||||||
| # Same as '--image-src' | ||||||||||||||
| # Default is 'docker,containerd,podman,remote' | ||||||||||||||
| source: | ||||||||||||||
| - podman | ||||||||||||||
| - docker | ||||||||||||||
|
|
||||||||||||||
| # Same as '--image-config-scanners' | ||||||||||||||
| # Default is empty | ||||||||||||||
| image-config-scanners: | ||||||||||||||
| - misconfig | ||||||||||||||
| - secret | ||||||||||||||
|
|
||||||||||||||
| docker: | ||||||||||||||
| # Same as '--docker-host' | ||||||||||||||
|
|
@@ -224,6 +270,67 @@ vulnerability: | |||||||||||||
| # Same as '--ignore-unfixed' | ||||||||||||||
| # Default is false | ||||||||||||||
| ignore-unfixed: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--ignore-unfixed' | ||||||||||||||
| # Default is empty | ||||||||||||||
| ignore-status: | ||||||||||||||
| - end_of_life | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## License Options | ||||||||||||||
| Available with license scanning | ||||||||||||||
|
|
||||||||||||||
| ```yaml | ||||||||||||||
| license: | ||||||||||||||
| # Same as '--license-full' | ||||||||||||||
| # Default is false | ||||||||||||||
| full: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--ignored-licenses' | ||||||||||||||
| # Default is empty | ||||||||||||||
| ignored: | ||||||||||||||
| - MPL-2.0 | ||||||||||||||
| - MIT | ||||||||||||||
|
|
||||||||||||||
| # Same as '--license-confidence-level' | ||||||||||||||
| # Default is 0.9 | ||||||||||||||
| confidenceLevel: 0.9 | ||||||||||||||
|
|
||||||||||||||
| # Set list of forbidden licenses | ||||||||||||||
| # Default is https://github.com/aquasecurity/trivy/blob/164b025413c5fb9c6759491e9a306b46b869be93/pkg/licensing/category.go#L171 | ||||||||||||||
| forbidden: | ||||||||||||||
| - AGPL-1.0 | ||||||||||||||
| - AGPL-3.0 | ||||||||||||||
|
|
||||||||||||||
| # Set list of restricted licenses | ||||||||||||||
| # Default is https://github.com/aquasecurity/trivy/blob/164b025413c5fb9c6759491e9a306b46b869be93/pkg/licensing/category.go#L199 | ||||||||||||||
| restricted: | ||||||||||||||
| - AGPL-1.0 | ||||||||||||||
| - AGPL-3.0 | ||||||||||||||
|
|
||||||||||||||
| # Set list of reciprocal licenses | ||||||||||||||
| # Default is https://github.com/aquasecurity/trivy/blob/164b025413c5fb9c6759491e9a306b46b869be93/pkg/licensing/category.go#L238 | ||||||||||||||
| reciprocal: | ||||||||||||||
| - AGPL-1.0 | ||||||||||||||
| - AGPL-3.0 | ||||||||||||||
|
|
||||||||||||||
| # Set list of notice licenses | ||||||||||||||
| # Default is https://github.com/aquasecurity/trivy/blob/164b025413c5fb9c6759491e9a306b46b869be93/pkg/licensing/category.go#L260 | ||||||||||||||
| notice: | ||||||||||||||
| - AGPL-1.0 | ||||||||||||||
| - AGPL-3.0 | ||||||||||||||
|
|
||||||||||||||
| # Set list of permissive licenses | ||||||||||||||
| # Default is empty | ||||||||||||||
| permissive: | ||||||||||||||
| - AGPL-1.0 | ||||||||||||||
| - AGPL-3.0 | ||||||||||||||
|
|
||||||||||||||
| # Set list of unencumbered licenses | ||||||||||||||
| # Default is https://github.com/aquasecurity/trivy/blob/164b025413c5fb9c6759491e9a306b46b869be93/pkg/licensing/category.go#L334 | ||||||||||||||
| unencumbered: | ||||||||||||||
| - AGPL-1.0 | ||||||||||||||
| - AGPL-3.0 | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Secret Options | ||||||||||||||
|
|
@@ -239,11 +346,15 @@ secret: | |||||||||||||
| ## Rego Options | ||||||||||||||
|
|
||||||||||||||
| ```yaml | ||||||||||||||
| rego | ||||||||||||||
| rego: | ||||||||||||||
| # Same as '--trace' | ||||||||||||||
| # Default is false | ||||||||||||||
| trace: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--skip-policy-update' | ||||||||||||||
| # Default is false | ||||||||||||||
| skip-policy-update: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--config-policy' | ||||||||||||||
| # Default is empty | ||||||||||||||
| policy: | ||||||||||||||
|
|
@@ -271,6 +382,10 @@ misconfiguration: | |||||||||||||
| # Same as '--include-non-failures' | ||||||||||||||
| # Default is false | ||||||||||||||
| include-non-failures: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--policy-bundle-repository' | ||||||||||||||
| # Default is 'ghcr.io/aquasecurity/trivy-policies:0' | ||||||||||||||
| policy-bundle-repository: ghcr.io/aquasecurity/trivy-policies:0 | ||||||||||||||
DmitriyLewen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
|
|
||||||||||||||
| # Same as '--miconfig-scanners' | ||||||||||||||
| # Default is all scanners | ||||||||||||||
|
|
@@ -313,6 +428,12 @@ misconfiguration: | |||||||||||||
| # Same as '--tf-exclude-downloaded-modules' | ||||||||||||||
| # Default is false | ||||||||||||||
| exclude-downloaded-modules: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--cf-params' | ||||||||||||||
| # Default is false | ||||||||||||||
| cloudformation: | ||||||||||||||
| params: | ||||||||||||||
| - params.json | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Kubernetes Options | ||||||||||||||
|
|
@@ -327,6 +448,63 @@ kubernetes: | |||||||||||||
| # Same as '--namespace' | ||||||||||||||
| # Default is empty | ||||||||||||||
| namespace: | ||||||||||||||
|
|
||||||||||||||
| # Same as '--kubeconfig' | ||||||||||||||
| # Default is empty | ||||||||||||||
| kubeconfig: ~/.kube/config2 | ||||||||||||||
|
|
||||||||||||||
| # Same as '--components' | ||||||||||||||
| # Default is 'workload,infra' | ||||||||||||||
| components: | ||||||||||||||
| - workload | ||||||||||||||
| - infra | ||||||||||||||
|
|
||||||||||||||
| # Same as '--tolerations' | ||||||||||||||
| # Default is empty | ||||||||||||||
| tolerations: | ||||||||||||||
| - key1=value1:NoExecute | ||||||||||||||
| - key2=value2:NoSchedule | ||||||||||||||
|
|
||||||||||||||
| # Same as '--qps' | ||||||||||||||
| # Default is 5.0 | ||||||||||||||
| qps: 5.0 | ||||||||||||||
|
|
||||||||||||||
| # Same as '--burst' | ||||||||||||||
| # Default is 10 | ||||||||||||||
| burst: 10 | ||||||||||||||
|
|
||||||||||||||
| exclude: | ||||||||||||||
| # Same as '--exclude-owned' | ||||||||||||||
| # Default is false | ||||||||||||||
| owned: true | ||||||||||||||
|
|
||||||||||||||
| # Same as '--exclude-nodes' | ||||||||||||||
| # Default is empty | ||||||||||||||
| nodes: | ||||||||||||||
| - kubernetes.io/arch:arm64 | ||||||||||||||
| - team:dev | ||||||||||||||
|
|
||||||||||||||
| # Same as '--all-namespaces' | ||||||||||||||
| # Default is false | ||||||||||||||
| all: | ||||||||||||||
| namespaces: false | ||||||||||||||
|
|
||||||||||||||
| # Same as '--k8s-version' | ||||||||||||||
| # Default is empty | ||||||||||||||
| k8s: | ||||||||||||||
| version: 1.21.0 | ||||||||||||||
|
|
||||||||||||||
| # Same as '--node-collector-imageref' | ||||||||||||||
| # Default is 'ghcr.io/aquasecurity/node-collector:0.0.9' | ||||||||||||||
| node: | ||||||||||||||
| collector: | ||||||||||||||
| imageref: ghcr.io/aquasecurity/node-collector:0.0.9 | ||||||||||||||
|
|
||||||||||||||
| # Same as '--node-collector-namespace' | ||||||||||||||
| # Default is 'trivy-temp' | ||||||||||||||
| node: | ||||||||||||||
| collector: | ||||||||||||||
| namespace: ~/.kube/config2 | ||||||||||||||
|
||||||||||||||
| NodeCollectorImageRef = Flag[string]{ | |
| Name: "node-collector-imageref", | |
| ConfigName: "kubernetes.node.collector.imageref", | |
| Default: "ghcr.io/aquasecurity/node-collector:0.0.9", | |
| Usage: "indicate the image reference for the node-collector scan job", | |
| } |
we can use kubernetes.node-collector-imageref and get :
kubernetes
node-collector-imageref: ghcr.io/aquasecurity/node-collector:0.0.9There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DmitriyLewen sound good. you can update this flag as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chen-keinan take a looks, please - 15e6fca
Uh oh!
There was an error while loading. Please reload this page.