vcluster.yaml reference
These pages list every field in vcluster.yaml, the configuration file for a cluster created with vCluster. Each page covers one top-level key and gives each field's type, default, and description. The tables are generated from the vCluster configuration schema, so they match the version of the docs you're reading.
To learn how the file is structured and applied, see What is vcluster.yaml?. For step-by-step configuration, see Configure. The vCluster chart's values.yaml shows every default, and its values.schema.json validates a vcluster.yaml file.
Top-level keys​
| Key | What it configures |
|---|---|
controlPlane | Control plane components, such as the Kubernetes distro, backing store, CoreDNS, and proxy, and how the control plane is deployed and exposed. |
deletion | Deletion protection and automatic deletion of the cluster. |
deploy | Add-on components vCluster deploys into the cluster, such as kube-proxy, a CNI, a CSI driver, MetalLB, a metrics server installed in the cluster, Argo CD applications, and Stacks. |
experimental | Experimental features. Their configuration might change between releases. |
exportKubeConfig | How vCluster exports the cluster's kubeconfig, including the context, server, and target Secrets. |
integrations | Integrations with tools on the control plane cluster, such as cert-manager, External Secrets Operator, Istio, KubeVirt, the control plane cluster's metrics server, Netris, and Argo CD. |
logging | Log encoding and log file output. |
networking | Service replication, DNS resolution, and other networking options. |
platform | The connection to vCluster Platform, such as the API key and project. |
plugins | Which vCluster plugins to load. |
policies | Resource quotas, limit ranges, network policies, Pod Security Standards, and central admission control. |
privateNodes | Private nodes, including kubelet settings, node joining, Auto Nodes, automatic upgrades, and VPN. |
rbac | The Role and ClusterRole that vCluster uses on the control plane cluster. |
sleep | Automatic sleep and wakeup. |
snapshots | Automatic snapshots. |
sync | Which resources sync from the cluster to the control plane cluster, and from the control plane cluster into the cluster. |
telemetry | Usage telemetry that vCluster collects. |