policy-reporter/README.md

# Policy Reporter 3.x Preview
[![CI](https://github.com/kyverno/policy-reporter/actions/workflows/ci.yaml/badge.svg)](https://github.com/kyverno/policy-reporter/actions/workflows/ci.yaml) [![Go Report Card](https://goreportcard.com/badge/github.com/kyverno/policy-reporter)](https://goreportcard.com/report/github.com/kyverno/policy-reporter) [![Coverage Status](https://coveralls.io/repos/github/kyverno/policy-reporter/badge.svg?branch=main)](https://coveralls.io/github/kyverno/policy-reporter?branch=main)


![Screenshot Policy Reporter UI v2](https://github.com/kyverno/policy-reporter/blob/3.x/docs/images/screen.png)


## Documentation

Documentation for upcoming features and changes for the new Policy Reporter UI v2 are located in [Docs](https://github.com/kyverno/policy-reporter/tree/3.x/docs)

* [Installation](https://github.com/kyverno/policy-reporter/blob/3.x/docs/SETUP.md)
* [OAUth2 / OpenIDConnect](https://github.com/kyverno/policy-reporter/blob/3.x/docs/UI_AUTH.md)
* [UI CustomBoards](https://github.com/kyverno/policy-reporter/blob/3.x/docs/CUSTOM_BOARDS.md)
* [Kyverno PolicyExceptions](https://github.com/kyverno/policy-reporter/blob/3.x/docs/EXCEPTIONS.md)

The new documentation page for Policy Reporter v3 can be found here: [https://kyverno.github.io/policy-reporter-docs/](https://kyverno.github.io/policy-reporter-docs/)

## Getting Started

## Installation with Helm v3

Installation via Helm Repository

### Add the Helm repository
```bash
helm repo add policy-reporter https://kyverno.github.io/policy-reporter
helm repo update
```

### Installation with Policy Reporter UI and Kyverno Plugin enabled
```bash
helm install policy-reporter policy-reporter/policy-reporter --create-namespace -n policy-reporter --devel --set ui.enabled=true --set kyverno-plugin.enabled=true
kubectl port-forward service/policy-reporter-ui 8082:8080 -n policy-reporter
```

Open `http://localhost:8082/` in your browser.
Policy Reporter v3 (#482) Policy Reporter v3 Signed-off-by: Frank Jogeleit <frank.jogeleit@web.de> 2024-10-07 09:10:46 +00:00			`# Policy Reporter 3.x Preview`
update repository owner (#50) Signed-off-by: Frank Jogeleit <fj@move-elevator.de> 2021-07-23 08:05:20 +00:00			`[![CI](https://github.com/kyverno/policy-reporter/actions/workflows/ci.yaml/badge.svg)](https://github.com/kyverno/policy-reporter/actions/workflows/ci.yaml) [![Go Report Card](https://goreportcard.com/badge/github.com/kyverno/policy-reporter)](https://goreportcard.com/report/github.com/kyverno/policy-reporter) [![Coverage Status](https://coveralls.io/repos/github/kyverno/policy-reporter/badge.svg?branch=main)](https://coveralls.io/github/kyverno/policy-reporter?branch=main)`
init 2021-02-19 23:58:01 +00:00

Policy Reporter v3 (#482) Policy Reporter v3 Signed-off-by: Frank Jogeleit <frank.jogeleit@web.de> 2024-10-07 09:10:46 +00:00			`![Screenshot Policy Reporter UI v2](https://github.com/kyverno/policy-reporter/blob/3.x/docs/images/screen.png)`
Update README 2021-02-20 11:16:25 +00:00
Update README 2021-03-19 19:23:43 +00:00
			`## Documentation`

Policy Reporter v3 (#482) Policy Reporter v3 Signed-off-by: Frank Jogeleit <frank.jogeleit@web.de> 2024-10-07 09:10:46 +00:00			`Documentation for upcoming features and changes for the new Policy Reporter UI v2 are located in [Docs](https://github.com/kyverno/policy-reporter/tree/3.x/docs)`

			`* [Installation](https://github.com/kyverno/policy-reporter/blob/3.x/docs/SETUP.md)`
			`* [OAUth2 / OpenIDConnect](https://github.com/kyverno/policy-reporter/blob/3.x/docs/UI_AUTH.md)`
			`* [UI CustomBoards](https://github.com/kyverno/policy-reporter/blob/3.x/docs/CUSTOM_BOARDS.md)`
			`* [Kyverno PolicyExceptions](https://github.com/kyverno/policy-reporter/blob/3.x/docs/EXCEPTIONS.md)`

			`The new documentation page for Policy Reporter v3 can be found here: [https://kyverno.github.io/policy-reporter-docs/](https://kyverno.github.io/policy-reporter-docs/)`
update readme 2021-02-20 00:16:18 +00:00
Update README, replace target cm with secret 2021-03-01 15:36:44 +00:00			`## Getting Started`

update readme 2021-02-20 00:16:18 +00:00			`## Installation with Helm v3`

Update Installation instruction 2021-02-21 09:26:14 +00:00			`Installation via Helm Repository`
update readme 2021-02-20 00:16:18 +00:00
Development (#7) * Implement elasticsearch * Update deployment * Add Changelog 2021-02-27 18:11:49 +00:00			`### Add the Helm repository`
update readme 2021-02-20 00:16:18 +00:00			```bash
update repository owner (#50) Signed-off-by: Frank Jogeleit <fj@move-elevator.de> 2021-07-23 08:05:20 +00:00			`helm repo add policy-reporter https://kyverno.github.io/policy-reporter`
Update README, replace target cm with secret 2021-03-01 15:36:44 +00:00			`helm repo update`
update readme 2021-02-20 00:16:18 +00:00			```
Development (#7) * Implement elasticsearch * Update deployment * Add Changelog 2021-02-27 18:11:49 +00:00
Update README.md 2021-05-08 11:17:03 +00:00			`### Installation with Policy Reporter UI and Kyverno Plugin enabled`
Implement Discord as Target 2021-02-28 11:59:33 +00:00			```bash
Policy Reporter v3 (#482) Policy Reporter v3 Signed-off-by: Frank Jogeleit <frank.jogeleit@web.de> 2024-10-07 09:10:46 +00:00			`helm install policy-reporter policy-reporter/policy-reporter --create-namespace -n policy-reporter --devel --set ui.enabled=true --set kyverno-plugin.enabled=true`
Update README 2021-03-19 19:23:43 +00:00			`kubectl port-forward service/policy-reporter-ui 8082:8080 -n policy-reporter`
Manage PolicyPriorities with Helm (#17) * Manage PolicyPriorities with Helm 2021-03-17 10:51:44 +00:00			```
Update README 2021-04-17 11:42:04 +00:00
Policy Reporter v3 (#482) Policy Reporter v3 Signed-off-by: Frank Jogeleit <frank.jogeleit@web.de> 2024-10-07 09:10:46 +00:00			Open `http://localhost:8082/` in your browser.