From 7a31dcdb26c4de3ffd9dc625aa8cacb50f955346 Mon Sep 17 00:00:00 2001 From: Ankur Kothiwal Date: Thu, 26 Jan 2023 11:29:02 +0530 Subject: [PATCH] add KubeArmor proposed projects for Term 01-2023 Signed-off-by: Ankur Kothiwal --- .../2023/01-Mar-May/project_ideas.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/lfx-mentorship/2023/01-Mar-May/project_ideas.md b/lfx-mentorship/2023/01-Mar-May/project_ideas.md index bea75bf1..8c078338 100644 --- a/lfx-mentorship/2023/01-Mar-May/project_ideas.md +++ b/lfx-mentorship/2023/01-Mar-May/project_ideas.md @@ -83,3 +83,33 @@ - Recommended Skills: golang - Mentor: Rohit Nayak (@rohit-nayak-ps, rohit@planetscale.com) - Upstream Issue: https://github.com/vitessio/vitess/issues/12136 + +### KubeArmor + +#### KubeArmor Telemetry Monitoring and Dashboards + +- Description: KubeArmor generates a large amount of data through logs and alerts, but interpreting this data can be difficult. To make it easier to understand, it is necessary to parse the telemetry, create meaningful metrics, enable data filtering, and create visualizations such as graphs to display on a dashboard. +- Expected Outcome: Create a telemetry dashboard, write setup documentation and usage guide. +- Recommended Skills: ELK stack (Elasticsearch, Logstash & Kibana), Fluentd, Loki and Grafana +- Mentors: Anurag Kumar (@kranurag7, contact.anurag7@gmail.com), Ankur Kothiwal (@Ankurk99, ankur.kothiwal99@gmail.com), Barun Acharya (@daemon1024, barun1024@gmail.com), Rahul Jadhav (@nyrahul, nyrahul@gmail.com) +- Issue: + + +#### Adding OpenTelemetry Support + +- Description: To integrate KubeArmor with OpenTelemetry, an adapter needs to be created. OpenTelemetry is a standard for telemetry data, including distributed tracing, metrics, and logs, and has an SDK and a collector component that can run on Kubernetes. Applications can directly expose OpenTelemetry data through in-app instrumentation using the OpenTelemetry SDK. The collector can then gather data from multiple applications in a cluster and send it to various backends for storage and visualization, such as Jaeger. +- Expected Outcome: The mentee's task is to develop an OpenTelemetry adapter for KubeArmor that can receive logs, alerts, and telemetry from the kubearmor-relay-service and convert it into the OpenTelemetry format. They are also expected to create documentation and usage guides that describe how to set up and use the adapter, as well as demonstrate the integration with a backend that supports OpenTelemetry. +- Recommended Skills: OpenTelemetry, Go +- Mentor(s): Anurag Kumar (@kranurag7, contact.anurag7@gmail.com), Ankur Kothiwal (@Ankurk99, ankur.kothiwal99@gmail.com), Barun Acharya (@daemon1024, barun1024@gmail.com), Rahul Jadhav (@nyrahul, nyrahul@gmail.com) +- Issue: + + +#### Rancher Plugin Integration + +- Description: The goal is to create an extension for Rancher, a Kubernetes management platform, which will enable interaction with KubeArmor. The extension will have the capability to install KubeArmor, allow for the management of security policies, and provide monitoring of workload behavior through alerts and telemetry. +- Expected Outcome: Rancher plugin address the following points: Install KubeArmor within Rancher, document and demonstrate the usage. +Note: This item is a work in progress. The selected mentee is expected to continue the same work. +- Recommended Skills: Rancher, Grafana stack, Javascript +- Mentor(s): Anurag Kumar (@kranurag7, contact.anurag7@gmail.com), Ankur Kothiwal (@Ankurk99, ankur.kothiwal99@gmail.com), Barun Acharya (@daemon1024, barun1024@gmail.com), Rahul Jadhav (@nyrahul, nyrahul@gmail.com) +- Issue: +