2021-03-19 19:32:46 +00:00
# Policy Reporter
2021-02-24 00:09:15 +00:00
[](https://github.com/fjogeleit/policy-reporter/actions/workflows/ci.yaml) [](https://goreportcard.com/report/github.com/fjogeleit/policy-reporter) [](https://coveralls.io/github/fjogeleit/policy-reporter?branch=main)
2021-02-19 23:58:01 +00:00
2021-02-20 10:00:10 +00:00
## Motivation
2021-02-19 23:58:01 +00:00
2021-03-19 19:23:43 +00:00
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 ](https://kyverno.io/docs/policy-reports/ ) 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 ](https://grafana.com/oss/loki/ ), [Elasticsearch ](https://www.elastic.co/de/elasticsearch/ ) or [Slack ](https://slack.com/ ).
2021-02-20 11:16:25 +00:00
2021-03-19 19:23:43 +00:00
Policy Reporter provides also a Prometheus Metrics API as well as an standalone mode along with the [Policy Reporter UI ](#policy-report-ui ).
This project is in an early stage. Please let me know if anything did not work as expected or if you want to send your audits to unsupported targets.
## Documentation
2021-03-19 23:16:33 +00:00
You can find detailed Information and Screens about Features and Configurations in the [Documentation ](https://github.com/fjogeleit/policy-reporter/wiki ).
2021-02-20 00:16:18 +00:00
2021-03-01 15:36:44 +00:00
## Getting Started
2021-02-20 00:16:18 +00:00
## Installation with Helm v3
2021-02-21 09:26:14 +00:00
Installation via Helm Repository
2021-02-20 00:16:18 +00:00
2021-02-27 18:11:49 +00:00
### Add the Helm repository
2021-02-20 00:16:18 +00:00
```bash
2021-02-21 09:26:14 +00:00
helm repo add policy-reporter https://fjogeleit.github.io/policy-reporter
2021-03-01 15:36:44 +00:00
helm repo update
2021-02-20 00:16:18 +00:00
```
2021-02-27 18:11:49 +00:00
### Basic Installation - Provides Prometheus Metrics
```bash
helm install policy-reporter policy-reporter/policy-reporter -n policy-reporter --create-namespace
```
2021-03-19 19:43:09 +00:00
## Policy Reporter UI
2021-02-28 11:59:33 +00:00
2021-03-19 23:13:58 +00:00
You can use the Policy Reporter as standalone Application along with the optional UI SubChart.
2021-02-28 11:59:33 +00:00
2021-03-19 23:13:58 +00:00
### Installation with Policy Reporter UI enabled
2021-02-28 11:59:33 +00:00
```bash
2021-03-19 19:23:43 +00:00
helm install policy-reporter policy-reporter/policy-reporter --set ui.enabled=true -n policy-reporter --create-namespace
kubectl port-forward service/policy-reporter-ui 8082:8080 -n policy-reporter
2021-03-17 10:51:44 +00:00
```
2021-03-19 19:23:43 +00:00
Open `http://localhost:8082/` in your browser.
2021-03-17 10:51:44 +00:00
2021-03-19 23:13:58 +00:00
Check the [Documentation ](https://github.com/fjogeleit/policy-reporter/wiki/policy-reporter-ui ) for Screens and additional Information
2021-03-19 19:23:43 +00:00
## Targets
2021-03-19 23:15:49 +00:00
Policy Reporter supports the following [Targets ](https://github.com/fjogeleit/policy-reporter/wiki/targets ) to send new (Cluster)PolicyReport Results too:
2021-03-19 19:23:43 +00:00
* [Grafana Loki ](https://github.com/fjogeleit/policy-reporter/wiki/grafana-loki )
* [Elasticsearch ](https://github.com/fjogeleit/policy-reporter/wiki/elasticsearch )
* [Slack ](https://github.com/fjogeleit/policy-reporter/wiki/slack )
* [Discord ](https://github.com/fjogeleit/policy-reporter/wiki/discord )
* [MS Teams ](https://github.com/fjogeleit/policy-reporter/wiki/ms-teams )
2021-03-21 18:40:18 +00:00
* [Policy Reporter UI ](https://github.com/fjogeleit/policy-reporter/wiki/policy-reporter-ui-log )
2021-03-19 19:23:43 +00:00
2021-03-01 15:36:44 +00:00
2021-02-21 13:13:21 +00:00
## Monitoring
2021-03-19 23:13:58 +00:00
The Helm Chart includes optional SubChart for [Prometheus Operator ](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack ) Integration. The provided Dashboards working without Loki and are only based on the Prometheus Metrics.
2021-03-06 18:33:33 +00:00
2021-03-19 19:23:43 +00:00
Have a look into the [Documentation ](https://github.com/fjogeleit/policy-reporter/wiki/prometheus-operator-integration ) for details.
2021-03-06 18:33:33 +00:00
2021-03-19 19:23:43 +00:00
### Grafana Dashboard Import
2021-03-06 18:33:33 +00:00
If you are not using the MonitoringStack you can import the dashboards from [Grafana ](https://grafana.com/orgs/policyreporter/dashboards )
