Skip to content

Commit

Permalink
doc: fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Kotzbauer <[email protected]>
  • Loading branch information
ckotzbauer committed Jan 29, 2022
1 parent 2e0c59e commit 70428c7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,22 @@
[![test](https://github.com/ckotzbauer/sbom-operator/actions/workflows/test.yml/badge.svg)](https://github.com/ckotzbauer/sbom-operator/actions/workflows/test.yml)

## Motivation
## Overview

This operator maintains a central place to track all packages and software used in all those images in a Kubernetes cluster. For this a Software Bill of
Materials (SBOM) is generated from each image with Syft. They are all stored in one or more targets. Currently only Git is supported. With this it is
possible to do further analysis, vulnerability scans and much more in a single place.
possible to do further analysis, vulnerability scans and much more in a single place. To prevent scans of images that have already been analyzed pods are annotated
with the imageID of the already processed image.

## Kubernetes Compatibility

The image contains versions of `k8s.io/client-go`. Kubernetes aims to provide forwards & backwards compatibility of one minor version between client and server:

| access-manager | k8s.io/{api,apimachinery,client-go} | expected kubernetes compatibility |
|-----------------|-------------------------------------|-----------------------------------|
| 0.2.0 | v0.23.2 | 1.22.x, 1.23.x, 1.24.x |
| 0.1.0 | v0.23.2 | 1.22.x, 1.23.x, 1.24.x |
| main | v0.23.2 | 1.22.x, 1.23.x, 1.24.x |
| 0.2.0 | v0.23.3 | 1.22.x, 1.23.x, 1.24.x |
| 0.1.0 | v0.23.3 | 1.22.x, 1.23.x, 1.24.x |
| main | v0.23.3 | 1.22.x, 1.23.x, 1.24.x |

However, the operator will work with more versions of Kubernetes in general.

Expand Down

0 comments on commit 70428c7

Please sign in to comment.