Skip to content

Commit 9c714fb

Browse files
committed
docs: update the scan docs
Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>
1 parent e34b336 commit 9c714fb

File tree

8 files changed

+20
-10
lines changed

8 files changed

+20
-10
lines changed

docs/docs/references/configuration/cli/trivy_filesystem.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ trivy filesystem [flags] PATH
3535
- "precise": Prioritizes precise by minimizing false positives.
3636
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
3737
(allowed values: precise,comprehensive) (default "precise")
38+
--disable-metrics disable sending anonymous usage data to Aqua
3839
--distro string [EXPERIMENTAL] specify a distribution, <family>/<version>
3940
--download-db-only download/update vulnerability database but don't run a scan
4041
--download-java-db-only download/update Java index database but don't run a scan
@@ -83,7 +84,6 @@ trivy filesystem [flags] PATH
8384
--list-all-pkgs output all packages in the JSON report regardless of vulnerability
8485
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
8586
--module-dir string specify directory to the wasm modules that will be loaded (default "$HOME/.trivy/modules")
86-
--no-notices suppress notices about version updates and Trivy announcements
8787
--no-progress suppress progress bar
8888
--offline-scan do not issue API requests to identify dependencies
8989
-o, --output string output file name
@@ -126,6 +126,7 @@ trivy filesystem [flags] PATH
126126
--skip-dirs strings specify the directories or glob patterns to skip
127127
--skip-files strings specify the files or glob patterns to skip
128128
--skip-java-db-update skip updating Java index database
129+
--skip-version-check suppress notices about version updates and Trivy announcements
129130
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
130131
--table-mode strings [EXPERIMENTAL] tables that will be displayed in 'table' format (allowed values: summary,detailed) (default [summary,detailed])
131132
-t, --template string output template

docs/docs/references/configuration/cli/trivy_image.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ trivy image [flags] IMAGE_NAME
4949
- "precise": Prioritizes precise by minimizing false positives.
5050
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
5151
(allowed values: precise,comprehensive) (default "precise")
52+
--disable-metrics disable sending anonymous usage data to Aqua
5253
--distro string [EXPERIMENTAL] specify a distribution, <family>/<version>
5354
--docker-host string unix domain socket path to use for docker scanning
5455
--download-db-only download/update vulnerability database but don't run a scan
@@ -102,7 +103,6 @@ trivy image [flags] IMAGE_NAME
102103
--max-image-size string [EXPERIMENTAL] maximum image size to process, specified in a human-readable format (e.g., '44kB', '17MB'); an error will be returned if the image exceeds this size
103104
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
104105
--module-dir string specify directory to the wasm modules that will be loaded (default "$HOME/.trivy/modules")
105-
--no-notices suppress notices about version updates and Trivy announcements
106106
--no-progress suppress progress bar
107107
--offline-scan do not issue API requests to identify dependencies
108108
-o, --output string output file name
@@ -148,6 +148,7 @@ trivy image [flags] IMAGE_NAME
148148
--skip-dirs strings specify the directories or glob patterns to skip
149149
--skip-files strings specify the files or glob patterns to skip
150150
--skip-java-db-update skip updating Java index database
151+
--skip-version-check suppress notices about version updates and Trivy announcements
151152
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
152153
--table-mode strings [EXPERIMENTAL] tables that will be displayed in 'table' format (allowed values: summary,detailed) (default [summary,detailed])
153154
-t, --template string output template

