Skip to content

Installation

This documents the in-development version. Switch to v2.3 for the latest stable release.

kuik requires Kubernetes 1.30 or later: the chart installs a ValidatingAdmissionPolicy, GA from that version.

A cluster runs one kuik install: the Secret names its secret syncer reserves are cluster-wide, so the syncers of two installs would refuse each other’s writes.

We rely on cert-manager Custom Resources to manage the kuik mutating webhook certificate, so you need to install it first.

kuik v3 is in beta: try it on a test or staging cluster, not in production, and read its known limits first. Pick the latest version from the releases.

Terminal window
VERSION=3.0.0-beta.1
helm upgrade --install --create-namespace --namespace kuik-system kube-image-keeper oci://quay.io/enix/charts/kube-image-keeper:$VERSION

To install kuik in another namespace, replace kuik-system in this command and in the registry Secret command below.

Helm installs the CRDs of the chart’s crds/ directory on the first install only: helm upgrade leaves them as they are. When you upgrade kuik, apply the CRDs of the new version first:

Terminal window
VERSION=3.0.0-beta.1 # the version you upgrade to
helm show crds oci://quay.io/enix/charts/kube-image-keeper --version $VERSION | kubectl apply --server-side -f -

With Flux, set install.crds and upgrade.crds to CreateReplace on the HelmRelease instead.

Custom Resource Definitions (CRDs) are used to configure the behavior of kuik such as its routing and mirroring features. Those are described in the CRD reference.

To setup an ImageMirror, you will first need to configure a registry where kuik will copy matched images. Then generate a token with permission to pull, push and delete (if cleanup enabled) in this registry and create the secret to use in your ImageMirror with:

Terminal window
kubectl create secret docker-registry my-registry-secret --namespace kuik-system --docker-server=my-registry.company.com --docker-username=my-username --docker-password=my-token

If you let kuik cleanup expired images in your registry, you still have to configure garbage collection on your own as kuik only delete images reference.