Getting Started - kyverno/policy-reporter GitHub Wiki

Installation with Helm

Policy Reporter provides a Helm Chart and related Helm Chart Repository. The basic installation provides a Prometheus Metrics Endpoint and REST API Endpoints.

To add optional features like the Policy Reporter UI, Monitoring Stack for Prometheus Operator or Notifications to Grafana Loki, Elasticsearch, Discord or Slack have a look to the Helm Chart values.yaml and Subcharts

Add the Helm Repository

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

Basic Installation

See API Reference for Details

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

Installation including the Policy Reporter UI

  • Policy Reporter UI Service Endpoint: http://policy-reporter-ui:8080
helm install policy-reporter policy-reporter/policy-reporter --set ui.enabled=true -n policy-reporter --create-namespace

Accessing via Port Forward

kubectl port-forward service/policy-reporter-ui 8082:8080 -n policy-reporter

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

Installation including the Monitoring Stack

  • ServiceMonitor for Prometheus
  • 3 preconfigured ConfigMaps with Grafana Dashboards
helm install policy-reporter policy-reporter/policy-reporter --set monitoring.enabled=true -n policy-reporter --create-namespace

Installation including Notifcations to Grafana Loki

  • Send new PolicyReport Results to Grafana Loki
helm install policy-reporter policy-reporter/policy-reporter --set target.loki.host=http://loki:3100 -n policy-reporter --create-namespace