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: add kbom documentation #5363

Merged
merged 3 commits into from
Oct 13, 2023
Merged

docs: add kbom documentation #5363

merged 3 commits into from
Oct 13, 2023

Conversation

itaysk
Copy link
Contributor

@itaysk itaysk commented Oct 11, 2023

Description

Improve documentation for Kuberetes and specifically kbom vulnerability matching

Related issues

Related PRs

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@itaysk
Copy link
Contributor Author

itaysk commented Oct 11, 2023

FYI @AnaisUrlichs

docs/docs/coverage/kubernetes.md Show resolved Hide resolved
Comment on lines +23 to +25
- Vulnerabilities - partially supported through [KBOM scanning](#KBOM)
- Misconfigurations
- Exposed secrets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Vulnerabilities - partially supported through [KBOM scanning](#KBOM)
- Misconfigurations
- Exposed secrets
- Vulnerabilities - partially supported through [KBOM scanning](#KBOM)
- Misconfigurations
- Exposed secrets
- Rbac Assessment

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part relates to Kubernetes resource definitions, like pods or deployment, which are not scanned for RBAC (AFAIK)
RBAC assessment is related to the "cluster configuration" part, as appears above, which explicitly mentions roles and cluster roles.
I you wan't can add another section specifically about brace assessment (as an update to this doc)

1. Cluster configuration (e.g Roles, ClusterRoles).
1. Application workloads (e.g nginx, postgresql).

When scanning any of the above, Trivy differentiates between the Kubernetes Resource definition (i.e the YAML that defines it), and the container image if relevant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here as in the other docs -- why is it the same under Target as in Coverage? is it necessary to duplicate the information or could we refer here to the Coverage docs above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the coverage section a high level overview of what things trivy can scan. the detailed info is in the relevant sections. I didn't feel like k8s bulbs belong under one of the existing coverage sections: OS/IaC so I added another section.

Copy link
Contributor

@AnaisUrlichs AnaisUrlichs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a few comments

@knqyf263 knqyf263 added this pull request to the merge queue Oct 13, 2023
@knqyf263
Copy link
Collaborator

@chen-keinan @AnaisUrlichs I'll merge this PR for v0.46.0. Let's keep discussing improvements after the release.

Merged via the queue into aquasecurity:main with commit 0c3e2f0 Oct 13, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants