Rewriting Docker image registries with Kyverno

The previous post put a pull through cache in front of Docker Hub, Quay and the Kubernetes registry. Getting clusters to use it means changing every image reference in every manifest from docker.io/library/nginx to <registry>/docker-hub/library/nginx. Those manifests sit across namespaces and clusters owned by teams with other things to do. A Kyverno policy does the rewrite at admission time instead. Pods pull through the cache now, and the manifests catch up at whatever pace suits their owners.

What Kyverno does here

Kyverno is a policy engine that runs as an admission webhook. A ClusterPolicy with a mutate rule changes a resource after the API server receives it and before it is stored. The rule here matches pod creation, looks at each container whose image comes from one of the upstream registries, and rewrites the image to the cache’s prefix for that registry. Kyverno’s own example replaces one fixed registry with another. The version below also fills in what Docker Hub leaves out of an image name, which is most of the work.

The policy

One rule, one registry:

apiVersion: kyverno.io/v1
kind: ClusterPolicy
metadata:
  name: patch-docker-io-image-registry
spec:
  # admission only: pods that already exist are left alone
  background: false
  rules:
    - name: patch-image-registry-pod
      match:
        resources:
          kinds: [Pod]
      mutate:
        foreach:
          # `|| []`: a pod with only initContainers has no .spec.containers
          - list: "request.object.spec.containers || []"
            preconditions:
              all:
                # kyverno parses the image, so `python:3.12` is docker.io
                - key: '{{ images.containers."{{element.name}}".registry }}'
                  operator: Equals
                  value: docker.io
            context:
              - name: registry
                variable:
                  value: "111111111111.dkr.ecr.eu-west-1.amazonaws.com"
              - name: prefix
                variable:
                  value: "docker-hub"
              # the capture group is what lands after the prefix
              - name: upstream
                variable:
                  value: "^docker\\.io/(.*)$"
              # `python:3.12` means `library/python:3.12` on docker hub
              - name: withLibrary
                variable:
                  value: >-
                    {{ regex_replace_all('^([^/]+)$',
                    '{{ element.image }}', 'library/$1') }}
              # adds the registry and `:latest` where they were omitted
              - name: normalized
                variable:
                  value: "{{ image_normalize(withLibrary) }}"
              - name: finalImage
                variable:
                  value: >-
                    {{ regex_replace_all('{{ upstream }}', normalized,
                    '{{ registry }}/{{ prefix }}/$1') }}
            patchStrategicMerge:
              spec:
                containers:
                  - name: "{{ element.name }}"
                    image: "{{ finalImage }}"

The rule has to know two things a manifest does not say. An image with no slash in it, python:3.12, lives under Docker Hub’s library/ namespace, and the cache’s repository path has to say so. That is what withLibrary is for. And an image with no registry or no tag means docker.io/…:latest. image_normalize writes both out, so the rewritten reference is complete and the repository ECR creates has one clear name.

Testing it in the playground

The playground takes the policy on the left and a resource on the right and shows the mutated result. A pod with five containers covers the cases:

apiVersion: v1
kind: Pod
metadata:
  name: multi-registry-example
spec:
  containers:
    - name: nginx
      image: nginx
    - name: library-nginx
      image: library/nginx
    - name: docker-io-library-nginx
      image: docker.io/library/nginx
    - name: acme-api
      image: docker.io/acme/api:1.4
    - name: ubuntu
      image: public.ecr.aws/ubuntu/ubuntu:edge

The four Docker Hub images come out fully qualified under the cache. The ECR Public one is not this rule’s business and comes out unchanged:

Init and ephemeral containers

A pod has three container lists, and a policy that patches containers leaves initContainers and ephemeralContainers pulling from upstream. Each list is a foreach entry of its own, with the same preconditions, context and patch aimed at its own field:

      mutate:
        foreach:
          - list: "request.object.spec.containers || []"
            # ... preconditions, context and patch as above ...
          - list: "request.object.spec.initContainers || []"
            # ... the same, patching spec.initContainers ...
          - list: "request.object.spec.ephemeralContainers || []"
            # ... the same, patching spec.ephemeralContainers ...

One chart, many registries

Three lists times four registries is twelve copies of the same block. My attempt at one rule that handled every registry ran into rules that conflicted with each other. A Helm chart that renders one ClusterPolicy per registry keeps the policies simple and the duplication in a template: shmileee/helm-charts, kyverno-patch-registries. Its values name the same four upstreams the cache was configured for:

common:
  ecrRegistryFullname: "111111111111.dkr.ecr.eu-west-1.amazonaws.com"

registriesToOverwrite:
  docker.io:
    upstreamUrlRegexp: '^docker\\.io/(.*)$'
    ecrPrefixName: "docker-hub"
  public.ecr.aws:
    upstreamUrlRegexp: '^public\\.ecr\\.aws/(.*)$'
    ecrPrefixName: "public-ecr"
  quay.io:
    upstreamUrlRegexp: '^quay\\.io/(.*)$'
    ecrPrefixName: "quay"
  registry.k8s.io:
    upstreamUrlRegexp: '^registry\\.k8s\\.io/(.*)$'
    ecrPrefixName: "registry-k8s-io"

Rolling out by namespace

A wrong regular expression, or a cluster whose nodes cannot pull from ECR yet, stops every new pod in the cluster. So the policies apply only to namespaces that carry a label. The chart adds the selector to every rule’s match:

      match:
        any:
          - resources:
              kinds: [Pod]
              namespaceSelector:
                matchLabels:
                  pull-through-enabled: "true"

Enabling one namespace, then all of them, is two commands:

kubectl label namespace <namespace> pull-through-enabled=true --overwrite
kubectl label namespaces --all pull-through-enabled=true --overwrite

Drift in Argo CD

A mutated pod no longer matches the manifest in Git, so Argo CD marks the Application as out of sync. Either update the manifests, which is the plan anyway and now has no deadline, or tell Argo CD to ignore differences in .spec.containers[].image for the affected applications. The second option also hides an image change someone made by hand. So it is a bridge, not a destination. The ApplicationSet objects that generate those applications are the subject of two earlier posts, part one and part two.

Limitations

background: false means the policy touches new pods only. Running pods keep their upstream images until something recreates them, so a namespace is not on the cache until its deployments have rolled once.

A mutating webhook on every pod puts Kyverno on the path of every pod start. With failurePolicy: Fail, a Kyverno outage stops scheduling. With Ignore, pods created during the outage pull from upstream unrewritten, and nothing reports it.

The regular expressions have to match the cache’s prefixes exactly. A mismatch breaks image pulls for every new pod in a labelled namespace, which is what the label is for. The nodes also still need the permissions from the previous post, or the first pull of each image fails.

Kyverno has since added CEL-based policy kinds next to ClusterPolicy. The syntax above still works, but a new policy written today would look different.