Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Frank Jogeleit <[email protected]>
  • Loading branch information
fjogeleit committed Jan 26, 2025
1 parent 4006ef9 commit f824ba1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/policy-reporter-ui/source-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ui:
sources:
- name: kyverno
exceptions: true
viewType: status
type: status
excludes:
results:
- warn
Expand All @@ -22,7 +22,7 @@ ui:
sources:
- name: kyverno
exceptions: true
viewType: status
type: status
excludes:
results:
- warn
Expand All @@ -46,10 +46,10 @@ This option makes it possible to hide different information from the UI which ar

Since Kyverno validation does not produce `warn` results, we do not want to display it in our Kyverno dashboards, so we exclude it in our example configuration.

### ViewType
### Type

Some sources like Trivy don't produce pass results and mainly show existing failures. In this cases the default dashboards don't produce much value because they give no insights which failures are really important. For this sources you can set the `viewType` to `severity`. Means all information will be grouped by `severity` rather then the `result` which makes them more valuable.
Some sources like Trivy don't produce pass results and mainly show existing failures. In this cases the default dashboards don't produce much value because they give no insights which failures are really important. For this sources you can set the `type` to `severity`. Means all information will be grouped by `severity` rather then the `result` which makes them more valuable.

The `viewType` has no effect on dashboards in which multiple sources are visible and some of them use the default value.
The `type` has no effect on dashboards in which multiple sources are visible and some of them use the default value.

<img src="../assets/trivy-vulnr-dashboard.png" style="border: 1px solid #555; margin-top: 20px;" alt="Policy Reporter UI - Trivy Severity based Dashboard" />

0 comments on commit f824ba1

Please sign in to comment.