Skip to content

Commit 4456a70

Browse files
committed
Some more notes on how this works
1 parent 63de1e7 commit 4456a70

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

readme.md

+9
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,19 @@ spec:
7373
cascades: {}
7474
```
7575
76+
## How it works
77+
78+
The scan-deduplicator works via a [validating webhook](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) configuration in Kubernetes.
79+
Before a scan is created in the cluster, kubernetes reaches out to the scan-deduplicator via a http request.
80+
The scan-deduplicator then checks if the scan was already executed recently.
81+
If it was executed recently, the webhook marks the scan as invalid and kubernetes will not create the scan.
82+
7683
## Deployment (WIP)
7784
7885
Deploys the scan-deduplicator, including a [valkey](https://valkey.io/) instance for a persistent cache.
7986
87+
> NOTE: This requires the cluster to have [cert-manger](https://cert-manager.io/) installed in the cluster to generate a tls certificate for the validating webhook.
88+
8089
```bash
8190
kubectl create namespace scan-deduplicator || true
8291
kubectl create --namespace scan-deduplicator secret generic scan-deduplicator-cache-credentials --from-literal="password=$(uuidgen)" || true

0 commit comments

Comments
 (0)