doc: some doc refinements

Signed-off-by: Christian Kotzbauer <[email protected]>
ckotzbauer · Jul 3, 2022 · 3f55ef3 · 3f55ef3
1 parent 003b383
commit 3f55ef3
Showing 1 changed file with 68 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,8 @@ The image contains versions of `k8s.io/client-go`. Kubernetes aims to provide fo
 
 | vulnerability-operator   | k8s.io/{api,apimachinery,client-go} | expected kubernetes compatibility |
 |--------------------------|-------------------------------------|-----------------------------------|
-| main                     | v0.24.0                             | 1.23.x, 1.24.x, 1.25.x            |
+| main                     | v0.24.2                             | 1.23.x, 1.24.x, 1.25.x            |
+| 0.7.0                    | v0.24.2                             | 1.23.x, 1.24.x, 1.25.x            |
 | 0.6.0                    | v0.24.0                             | 1.23.x, 1.24.x, 1.25.x            |
 | 0.5.0                    | v0.23.5                             | 1.22.x, 1.23.x, 1.24.x            |
 | 0.4.0                    | v0.23.5                             | 1.22.x, 1.23.x, 1.24.x            |
@@ -108,67 +109,72 @@ All files named `sbom.json`, `sbom.txt`, `sbom.xml` or `sbom.spdx` are gathered
 #### JSON
 
 All found vulnerabilities can be requested as file from the `/reports/report.json` endpoint. The data is structured like this:
-```json
-[
-  {
-    "ID": "CVE-2019-19924",
-    "Severity": "Medium",
-    "Type": "rpm",
-    "Package": "sqlite",
-    "Installed": "3.7.17-8.el7_7.1",
-    "FixedIn": [],
-    "FixState": "wont-fix",
-    "URLs": [
-      "https://access.redhat.com/security/cve/CVE-2019-19924"
-    ],
-    "ImageID": "docker.elastic.co/beats/filebeat@sha256:e418d12e08a1b74140c9edc6bdc773110b0f802340e25e2716950bac86ae14ce",
-    "Containers": [
-      {
-        "PodNamespace": "elastic-system",
-        "PodName": "filebeat-filebeat-6xkf4",
-        "ContainerName": "filebeat"
-      },
-      {
-        "PodNamespace": "elastic-system",
-        "PodName": "filebeat-filebeat-g6zbh",
-        "ContainerName": "filebeat"
-      },
-      {
-        "PodNamespace": "elastic-system",
-        "PodName": "filebeat-filebeat-jkgnh",
-        "ContainerName": "filebeat"
-      }
-    ]
-  },
-  {
-    "ID": "CVE-2020-16250",
-    "Severity": "Critical",
-    "Type": "go-module",
-    "Package": "github.com/hashicorp/vault/api",
-    "Installed": "v1.3.1",
-    "FixedIn": [],
-    "FixState": "unknown",
-    "URLs": [
-      "https://www.hashicorp.com/blog/category/vault/",
-      "https://github.com/hashicorp/vault/blob/master/CHANGELOG.md#151",
-      "http://packetstormsecurity.com/files/159478/Hashicorp-Vault-AWS-IAM-Integration-Authentication-Bypass.html"
-    ],
-    "ImageID": "ghcr.io/kyverno/kyverno@sha256:4fc715e9287446222bf12b1245899b195ecea8beda54c6f6a3587373c376cad1",
-    "Containers": [
-      {
-        "PodNamespace": "kyverno",
-        "PodName": "kyverno-555dcf9f66-csmq5",
-        "ContainerName": "kyverno"
-      },
-      {
-        "PodNamespace": "kyverno",
-        "PodName": "kyverno-555dcf9f66-gsphr",
-        "ContainerName": "kyverno"
-      }
-    ]
-  }
-]
-```
+<details>
+  <summary>Example JSON</summary>
+
+  ```json
+  [
+    {
+      "ID": "CVE-2019-19924",
+      "Severity": "Medium",
+      "Type": "rpm",
+      "Package": "sqlite",
+      "Installed": "3.7.17-8.el7_7.1",
+      "FixedIn": [],
+      "FixState": "wont-fix",
+      "URLs": [
+        "https://access.redhat.com/security/cve/CVE-2019-19924"
+      ],
+      "ImageID": "docker.elastic.co/beats/filebeat@sha256:e418d12e08a1b74140c9edc6bdc773110b0f802340e25e2716950bac86ae14ce",
+      "Containers": [
+        {
+          "PodNamespace": "elastic-system",
+          "PodName": "filebeat-filebeat-6xkf4",
+          "ContainerName": "filebeat"
+        },
+        {
+          "PodNamespace": "elastic-system",
+          "PodName": "filebeat-filebeat-g6zbh",
+          "ContainerName": "filebeat"
+        },
+        {
+          "PodNamespace": "elastic-system",
+          "PodName": "filebeat-filebeat-jkgnh",
+          "ContainerName": "filebeat"
+        }
+      ]
+    },
+    {
+      "ID": "CVE-2020-16250",
+      "Severity": "Critical",
+      "Type": "go-module",
+      "Package": "github.com/hashicorp/vault/api",
+      "Installed": "v1.3.1",
+      "FixedIn": [],
+      "FixState": "unknown",
+      "URLs": [
+        "https://www.hashicorp.com/blog/category/vault/",
+        "https://github.com/hashicorp/vault/blob/master/CHANGELOG.md#151",
+        "http://packetstormsecurity.com/files/159478/Hashicorp-Vault-AWS-IAM-Integration-Authentication-Bypass.html"
+      ],
+      "ImageID": "ghcr.io/kyverno/kyverno@sha256:4fc715e9287446222bf12b1245899b195ecea8beda54c6f6a3587373c376cad1",
+      "Containers": [
+        {
+          "PodNamespace": "kyverno",
+          "PodName": "kyverno-555dcf9f66-csmq5",
+          "ContainerName": "kyverno"
+        },
+        {
+          "PodNamespace": "kyverno",
+          "PodName": "kyverno-555dcf9f66-gsphr",
+          "ContainerName": "kyverno"
+        }
+      ]
+    }
+  ]
+  ```
+</details>
+
 
 #### Metrics