add custom board docs

Signed-off-by: Frank Jogeleit <[email protected]>
kyverno · Feb 28, 2024 · a65e459 · a65e459
1 parent 00dcbff
commit a65e459
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ Documentation for upcoming features and changes for the new Policy Reporter UI v
 
 * [Basic Installation](https://github.com/kyverno/policy-reporter/blob/3.x/docs/TUTORIALS.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)
 
 ## Documentation
 

diff --git a/docs/CUSTOM_BOARDS.md b/docs/CUSTOM_BOARDS.md
@@ -0,0 +1,62 @@
+# Policy Reporter UI - Custom Boards
+
+CustomBoards allows you to configure additional dashboards with a custom subset of sources and namespaces, selected via a list and/or label selector
+
+## Example CustomBoard Config
+
+![Custom Boards](https://github.com/kyverno/policy-reporter/blob/3.x/docs/images/custom-boards/list.png)
+
+```yaml
+ui:
+  customBoards:
+  - name: System
+    namespaces:
+      list:
+        - kube-system
+        - kyverno
+        - policy-reporter
+```
+
+### CustomBoard with NamespaceSelector
+
+![Custom Boards](https://github.com/kyverno/policy-reporter/blob/3.x/docs/images/custom-boards/selector.png)
+
+```yaml
+ui:
+  customBoards:
+  - name: System
+    namespaces:
+      selector:
+        group: system
+```
+
+### CustomBoard with ClusterResources
+![Custom Boards](https://github.com/kyverno/policy-reporter/blob/3.x/docs/images/custom-boards/cluster.png)
+
+```yaml
+ui:
+  customBoards:
+  - name: System
+    clusterScope:
+      enabled: true
+    namespaces:
+      selector:
+        group: system
+```
+
+### CustomBoard with Source List
+
+![Custom Boards](https://github.com/kyverno/policy-reporter/blob/3.x/docs/images/custom-boards/source.png)
+
+```yaml
+ui:
+  customBoards:
+  - name: System
+    clusterScope:
+      enabled: true
+    namespaces:
+      selector:
+        group: system
+    sources:
+        list: [kyverno]
+```
diff --git a/docs/images/custom-boards/cluster.png b/docs/images/custom-boards/cluster.png
diff --git a/docs/images/custom-boards/list.png b/docs/images/custom-boards/list.png
diff --git a/docs/images/custom-boards/selector.png b/docs/images/custom-boards/selector.png
diff --git a/docs/images/custom-boards/source.png b/docs/images/custom-boards/source.png