mirror of https://github.com/kyverno/policy-reporter.git synced 2024-12-15 17:50:58 +00:00

History

Frank Jogeleit 03626fd198 prepare release v24.0.1 Signed-off-by: Frank Jogeleit <frank.jogeleit@web.de>		2024-07-19 07:51:57 +02:00
..
charts	feat: update panels that used deprecated angular plugins (#456 )	2024-06-24 11:28:57 +02:00
templates	API to render Violations Report (#429 )	2024-05-04 10:04:27 +02:00
Chart.lock	Prepare Release v2.22.0 (#406 )	2024-02-04 10:52:38 +01:00
Chart.yaml	prepare release v24.0.1	2024-07-19 07:51:57 +02:00
config-email-reports.yaml	fix(helm): typo in email report config (#413 )	2024-02-27 15:44:26 +01:00
config.yaml	securityhub: fix product name field and allow to set company name in findings (#446 )	2024-06-12 18:01:55 +02:00
README.md	prepare release v24.0.1	2024-07-19 07:51:57 +02:00
values.yaml	prepare release v24.0.1	2024-07-19 07:51:57 +02:00

README.md

Policy Reporter

Motivation

Kyverno ships with two types of validation. You can either enforce a rule or audit it. If you don't want to block developers or if you want to try out a new rule, you can use the audit functionality. The audit configuration creates PolicyReports which you can access with kubectl. Because I can't find a simple solution to get a general overview of this PolicyReports and PolicyReportResults, I created this tool to send information about PolicyReports to different targets like Grafana Loki, Elasticsearch or Slack.

Documentation

You can find detailed Information and Screens about Features and Configurations in the Documentation.

Getting Started

Installation with Helm v3

Installation via Helm Repository

Add the Helm repository

helm repo add policy-reporter https://kyverno.github.io/policy-reporter
helm repo update

Basic Installation

The basic installation provides an Prometheus Metrics Endpoint and different REST APIs, for more details have a look at the Documentation.

helm install policy-reporter policy-reporter/policy-reporter -n policy-reporter --create-namespace

Policy Reporter UI

You can use the Policy Reporter as standalone Application along with the optional UI SubChart.

Installation with Policy Reporter UI and Kyverno Plugin enabled

helm install policy-reporter policy-reporter/policy-reporter --set kyvernoPlugin.enabled=true --set ui.enabled=true --set ui.plugins.kyverno=true -n policy-reporter --create-namespace
kubectl port-forward service/policy-reporter-ui 8082:8080 -n policy-reporter

Open http://localhost:8082/ in your browser.

Check the Documentation for Screens and additional Information