Enable Annotation-based Caching

Enabling annotation-based caching for Chainguard Enforce

This document relates to Chainguard Enforce. In order to follow along, you will need access to Chainguard Enforce. You can request access by selecting Chainguard Enforce on the inquiry form.

Chainguard Enforce for Kubernetes can leverage annotations on Kubernetes objects to cache verification results to reduce the amount of traffic made to container registries in order to improve latency and scalability of the admission webhook.

This feature will soon be the default for all users. In the meantime, in order to try out this feature on your Kubernetes cluster, you can use a feature flag setting in the ConfigMap config-policy-controller within the cosign-system namespace.

Understanding Annotation-based Caching

Because a Kubernetes Pod usually receives most of its images passed down from parent objects like StatefulSets or ReplicaSets, enabling annotation-based caching allows for the verification results from parent objects to be passed down to Pods. This reduces the traffic made to container registries, reducing latency and making policy enforcement much more scalable.

In Chainguard’s own load testing annotation-based caching, with a cache hit we obtained P99 verification latency of under two seconds (meaning that 99% of the requests were within this timeframe), and no egress was made to container registry. Without caching, latency would be highly dependent of registry access latency, where the P99 latency may be ten seconds or more.

Additionally, there are safeguards in place to make sure that cache annotation values are tamper proof. Chainguard includes a cryptographic signature inside the cache annotation and verifies that this is in place upon rereading. Invalid caches will be discarded.

Turn on Annotation-based Caching

In order to turn on annotation-based caching in Chainguard Enforce, you first need to create the ConfigMap config-policy-controller if it does not exist.

kubectl create cm config-policy-controller -n cosign-system --dry-run=client -o yaml | kubectl apply -f -

Next, set the enable cache flag.

kubectl patch cm config-policy-controller -n cosign-system --type merge \
    -p '{"data":{"dev.chainguard.enable-cip-cache":"true"}}'

To turn annotation-based caching off, remove the setting from the ConfigMap, or set it to false.

Confirm that Annotation-based Caching is Enabled

After enabling annotation-based caching, any new verification going through the Chainguard Enforce admission webhook will have an additional annotation similar to this:

apiVersion: v1
kind: Pod
    clusterimagepolicies.chainguard.dev/cache: |
                  name: policy-name
                  resourceversion: "4943109"
      signature: eyJhbGciOi...

Your annotation value and format may be slightly different. The important information includes the validation results of the Pod’s images against the different policies, as well as a cryptographic signature confirming the authenticity of the cache.

Last updated: 2023-01-12 15:22