From 06168658b9da6b724a1be4cde29e9da82996f52f Mon Sep 17 00:00:00 2001 From: Jay Carman Date: Tue, 31 Aug 2021 07:21:53 -0500 Subject: [PATCH 1/2] Fix documentation typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 402f9d8..8f70e87 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Container Security Operator -The Container Security Operator (CSO) brings Quay and Clair metadata to Kubernetes / OpenShift. Starting with vulnerability information the scope will get expanded over time. If it runs on OpenShift, the corresponding vulnerability information can be visualized inside the OCP Console. The Container Security Operator enables cluster administrators to monitor known container image vulnerabilites in pods running on their Kubernetes cluster. The controller sets up a watch on pods in the specified namespace(s) and queries the container registry for vulnerability information. If the container registry supports image scanning, such as [Quay](https://github.com/quay/quay) with [Clair](https://github.com/quay/clair), then the Operator will expose any vulnerabilities found via the Kubernetes API in an `ImageManifestVuln` object. This Operator requires no additional configuration after deployment, and will begin watching pods and populating `ImageManifestVulns` immediately once installed. +The Container Security Operator (CSO) brings Quay and Clair metadata to Kubernetes / OpenShift. Starting with vulnerability information the scope will get expanded over time. If it runs on OpenShift, the corresponding vulnerability information can be visualized inside the OCP Console. The Container Security Operator enables cluster administrators to monitor known container image vulnerabilities in pods running on their Kubernetes cluster. The controller sets up a watch on pods in the specified namespace(s) and queries the container registry for vulnerability information. If the container registry supports image scanning, such as [Quay](https://github.com/quay/quay) with [Clair](https://github.com/quay/clair), then the Operator will expose any vulnerabilities found via the Kubernetes API in an `ImageManifestVuln` object. This Operator requires no additional configuration after deployment, and will begin watching pods and populating `ImageManifestVulns` immediately once installed. ## ImageManifestVuln The security information of scanned images are stored in `ImageManifestVulns` on an image manifest basis, and are named by the image's manifest digest. ### Spec -The spec provides information about the features and its associated vulnarabilities. +The spec provides information about the features and its associated vulnerabilities. The spec should be immutable relative to the cluster. When a new vulnerability is added to a feature, the operator will update the spec after the resync threshold. ### Status -The status provides information about the affected Pods/Containers. As pod are added or removed +The status provides information about the affected Pods/Containers. As pods are added or removed from the cluster, their references are added to the `affectedPods` field of the status block. The status also provide various statistics about the manifest. e.g lastUpdate, highestSeverity, ... From b091c8bb6a4038b75b1d992a2d74dfe80c979095 Mon Sep 17 00:00:00 2001 From: Jay Carman Date: Tue, 31 Aug 2021 07:23:02 -0500 Subject: [PATCH 2/2] Fix broken OperatorHub link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f70e87..894a2ac 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ This Operator should be deployed using the [Operator Lifecycle Manager (OLM)](ht ### Kubernetes -This Operator is published upstream on [operatorhub.io](https://operatorhub.io/operator/container-security-operator). +This Operator is published upstream on [operatorhub.io](https://operatorhub.io/operator/project-quay-container-security-operator). ### OpenShift