Default image registry

Limited vCluster Tenancy Configuration Support

This feature is only available when using the following worker node types:

Host Nodes

Private Nodes

Use defaultImageRegistry to configure a private image registry.

For example:

controlPlane:
  advanced:
    defaultImageRegistry: my-private-registry:5000/vcluster/

vCluster prepends the image registry to all images used by vCluster, such as syncer, K3s, and CoreDNS. For example, rancher/k3s:v1.29.1+k3s2 becomes my-private-registry:5000/vcluster/rancher/k3s:v1.29.1+k3s2.

You can find a list of all needed images by vCluster in the file images.txt at the releases page, as well as two scripts (download-images.sh and push-images.sh) to pull and push those to your private registry.

To use your private registry, you need to configure imagePullSecrets.

Config reference

defaultImageRegistry required string

DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to upload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.