Documentation Index Fetch the complete documentation index at: https://mintlify.com/loft-sh/vcluster/llms.txt
Use this file to discover all available pages before exploring further.
The control plane configuration defines how vCluster’s core components are deployed and managed, including the Kubernetes distribution, backing store, networking, and resource allocation.
Distro Configuration Kubernetes distribution configuration. Only one distro can be enabled at a time. Kubernetes version to use (e.g., v1.35.0).
Container image configuration. Registry of the container image.
repository
string
default: "loft-sh/kubernetes"
Repository of the container image.
Tag of the container image.
API server configuration. Override the command to start the API server binary.
Additional arguments to pass to the API server.
Controller manager configuration. Enable the controller manager.
Override the command to start the controller manager binary.
Additional arguments to pass to the controller manager.
Scheduler configuration. Enable the virtual cluster scheduler.
Override the command to start the scheduler binary.
Additional arguments to pass to the scheduler.
Extra environment variables for the main container (not init container).
Resource requests and limits for the distro init container. Backing Store controlPlane.backingStore
Configure which backing store to use for the virtual cluster. Embedded SQLite database configuration. Use embedded SQLite database.
Additional arguments to pass to Kine.
External database configuration (MySQL, PostgreSQL). Kine data source connection string.
MySQL: mysql://username:password@tcp(hostname:3306)/vcluster
PostgreSQL: postgres://username:password@hostname:5432/vcluster
Identity provider for temporary authentication tokens (e.g., aws for RDS IAM).
Path to TLS certificate file.
Path to CA certificate file.
Embedded etcd configuration. Migrate from deployed external etcd to embedded etcd.
Additional arguments to pass to etcd.
Deploy external etcd as a StatefulSet. StatefulSet configuration for etcd.
StatefulSet Configuration Configure the vCluster control plane StatefulSet. Container image for the control plane. repository
string
default: "loft-sh/vcluster-pro"
Image repository. Use loft-sh/vcluster-oss for pure OSS build.
Image tag (defaults to chart app version).
Resource requests and limits. requests.ephemeral-storage
Ephemeral storage request.
High availability configuration. Number of control plane replicas.
Leader election lease duration (seconds).
Leader election renew deadline (seconds).
Leader election retry period (seconds).
Persistence configuration. Enable persistent volume claim. auto determines based on distro and options.
volumeClaim.retentionPolicy
Volume retention policy.
CoreDNS Configuration CoreDNS deployment configuration. Run CoreDNS embedded within the control plane (PRO feature).
Number of CoreDNS replicas.
Resource requests and limits for CoreDNS.
Service and Ingress Control plane service configuration. Enable the control plane service.
spec.type
string
default: "ClusterIP"
Service type (ClusterIP, NodePort, LoadBalancer).
Control plane ingress configuration. Enable ingress for the control plane.
host
string
default: "my-host.com"
Hostname where vCluster will be reachable.
pathType
string
default: "ImplementationSpecific"
Ingress path type.
Example: External Database controlPlane : backingStore : database : external : enabled : true dataSource : postgres://vcluster:password@postgres.example.com:5432/vcluster certFile : /certs/client-cert.pem keyFile : /certs/client-key.pem caFile : /certs/ca.pem
Example: High Availability controlPlane : statefulSet : highAvailability : replicas : 3 leaseDuration : 60 renewDeadline : 40 retryPeriod : 15 resources : limits : cpu : 2 memory : 8Gi requests : cpu : 500m memory : 1Gi
Example: Custom Kubernetes Version controlPlane : distro : k8s : enabled : true version : v1.30.0 image : registry : ghcr.io repository : loft-sh/kubernetes tag : v1.30.0 scheduler : enabled : true
