docs: Describe ClusterVulnerabilityReport CR (aquasecurity#729)

Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
tavaresrodrigo · Oct 2, 2021 · 7390f4f · 7390f4f
1 parent 5ef4f3a
commit 7390f4f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/build/mkdocs-material/Dockerfile b/build/mkdocs-material/Dockerfile
@@ -1,4 +1,4 @@
-FROM squidfunk/mkdocs-material:7.2.6
+FROM squidfunk/mkdocs-material:7.3.1
 
 ## If you want to see exactly the same version as is published to GitHub pages
 ## use a private image for insiders, which requires authentication.

diff --git a/docs/crds/clustervulnerability-report.md b/docs/crds/clustervulnerability-report.md
@@ -0,0 +1,4 @@
+# ClusterVulnerabilityReport
+
+ClusterVulnerabilityReport has the same schema as VulnerabilityReport but different life cycle. Instances of
+ClusterVulnerabilityReport can be named by the container image digest and used to cache scan results at cluster scope.
diff --git a/docs/crds/index.md b/docs/crds/index.md
@@ -1,15 +1,16 @@
 # Overview
 
 This project houses CustomResourceDefinitions (CRDs) related to security and compliance checks along with the code
-generated by Kubernetes [code generators][k8s-code-generator] to write such custom resources in a natural way.
+generated by Kubernetes [code generators][k8s-code-generator] to write such custom resources in a programmable way.
 
-| NAME                        | SHORTNAMES         | APIGROUP               | NAMESPACED |  KIND |
-| --------------------------- | ------------------ | ---------------------- | ---------- | ----- |
-| [vulnerabilityreports]      | vulns,vuln         | aquasecurity.github.io | true       | [VulnerabilityReport](./vulnerability-report.md) |
-| [configauditreports]        | configaudit        | aquasecurity.github.io | true       | [ConfigAuditReport](./configaudit-report.md)     |
-| [clusterconfigauditreports] | clusterconfigaudit | aquasecurity.github.io | false      | [ClusterConfigAuditReport](./clusterconfigaudit-report.md) |
-| [ciskubebenchreports]       | kubebench          | aquasecurity.github.io | false      | [CISKubeBenchReport](./ciskubebench-report.md)   |
-| [kubehunterreports]         | kubehunter         | aquasecurity.github.io | false      | [KubeHunterReport](./kubehunter-report.md)       |
+| NAME                          | SHORTNAMES                | APIGROUP               | NAMESPACED |  KIND |
+| ----------------------------- | ------------------------- | ---------------------- | ---------- | ----- |
+| [vulnerabilityreports]        | vulns,vuln                | aquasecurity.github.io | true       | [VulnerabilityReport](./vulnerability-report.md) |
+| [clustervulnerabilityreports] | clustervulns, clustervuln | aquasecurity.github.io | false      | [ClusterVulnerabilityReport](./clustervulnerability-report.md) |
+| [configauditreports]          | configaudit               | aquasecurity.github.io | true       | [ConfigAuditReport](./configaudit-report.md)     |
+| [clusterconfigauditreports]   | clusterconfigaudit        | aquasecurity.github.io | false      | [ClusterConfigAuditReport](./clusterconfigaudit-report.md) |
+| [ciskubebenchreports]         | kubebench                 | aquasecurity.github.io | false      | [CISKubeBenchReport](./ciskubebench-report.md)   |
+| [kubehunterreports]           | kubehunter                | aquasecurity.github.io | false      | [KubeHunterReport](./kubehunter-report.md)       |
 
 !!! note
     We are open to suggestions for adding new or changes to the existing CRDs in the case that would enable
@@ -18,6 +19,7 @@ generated by Kubernetes [code generators][k8s-code-generator] to write such cust
 [k8s-code-generator]: https://github.com/kubernetes/code-generator
 
 [vulnerabilityreports]: https://raw.githubusercontent.com/aquasecurity/starboard/{{ var.tag }}/deploy/crd/vulnerabilityreports.crd.yaml
+[clustervulnerabilityreports]: https://raw.githubusercontent.com/aquasecurity/starboard/{{ var.tag }}/deploy/crd/clustervulnerabilityreports.crd.yaml
 [ciskubebenchreports]: https://raw.githubusercontent.com/aquasecurity/starboard/{{ var.tag }}/deploy/crd/ciskubebenchreports.crd.yaml
 [kubehunterreports]: https://raw.githubusercontent.com/aquasecurity/starboard/{{ var.tag }}/deploy/crd/kubehunterreports.crd.yaml
 [configauditreports]: https://raw.githubusercontent.com/aquasecurity/starboard/{{ var.tag }}/deploy/crd/configauditreports.crd.yaml

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
   - Custom Resource Definitions:
       - Overview: crds/index.md
       - VulnerabilityReport: crds/vulnerability-report.md
+      - ClusterVulnerabilityReport: crds/clustervulnerability-report.md
       - ConfigAuditReport: crds/configaudit-report.md
       - ClusterConfigAuditReport: crds/clusterconfigaudit-report.md
       - CISKubeBenchReport: crds/ciskubebench-report.md