Kubernetes distro
vCluster uses Kubernetes as the default distribution for the virtual cluster.
By default, vCluster uses an embedded SQLite as the backing store when you use the K8s distribution.
Compatiblity matrix
Compatibility matrix showing which host K8s version (left column) is supported by which vCluster K8s distro versions.
| v1.29.0 | v1.28.4 | v1.27.8 | v1.26.11 | |
|---|---|---|---|---|
| 1.29 | ✅ | 🆗 | 🆗 | 🆗 |
| 1.28 | 🆗 | ✅ | 🆗 | 🆗 |
| 1.27 | 🆗 | 🆗 | ✅ | 🆗 |
| 1.26 | 🆗 | 🆗 | 🆗 | ✅ |
Legend:
⚠️ : known issue
✅ : recommended
🆗 : likely compatible
Config reference
k8s required object pro
K8S holds K8s relevant configuration.
k8s required object proenabled required boolean false pro
Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.
enabled required boolean false proapiServer required object pro
APIServer holds configuration specific to starting the api server.
apiServer required object proenabled required boolean false pro
Enabled signals this container should be enabled.
enabled required boolean false proimage required object pro
Image is the distro image
image required object proregistry required string pro
Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally
overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.
registry required string prorepository required string pro
Repository is the repository of the container image, e.g. my-repo/my-image
repository required string protag required string pro
Tag is the tag of the container image, e.g. latest
tag required string proimagePullPolicy required string pro
ImagePullPolicy is the pull policy for the distro image
imagePullPolicy required string procommand required string[] pro
Command is the command to start the distro binary. This will override the existing command.
command required string[] proextraArgs required string[] pro
ExtraArgs are additional arguments to pass to the distro binary.
extraArgs required string[] procontrollerManager required object pro
ControllerManager holds configuration specific to starting the controller manager.
controllerManager required object proenabled required boolean false pro
Enabled signals this container should be enabled.
enabled required boolean false proimage required object pro
Image is the distro image
image required object proregistry required string pro
Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally
overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.
registry required string prorepository required string pro
Repository is the repository of the container image, e.g. my-repo/my-image
repository required string protag required string pro
Tag is the tag of the container image, e.g. latest
tag required string proimagePullPolicy required string pro
ImagePullPolicy is the pull policy for the distro image
imagePullPolicy required string procommand required string[] pro
Command is the command to start the distro binary. This will override the existing command.
command required string[] proextraArgs required string[] pro
ExtraArgs are additional arguments to pass to the distro binary.
extraArgs required string[] proscheduler required object pro
Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled
scheduler required object proimage required object pro
Image is the distro image
image required object proregistry required string pro
Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally
overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.
registry required string prorepository required string pro
Repository is the repository of the container image, e.g. my-repo/my-image
repository required string protag required string pro
Tag is the tag of the container image, e.g. latest
tag required string proimagePullPolicy required string pro
ImagePullPolicy is the pull policy for the distro image
imagePullPolicy required string procommand required string[] pro
Command is the command to start the distro binary. This will override the existing command.
command required string[] proextraArgs required string[] pro
ExtraArgs are additional arguments to pass to the distro binary.
extraArgs required string[] proenv required object[] pro
Env are extra environment variables to use for the main container and NOT the init container.
env required object[] proresources required object pro
Resources for the distro init container
resources required object prosecurityContext required object pro
Security options can be used for the distro init container
securityContext required object pro