Configuration

Configuration file reference

The default k0smotron configuration file is a YAML file that contains the following values:

apiVersion: k0smotron.io/v1beta1
kind: Cluster
metadata:
  name: k0smotron-test
spec:
  replicas: 1
  k0sImage: k0sproject/k0s
  K0sVersion: v1.27.1-k0s.0
  service:
    type: NodePort
    apiPort: 30443
    konnectivityPort: 30132
  persistence:
    type: emptyDir
  cniPlugin: kuberouter

spec Key Detail

Element	Description
replicas	Replicas is the desired number of replicas of the k0s control planes. If unspecified, defaults to 1. If the value is above 1, k0smotron requires kine datasource URL to be set.
k0sImage	The k0s image to be deployed.
K0sVersion	The k0s version to be deployed.
externalAddress	ExternalAddress defines k0s external address. See https://docs.k0sproject.io/stable/configuration/#specapi
service	Service defines the service configuration.
persistence	Persistence defines the persistence configuration.
kineDataSourceURL	Defines the kine datasource URL. Required for HA controlplane setup. Must be set if replicas > 1.
cniPlugin	Defines the CNI plugin to be used. Possible values are KubeRouter and Calico. Uses KubeRouter by default. Cannot be modified after deploying the cluster.

spec.service

Element	Description
type	Service type. Possible values: NodePort,LoadBalancer
apiPort	Defines the kubernetes API port.
konnectivityPort	Defines the konnectivity port.

spec.persistence

Element	Description
type	Persistence type. Possible values: emptyDir,hostPath,pvc
hostPath	Defines the host path configuration. Will be used as is in case of .spec.persistence.type is hostPath.
persistentVolumeClaim	Defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.