-
Notifications
You must be signed in to change notification settings - Fork 2
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
Updates K8s node scanning documentation #500
base: main
Are you sure you want to change the base?
Conversation
Starting creation of the PREview environment... |
PREview environment has been created at https://mondoo-pre-docs-2010572077.storage.googleapis.com/docs/index.html |
PREview has been updated at https://mondoo-pre-docs-2010572077.storage.googleapis.com/docs/index.html |
Converting to draft until @imilchev reviews and I make a change for clarity. |
docs/platform/infra/cloud/kubernetes/scan-kubernetes-with-operator.md
Outdated
Show resolved
Hide resolved
Updating wording per Ivan Signed-off-by: scottford-io <[email protected]>
36e6080
to
505811a
Compare
PREview has been updated at https://mondoo-pre-docs-2010572077.storage.googleapis.com/docs/index.html |
@misterpantz I think this one is GTG. |
|
||
- We strongly recommend that you leave **CronJob-based** selected. It's ideal for most infrastructures. A CronJob executes regularly to run the scans without permanently allocating any resources for Mondoo on cluster nodes. | ||
Mondoo can scan both a Kubernetes (K8s) cluster using the Mondoo K8s Operator as well as the account (AWS account, GCP project, or Azure subscription) where the cluster is deployed. To avoid duplication of assets, if the account is integrated with VM scanning enabled, or if you plan to enable it, ensure that Node Scanning is disabled for the Kubernetes cluster. |
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.
Mondoo can scan both a Kubernetes (K8s) cluster using the Mondoo K8s Operator as well as the account (AWS account, GCP project, or Azure subscription) where the cluster is deployed. To avoid duplication of assets, if the account is integrated with VM scanning enabled, or if you plan to enable it, ensure that Node Scanning is disabled for the Kubernetes cluster. | |
Mondoo can scan Kubernetes clusters in two ways: | |
- Directly, using the Mondoo Kubernetes Operator | |
- As part of the cloud account (AWS account, GCP project, or Azure subscription) where the cluster is deployed | |
If you enable (or plan to enable) VM scanning when you set up your AWS, GCP, or Azure integration AND you enable **Scan nodes** in your Kubernetes integration, you create duplicate assets (two of the same cluster). To prevent this, be sure to disable **Scan nodes** in the Kubernetes integration. |
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.
It's not that easy to understand, I'm afraid. Partly just because it's a hard thing to describe but also because (1) the setting name is different than in the UI and (2) the structure.
Does my suggestion help without mucking up the meaning?
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.
@misterpantz I think your change is drastically better! 🙌 🥳
I have slight tweaks that you can take or leave:
Mondoo can scan both a Kubernetes (K8s) cluster using the Mondoo K8s Operator as well as the account (AWS account, GCP project, or Azure subscription) where the cluster is deployed. To avoid duplication of assets, if the account is integrated with VM scanning enabled, or if you plan to enable it, ensure that Node Scanning is disabled for the Kubernetes cluster. | |
Mondoo can scan Kubernetes clusters in two ways: | |
- **Directly**, using the Mondoo Kubernetes Operator. | |
- **Indirectly**, as part of the cloud account (AWS account, GCP project, or Azure subscription) where the cluster is deployed. | |
If both VM scanning is enabled for your cloud account integration and Scan nodes is enabled for your Kubernetes integration, this will create duplicate assets (the same cluster appearing twice). To avoid duplication, disable Scan nodes in your Kubernetes integration. |
The only other thought I had would be to add something explaining Scan nodes:
What is “Scan nodes”?
This setting allows Mondoo to scan Kubernetes cluster nodes directly. If you’re scanning the cloud account, the nodes will already be scanned as part of VM scanning.
For steps to disable Scan nodes, see [link to instructions].
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.
Because you're adding this note WITHIN the instructions, right below the step that tells you to enable Scan nodes if you want to assess the security posture of nodes in your Kubernetes cluster, there's no need to link to it. :)
And I don't want to reintroduce the passive voice. Active voice makes it clear that you/your team is doing the enabling.
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.
This has some of your suggestions and some of mine:
Mondoo can scan both a Kubernetes (K8s) cluster using the Mondoo K8s Operator as well as the account (AWS account, GCP project, or Azure subscription) where the cluster is deployed. To avoid duplication of assets, if the account is integrated with VM scanning enabled, or if you plan to enable it, ensure that Node Scanning is disabled for the Kubernetes cluster. | |
Mondoo can scan Kubernetes clusters in two ways: | |
- Directly, using the Mondoo Kubernetes Operator | |
- Indirectly, as part of the cloud account (AWS account, GCP project, or Azure subscription) where the cluster is deployed | |
If you enable **Scan virtual machines** in your cloud account integration AND your enable **Scan nodes** in your Kubernetes integration, Mondoo creates duplicate assets (the same cluster represented twice). To prevent duplication, disable **Scan nodes** in your Kubernetes integration. |
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.
Oh crap... I just checked and, of the cloud integrations you listed, the only one that has a Scan virtual machines option is Azure!
Description
From @imilchev :
Related issue
Types of changes
Checklist