Skip to content

Commit 5331d4e

Browse files
Add KubeArmor Project Proposals (#1485)
* Add KubeArmor Project Proposals Signed-off-by: Atharva Shah <[email protected]> * Limit mentors to 4 per project for KubeArmor Signed-off-by: Atharva Shah <[email protected]> --------- Signed-off-by: Atharva Shah <[email protected]> Signed-off-by: Nate W <[email protected]> Co-authored-by: Nate W <[email protected]>
1 parent de1992b commit 5331d4e

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

programs/lfx-mentorship/2025/03-Sep-Nov/project_ideas.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,3 +398,44 @@ ensure such policy violation scenarios are avoided.
398398

399399
- Upstream issue: https://github.com/cloudnative-pg/cnpg-i-hello-world/issues/183
400400

401+
### KubeArmor
402+
403+
#### KubeArmor Observability Spectrum Enhancement
404+
405+
- **Description:** This project focuses on improving KubeArmor's observability by integrating key Prometheus metrics. The goal is to offer simple explanations for security policy enforcement and alerting within Kubernetes clusters.
406+
- **Key Metrics to Focus On:**
407+
- Number of Policies Applied
408+
- Number of Alerts Triggered
409+
- List of Active Policies
410+
- Policy Status (Active/Inactive)
411+
- **Expected Outcome:** Successful integration of these Prometheus metrics, making them accessible via a Prometheus endpoint and adhering to best practices for metric exposition.
412+
- **Upstream Issue:** https://github.com/kubearmor/KubeArmor/issues/1902
413+
- **Associated Repository:** https://github.com/kubearmor/kubearmor-prometheus-exporter
414+
415+
**Mentors:**
416+
- Rishabh Soni (@rootxrishabh, [email protected])
417+
- Aryan Sharma (@Aryan-sharma11, [email protected])
418+
- Ramakant Sharma (@rksharma95, [email protected])
419+
- Barun Acharya (@daemon1024, [email protected])
420+
421+
**Recommended Skills:** Go, Prometheus, Kubernetes, Git
422+
423+
#### KubeArmor Unit Test Coverage Audit
424+
- **Description:** This project aims to systematically analyze and substantially improve KubeArmor's unit test coverage. It involves identifying untested code paths, designing and implementing new unit tests for crucial modules, and establishing a robust testing framework to boost code quality.
425+
- **Goals:**
426+
- Measure Coverage: Accurately measure and report current unit test coverage for all Go packages.
427+
- Prioritized Test Implementation: Write new unit tests, prioritizing core modules like core, monitor, enforcer, log, and feeder, and addressing other packages with no test files.
428+
- Identify Untested Components: Pinpoint major untested functionalities and propose specific test scenarios.
429+
- Achieve Measurable Improvement: Submit pull requests that significantly increase overall unit test coverage.
430+
- **Expected Outcome:** A detailed coverage report, a suite of new, effective unit tests, and a measurable improvement in test coverage, leading to enhanced code quality and reliability.
431+
- **Upstream Issue:** https://github.com/kubearmor/KubeArmor/issues/2130
432+
- **Associated Repository:** https://github.com/kubearmor/KubeArmor
433+
- **Testing Guide Reference:** https://github.com/kubearmor/KubeArmor/blob/main/contribution/testing_guide.md
434+
435+
**Recommended Skills:** Go, Kubernetes, Testing Methodologies (unit testing, mocking), Git.
436+
437+
**Mentors:**
438+
- Rishabh Soni (@rootxrishabh, [email protected])
439+
- Aryan Sharma (@Aryan-sharma11, [email protected])
440+
- Ramakant Sharma (@rksharma95, [email protected])
441+
- Nishant Singh (@tesla59, [email protected])

0 commit comments

Comments
 (0)