From 94c1303adca7dd7d0a26a2869fc00f34af9790a0 Mon Sep 17 00:00:00 2001 From: mrjoelkamp Date: Fri, 26 Jul 2024 11:04:58 -0500 Subject: [PATCH] docs: populate provider chart README --- charts/attest-provider/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/charts/attest-provider/README.md b/charts/attest-provider/README.md index e69de29..107b13e 100644 --- a/charts/attest-provider/README.md +++ b/charts/attest-provider/README.md @@ -0,0 +1,16 @@ +## Parameters + +|Parameter|Description|Default| +|:-|:-|:-| +|image|provider image to run|`docker/attest-provider:0.0.8`| +|certDir|mount path to use for TLS certificates|`/certs`| +|clientCAFile|optional mount path for gatekeeper client certificate (mTLS)|`/tmp/gatekeeper/ca.crt`| +|port|port for provider service|`8090`| +|handlerTimeout|timeout in seconds for provider HTTP handler|`25`| +|replicas|number of provider replicas in deployment|`1`| +|tufRoot|name of embedded Docker TUF root to use for client (`dev`, `staging`, `prod`)|`prod`| +|tufMetadataSource|URI for TUF metadata (registry or http source)|`registry-1.docker.io/docker/tuf-metadata`| +|tufTargetsSource|URI for TUF targets (registry or http source)|`registry-1.docker.io/docker/tuf-targets`| +|attestationStyle|lookup attestations from image index (`attached`) or `referrers`|`referrers`| +|provider.timeout|timeout in seconds for gatekeeper external data request|`30`| +|provider.tls.caBundle|base64 encoded CA cert for provider|`""`|