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

Updates to KSPM Integration README #3964

Merged
merged 4 commits into from
Aug 14, 2022
Merged

Updates to KSPM Integration README #3964

merged 4 commits into from
Aug 14, 2022

Conversation

tinnytintin10
Copy link
Contributor

What does this PR do?

Updates to the readme of the KSPM integration to include

  1. More robust documentation about the KSPM capability
  2. Details on permissions needed to run integration on EKS clusters

Beyond these two main changes, all the other changes were cosmetic updates to the structure/order of the different sections in the readme.

@tinnytintin10 tinnytintin10 added documentation Improvements or additions to documentation 8.4 candidate labels Aug 5, 2022
@tinnytintin10 tinnytintin10 linked an issue Aug 5, 2022 that may be closed by this pull request
2 tasks
@elasticmachine
Copy link

elasticmachine commented Aug 5, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-08-12T19:37:03.876+0000

  • Duration: 16 min 59 sec

Test stats 🧪

Test Results
Failed 0
Passed 2
Skipped 0
Total 2

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented Aug 5, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (0/0) 💚
Files 100.0% (0/0) 💚
Classes 100.0% (0/0) 💚
Methods 25.0% (1/4)
Lines 100.0% (0/0) 💚
Conditionals 100.0% (0/0) 💚

Copy link
Contributor

@DaveSys911 DaveSys911 left a comment

Choose a reason for hiding this comment

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

snippet in suggestion

tinnytintin10 and others added 2 commits August 11, 2022 08:16
Co-authored-by: David Natachanny <david.natachanny@elastic.co>
@tinnytintin10 tinnytintin10 marked this pull request as ready for review August 11, 2022 16:21
@tinnytintin10 tinnytintin10 requested a review from a team as a code owner August 11, 2022 16:21
@tinnytintin10 tinnytintin10 requested review from eyalkraft, amirbenun and kfirpeled and removed request for eyalkraft August 11, 2022 16:21
@tinnytintin10
Copy link
Contributor Author

@amirbenun @kfirpeled @amirbenun can y'all please review for technical accuracy? thx!

@ofiriro3
Copy link
Contributor

@tinnytintin10 Are we planning to add EKS screenshots as well as part of this PR?

Copy link
Contributor

@eyalkraft eyalkraft left a comment

Choose a reason for hiding this comment

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

Looks good!
Merging In order to let @uri-weisman go ahed with his #3968
Will bump version in a follow up PR - #3997

Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

Looks good overall, left some minor suggestions. Not sure about the formatting for links etc. in a readme so couldn't check you on that.


## Leader election
1. Identify and remediate misconfigurations
2. Understand the overall security posture of their Kubernetes clusters both- individually and holistically
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
2. Understand the overall security posture of their Kubernetes clusters both- individually and holistically
2. Understand the overall security posture of their Kubernetes clusters, both individually and holistically


Cluster level data example: List of the running pods.
Node level data example: kubelet configuration.
After this integration has been installed for the first time, the following assets will get created and made available in the Security solution UI:
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
After this integration has been installed for the first time, the following assets will get created and made available in the Security solution UI:
After this integration has been installed for the first time, the following assets will get created and made available in the Elastic Security UI:


| Asset | Description |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Posture Dashboard | The posture dashboard provides an overview of the security posture of all Kubernetes clusters monitored |
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
| Posture Dashboard | The posture dashboard provides an overview of the security posture of all Kubernetes clusters monitored |
| Cloud Posture dashboard | The Cloud Posture dashboard provides an overview of the security posture of all monitored Kubernetes clusters |

| Asset | Description |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Posture Dashboard | The posture dashboard provides an overview of the security posture of all Kubernetes clusters monitored |
| Findings | Findings communicate the outcome of a specific resource being evaluated with a specific rule. All latest findings are viewable on the findings page |
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
| Findings | Findings communicate the outcome of a specific resource being evaluated with a specific rule. All latest findings are viewable on the findings page |
| Findings | Findings communicate whether resources are compliant with applicable rules. Current findings are viewable on the Findings page |

| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Posture Dashboard | The posture dashboard provides an overview of the security posture of all Kubernetes clusters monitored |
| Findings | Findings communicate the outcome of a specific resource being evaluated with a specific rule. All latest findings are viewable on the findings page |
| Benchmark Rules | Benchmark rules are used to assess Kubernetes resources for secure configuration. Benchmark rules are viewable on the Benchmark page |
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
| Benchmark Rules | Benchmark rules are used to assess Kubernetes resources for secure configuration. Benchmark rules are viewable on the Benchmark page |
| Benchmark Rules | Benchmark rules are used to assess Kubernetes resources for secure configuration. Benchmark rules are viewable on the Benchmarks page |


CIS Kubernetes Benchmark integration is shipped including default dashboards and screens to manage the benchmark rules and inspect the compliance score and findings.
This integration requires access to node files, node processes, and the Kubernetes api-server therefore it assumes the agent will be installed as a [DaemonSet](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) with the proper [Roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole) and [RoleBindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) attached.
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
This integration requires access to node files, node processes, and the Kubernetes api-server therefore it assumes the agent will be installed as a [DaemonSet](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) with the proper [Roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole) and [RoleBindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) attached.
This integration requires access to node files, node processes, and the Kubernetes api-server. Therefore it assumes the agent will be installed as a [DaemonSet](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) with the proper [Roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole) and [RoleBindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) attached.


## Leader election

To collect cluster level data (compared to node level information) the integration makes use of the [leader election](https://www.elastic.co/guide/en/fleet/master/kubernetes_leaderelection-provider.html) mechanism.
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
To collect cluster level data (compared to node level information) the integration makes use of the [leader election](https://www.elastic.co/guide/en/fleet/master/kubernetes_leaderelection-provider.html) mechanism.
To collect cluster level data (rather than just node level information) the integration makes use of the [leader election](https://www.elastic.co/guide/en/fleet/master/kubernetes_leaderelection-provider.html) mechanism.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.4 candidate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integration page - add documentation for EKS
6 participants