docs: add terminology page to explain Trivy concepts #7996
Conversation
Signed-off-by: knqyf263 <knqyf263@gmail.com>
|
@aquasecurity/trivy The definition of the terminology system will be helpful for our communication and document updates, so please look over it and feel free to leave any feedback. |
knqyf263
added
the
kind/documentation
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Co-authored-by: simar7 <1254783+simar7@users.noreply.github.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
|
LGTM, but I'll wait for @nikpivkin and @DmitriyLewen to also take a look. |
| Types of artifacts that Trivy can scan, like container images and filesystem. | ||
|
|
||
| ### Scanner | ||
| Trivy's built-in security scanning engines. Trivy has four main scanners: |
There was a problem hiding this comment.
The scanners flag only allows these 4 scanners.
But there is "shadow" scanner sbom (e.g. when we use the SBOM format).
Is it worth mentioning?
There was a problem hiding this comment.
Makes sense. Mentioned.
6e8cf5f
docs/docs/references/terminology.md
Outdated
| - https://github.com/aquasecurity/vuln-list-redhat | ||
| - https://github.com/aquasecurity/vuln-list-debian | ||
| - etc. | ||
| - |
There was a problem hiding this comment.
This - creates extra dot:
There was a problem hiding this comment.
Thanks. Deleted 26d3cf4
Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>
Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
|
@knqyf263 can you rewrite CLA? |
|
Tip: You can request that the CLA assistant run again by https://cla-assistant.io/check/aquasecurity/trivy?pullRequest=7996. |
Description
This PR adds a new terminology page that documents the key concepts and terms used in Trivy.
The page covers core components, scanning features, and infrastructure elements.
Note: The term "Scan Assets" is newly introduced in this PR to collectively refer to external data that Trivy downloads and uses during scanning (e.g., vulnerability database, Java database, checks bundle).
The goal is to provide a single source of truth for Trivy terminology and help users better understand the project's architecture and components.
Checklist