Manage Docker Hub rate limits

Konvoy customers can configure their cluster to authenticate with registries (such as Docker Hub), and add registries, by defining each in the ClusterConfiguration .spec.imageRegistries list in the cluster.yaml file.

For Konvoy, to add credentials for Docker Hub, set the options in your cluster.yaml as follows:

kind: ClusterConfiguration
apiVersion: konvoy.mesosphere.io/v1beta2
spec:
  imageRegistries:
    - server: https://registry-1.docker.io
      username: "<username>"
      password: "<password>"
  autoProvisioning:
    config:
      webhook:
        extraArgs:
          konvoy.docker-registry-url: https://registry-1.docker.io
          konvoy.docker-registry-username: <username>
          konvoy.docker-registry-password: <password>

NOTE: You can use environment variables to specify imageRegistries values. For example, if your yaml file has password: ${REGISTRY_PASSWORD}, password is set to the REGISTRY_PASSWORD value in your environment.

1. Apply the changes to your cluster. Enter the following command:

   konvoy up
   

2. Confirm the changes made to the cluster. Enter the following command to check the contents of the containerd configuration file:

   $ cat /etc/containerd/config.toml
   ...
   [plugins."io.containerd.grpc.v1.cri".registry]
         [plugins."io.containerd.grpc.v1.cri".registry.mirrors]
           [plugins."io.containerd.grpc.v1.cri".registry.mirrors."docker.io"]
             endpoint = ["https://registry-1.docker.io"]
         [plugins."io.containerd.grpc.v1.cri".registry.configs]
           [plugins."io.containerd.grpc.v1.cri".registry.configs."registry-1.docker.io".auth]
               username = "<username>"
               password = "<password>"
               auth = ""
               identitytoken = ""
   ...
   

NOTE: You can also do this directly after your cluster is created and without running konvoy up. Go on to the nodes in your cluster directly, and edit your containerd configuration file /etc/containerd/config.toml. Edit your file to apply the changes above and save the file. Restart containerd on your node. You will need to do this for all of the nodes in your cluster.

For more information on configuring imageRegistries in the cluster.yaml, please refer to cluster configuration API documentation.