Skip to main content

k0s

Zero Friction Kubernetes (k0s) is an all-inclusive Kubernetes distribution, which is configured with all of the features needed to build a Kubernetes cluster and packaged as a single binary for ease of use. See the k0s docs for k0s' features.


warning

vCluster does not support dual stack networking when you use k0s. You can to deploy k0s on a dual stack host cluster, but it does not have all the dual stack features.

To use k0s with default deployment options, add the following to your vcluster.yaml config file:

controlPlane:
  distro:
    k0s:
      enabled: true

Compatiblity matrix​

Compatibility matrix showing which host K8s version (left column) is supported by which vCluster k0s distro versions.

v1.29.1-k0s.0v1.28.2-k0s.0v1.27.6-k0s.0v1.26.9-k0s.0
1.29✅🆗🆗🆗
1.28🆗✅🆗🆗
1.27🆗🆗✅🆗
1.26🆗🆗🆗✅

Legend:

⚠️ : known issue

✅ : recommended

🆗 : likely compatible

Config reference​

k0s required object pro​

K0S holds k0s relevant configuration.

enabled required boolean false pro​

Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.

config required string pro​

Config allows you to override the k0s config passed to the k0s binary.

env required object[] pro​

Env are extra environment variables to use for the main container and NOT the init container.

resources required object pro​

Resources for the distro init container

securityContext required object pro​

Security options can be used for the distro init container

image required object pro​

Image is the distro image

registry 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.

repository required string pro​

Repository is the repository of the container image, e.g. my-repo/my-image

tag required string pro​

Tag is the tag of the container image, e.g. latest

imagePullPolicy required string pro​

ImagePullPolicy is the pull policy for the distro image

command required string[] pro​

Command is the command to start the distro binary. This will override the existing command.

extraArgs required string[] pro​

ExtraArgs are additional arguments to pass to the distro binary.