docs/docs/references/configuration/cli/trivy_kubernetes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ trivy kubernetes [flags] [CONTEXT]
5151
- "precise": Prioritizes precise by minimizing false positives.
5252
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
5353
(allowed values: precise,comprehensive) (default "precise")
54+
--disable-metrics disable sending anonymous usage data to Aqua
5455
--disable-node-collector When the flag is activated, the node-collector job will not be executed, thus skipping misconfiguration findings on the node.
5556
--distro string [EXPERIMENTAL] specify a distribution, <family>/<version>
5657
--download-db-only download/update vulnerability database but don't run a scan
@@ -92,7 +93,6 @@ trivy kubernetes [flags] [CONTEXT]
9293
--kubeconfig string specify the kubeconfig file path to use
9394
--list-all-pkgs output all packages in the JSON report regardless of vulnerability
9495
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
95-
--no-notices suppress notices about version updates and Trivy announcements
9696
--no-progress suppress progress bar
9797
--node-collector-imageref string indicate the image reference for the node-collector scan job (default "ghcr.io/aquasecurity/node-collector:0.3.1")
9898
--node-collector-namespace string specify the namespace in which the node-collector job should be deployed (default "trivy-temp")
@@ -138,6 +138,7 @@ trivy kubernetes [flags] [CONTEXT]
138138
--skip-files strings specify the files or glob patterns to skip
139139
--skip-images skip the downloading and scanning of images (vulnerabilities and secrets) in the cluster resources
140140
--skip-java-db-update skip updating Java index database
141+
--skip-version-check suppress notices about version updates and Trivy announcements
141142
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
142143
-t, --template string output template
143144
--tf-exclude-downloaded-modules exclude misconfigurations for downloaded terraform modules

docs/docs/references/configuration/cli/trivy_repository.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ trivy repository [flags] (REPO_PATH | REPO_URL)
3535
- "precise": Prioritizes precise by minimizing false positives.
3636
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
3737
(allowed values: precise,comprehensive) (default "precise")
38+
--disable-metrics disable sending anonymous usage data to Aqua
3839
--download-db-only download/update vulnerability database but don't run a scan
3940
--download-java-db-only download/update Java index database but don't run a scan
4041
--enable-modules strings [EXPERIMENTAL] module names to enable
@@ -82,7 +83,6 @@ trivy repository [flags] (REPO_PATH | REPO_URL)
8283
--list-all-pkgs output all packages in the JSON report regardless of vulnerability
8384
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
8485
--module-dir string specify directory to the wasm modules that will be loaded (default "$HOME/.trivy/modules")
85-
--no-notices suppress notices about version updates and Trivy announcements
8686
--no-progress suppress progress bar
8787
--offline-scan do not issue API requests to identify dependencies
8888
-o, --output string output file name
@@ -124,6 +124,7 @@ trivy repository [flags] (REPO_PATH | REPO_URL)
124124
--skip-dirs strings specify the directories or glob patterns to skip
125125
--skip-files strings specify the files or glob patterns to skip
126126
--skip-java-db-update skip updating Java index database
127+
--skip-version-check suppress notices about version updates and Trivy announcements
127128
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
128129
--table-mode strings [EXPERIMENTAL] tables that will be displayed in 'table' format (allowed values: summary,detailed) (default [summary,detailed])
129130
--tag string pass the tag name to be scanned

docs/docs/references/configuration/cli/trivy_rootfs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ trivy rootfs [flags] ROOTDIR
3737
- "precise": Prioritizes precise by minimizing false positives.
3838
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
3939
(allowed values: precise,comprehensive) (default "precise")
40+
--disable-metrics disable sending anonymous usage data to Aqua
4041
--distro string [EXPERIMENTAL] specify a distribution, <family>/<version>
4142
--download-db-only download/update vulnerability database but don't run a scan
4243
--download-java-db-only download/update Java index database but don't run a scan
@@ -85,7 +86,6 @@ trivy rootfs [flags] ROOTDIR
8586
--list-all-pkgs output all packages in the JSON report regardless of vulnerability
8687
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
8788
--module-dir string specify directory to the wasm modules that will be loaded (default "$HOME/.trivy/modules")
88-
--no-notices suppress notices about version updates and Trivy announcements
8989
--no-progress suppress progress bar
9090
--offline-scan do not issue API requests to identify dependencies
9191
-o, --output string output file name
@@ -127,6 +127,7 @@ trivy rootfs [flags] ROOTDIR
127127
--skip-dirs strings specify the directories or glob patterns to skip
128128
--skip-files strings specify the files or glob patterns to skip
129129
--skip-java-db-update skip updating Java index database
130+
--skip-version-check suppress notices about version updates and Trivy announcements
130131
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
131132
--table-mode strings [EXPERIMENTAL] tables that will be displayed in 'table' format (allowed values: summary,detailed) (default [summary,detailed])
132133
-t, --template string output template

