Skip to main content
Version: main 🚧

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 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
warning

After deploying your vCluster, changing the Kubernetes distribution of vCluster is not supported.

Compatiblity matrix​

Host cluster compatibility​

The Kubernetes distro of vCluster is completely independent of the Kubernetes distro of the host cluster. This means you can run vCluster using k0s distribution regardless of the distribution type of the host cluster.

vCluster should work when deployed on a host cluster with the following supported Kubernetes versions:

  • v1.30
  • v1.29
  • v1.28

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 map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] 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 k0sproject/k0s pro​

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

tag required string v1.30.2-k0s.0 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.