Skip to content

kairos-io/provider-k3s

Repository files navigation

Kairos K3S Cluster Plugin


This provider will configure a k3s installation based on the cluster section of cloud init.

Configuration

cluster_token: a token all members of the cluster must have to join the cluster.

control_plane_host: the host of the cluster control plane. This is used to join nodes to a cluster. If this is a single node cluster this is not required.

role: defines what operations is this device responsible for. The roles are described in detail below.

  • init This role denotes a device that should initialize the etcd cluster and operate as a k3s server. There should only be one device with this role per cluster.
  • controlplane: runs the k3s server.
  • worker: runs the k3s agent.

Example

#cloud-config

cluster:
  cluster_token: randomstring
  control_plane_host: cluster.example.com
  role: init
  config: |
    node-name: example-node