docs/docs/references/configuration/cli/trivy_sbom.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ trivy sbom [flags] SBOM_PATH
2929
- "precise": Prioritizes precise by minimizing false positives.
3030
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
3131
(allowed values: precise,comprehensive) (default "precise")
32+
--disable-metrics disable sending anonymous usage data to Aqua
3233
--distro string [EXPERIMENTAL] specify a distribution, <family>/<version>
3334
--download-db-only download/update vulnerability database but don't run a scan
3435
--download-java-db-only download/update Java index database but don't run a scan
@@ -64,7 +65,6 @@ trivy sbom [flags] SBOM_PATH
6465
--ignorefile string specify .trivyignore file (default ".trivyignore")
6566
--java-db-repository strings OCI repository(ies) to retrieve trivy-java-db in order of priority (default [mirror.gcr.io/aquasec/trivy-java-db:1,ghcr.io/aquasecurity/trivy-java-db:1])
6667
--list-all-pkgs output all packages in the JSON report regardless of vulnerability
67-
--no-notices suppress notices about version updates and Trivy announcements
6868
--no-progress suppress progress bar
6969
--offline-scan do not issue API requests to identify dependencies
7070
-o, --output string output file name
@@ -102,6 +102,7 @@ trivy sbom [flags] SBOM_PATH
102102
--skip-dirs strings specify the directories or glob patterns to skip
103103
--skip-files strings specify the files or glob patterns to skip
104104
--skip-java-db-update skip updating Java index database
105+
--skip-version-check suppress notices about version updates and Trivy announcements
105106
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
106107
--table-mode strings [EXPERIMENTAL] tables that will be displayed in 'table' format (allowed values: summary,detailed) (default [summary,detailed])
107108
-t, --template string output template

docs/docs/references/configuration/cli/trivy_vm.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ trivy vm [flags] VM_IMAGE
3333
- "precise": Prioritizes precise by minimizing false positives.
3434
- "comprehensive": Aims to detect more security findings at the cost of potential false positives.
3535
(allowed values: precise,comprehensive) (default "precise")
36+
--disable-metrics disable sending anonymous usage data to Aqua
3637
--distro string [EXPERIMENTAL] specify a distribution, <family>/<version>
3738
--download-db-only download/update vulnerability database but don't run a scan
3839
--download-java-db-only download/update Java index database but don't run a scan
@@ -77,7 +78,6 @@ trivy vm [flags] VM_IMAGE
7778
--list-all-pkgs output all packages in the JSON report regardless of vulnerability
7879
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
7980
--module-dir string specify directory to the wasm modules that will be loaded (default "$HOME/.trivy/modules")
80-
--no-notices suppress notices about version updates and Trivy announcements
8181
--no-progress suppress progress bar
8282
--offline-scan do not issue API requests to identify dependencies
8383
-o, --output string output file name
@@ -115,6 +115,7 @@ trivy vm [flags] VM_IMAGE
115115
--skip-dirs strings specify the directories or glob patterns to skip
116116
--skip-files strings specify the files or glob patterns to skip
117117
--skip-java-db-update skip updating Java index database
118+
--skip-version-check suppress notices about version updates and Trivy announcements
118119
--skip-vex-repo-update [EXPERIMENTAL] Skip VEX Repository update
119120
--table-mode strings [EXPERIMENTAL] tables that will be displayed in 'table' format (allowed values: summary,detailed) (default [summary,detailed])
120121
-t, --template string output template

docs/docs/references/configuration/config-file.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -579,13 +579,13 @@ repository:
579579
## Scan options
580580

581581
```yaml
582-
# Same as '--no-notices'
583-
no-notices: false
584-
585582
scan:
586583
# Same as '--detection-priority'
587584
detection-priority: "precise"
588585

586+
# Same as '--disable-metrics'
587+
disable-metrics: false
588+
589589
# Same as '--distro'
590590
distro: ""
591591

@@ -615,6 +615,9 @@ scan:
615615
# Same as '--skip-files'
616616
skip-files: []
617617

618+
# Same as '--skip-version-check'
619+
skip-version-check: false
620+
618621
```
619622
## Secret options
620623

0 commit comments

Comments
 (0)