Local Registry

This guide covers how to configure KIND with a local container image registry.

In the future this will be replaced by a built-in feature, and this guide will cover usage instead.

Create A Cluster And Registry

The following shell script will create a local docker registry and a kind cluster with it enabled.

examples/kind-with-registry.sh

  1. #!/bin/sh
  2. set -o errexit
  4. # create registry container unless it already exists
  5. reg_name='kind-registry'
  6. reg_port='5001'
  7. if [ "$(docker inspect -f '{{.State.Running}}' "${reg_name}" 2>/dev/null || true)" != 'true' ]; then
  8.   docker run \
  9.     -d --restart=always -p "127.0.0.1:${reg_port}:5000" --name "${reg_name}" \
  10.     registry:2
  11. fi
  13. # create a cluster with the local registry enabled in containerd
  14. cat <<EOF | kind create cluster --config=-
  15. kind: Cluster
  16. apiVersion: kind.x-k8s.io/v1alpha4
  17. containerdConfigPatches:
  18. - |-
  19.   [plugins."io.containerd.grpc.v1.cri".registry.mirrors."localhost:${reg_port}"]
  20.     endpoint = ["http://${reg_name}:5000"]
  21. EOF
  23. # connect the registry to the cluster network if not already connected
  24. if [ "$(docker inspect -f='{{json .NetworkSettings.Networks.kind}}' "${reg_name}")" = 'null' ]; then
  25.   docker network connect "kind" "${reg_name}"
  26. fi
  28. # Document the local registry
  29. # https://github.com/kubernetes/enhancements/tree/master/keps/sig-cluster-lifecycle/generic/1755-communicating-a-local-registry
  30. cat <<EOF | kubectl apply -f -
  31. apiVersion: v1
  32. kind: ConfigMap
  33. metadata:
  34.   name: local-registry-hosting
  35.   namespace: kube-public
  36. data:
  37.   localRegistryHosting.v1: |
  38.     host: "localhost:${reg_port}"
  39.     help: "https://kind.sigs.k8s.io/docs/user/local-registry/"
  40. EOF

Using The Registry

The registry can be used like this.

  1. First we’ll pull an image docker pull gcr.io/google-samples/hello-app:1.0
  2. Then we’ll tag the image to use the local registry docker tag gcr.io/google-samples/hello-app:1.0 localhost:5001/hello-app:1.0
  3. Then we’ll push it to the registry docker push localhost:5001/hello-app:1.0
  4. And now we can use the image kubectl create deployment hello-server --image=localhost:5001/hello-app:1.0

If you build your own image and tag it like localhost:5001/image:foo and then use it in kubernetes as localhost:5001/image:foo.