terraform-module-k3s

module "k3s" {
  source = "xunleii/k3s/module"
dependson    = hcloud_server.agents   k3s_version    = "latest"   cluster_domain = "cluster.local"   cidr = {     pods     = "10.42.0.0/16"     services = "10.43.0.0/16"   }   drain_timeout  = "30s"   managed_fields = ["label", "taint"] // ignore annotations
global_flags = [     "--flannel-iface ens10",     "--kubelet-arg cloud-provider=external" // required to use https://github.com/hetznercloud/hcloud-cloud-controller-manager   ]
servers = {     for i in range(length(hcloudserver.controlplanes)) :     hcloudserver.controlplanes[i].name => {       ip = hcloudservernetwork.control_planes[i].ip       connection = {         host        = hcloudserver.controlplanes[i].ipv4_address         privatekey = trimspace(tlsprivatekey.ed25519provisioning.privatekeypem)       }       flags = [         "--disable-cloud-controller",         "--tls-san ${hcloudserver.controlplanes[0].ipv4_address}",       ]       annotations = { "server_id" : i } // theses annotations will not be managed by this module     }   }
agents = {     for i in range(length(hcloud_server.agents)) :     "${hcloudserver.agents[i].name}node" => {       name = hcloud_server.agents[i].name       ip   = hcloudservernetwork.agents_network[i].ip       connection = {         host        = hcloudserver.agents[i].ipv4address         privatekey = trimspace(tlsprivatekey.ed25519provisioning.privatekeypem)       }
labels = { "node.kubernetes.io/pool" = hcloud_server.agents[i].labels.nodepool }       taints = { "dedicated" : hcloud_server.agents[i].labels.nodepool == "gpu" ? "gpu:NoSchedule" : null }     }   } }

Inputs

| Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | servers | K3s server nodes definition. The key is used as node name if no name is provided. | map(any) | n/a | yes | | agents | K3s agent nodes definitions. The key is used as node name if no name is provided. | map(any) | {} | no | | cidr | K3s network CIDRs (see https://rancher.com/docs/k3s/latest/en/installation/install-options/). |

object({
    pods     = string
    services = string
  })

{
  "pods": "10.42.0.0/16",
  "services": "10.43.0.0/16"
}

list(
    object({
      filename    = string,
      file_content = string
    })
  )

[
  "annotation",
  "label",
  "taint"
]

Outputs

| Name | Description | |------|-------------| | kube\_config | Genereated kubeconfig. | | kubernetes | Authentication credentials of Kubernetes (full administrator). | | kubernetes\cluster\secret | Secret token used to join nodes to the cluster | | kubernetes\_ready | Dependency endpoint to synchronize k3s installation and provisioning. | | summary | Current state of k3s (version & nodes). |

Providers

| Name | Version | |------|---------| | http | ~> 3.0 | | null | ~> 3.0 | | random | ~> 3.0 | | tls | ~> 4.0 |

Frequently Asked Questions

How to customise the generated kubeconfig

It is sometimes necessary to modify the context or the cluster name to adapt kubeconfig to a third-party tool or to avoid conflicts with existing tools. Although this is not the role of this module, it can easily be done with its outputs :

module "k3s" {
  ...
}
local {   kubeconfig = yamlencode({     apiVersion      = "v1"     kind            = "Config"     current-context = "my-context-name"     contexts = [{       context = {         cluster = "my-cluster-name"         user : "my-user-name"       }       name = "my-context-name"     }]     clusters = [{       cluster = {         certificate-authority-data = base64encode(module.k3s.kubernetes.clustercacertificate)         server                     = module.k3s.kubernetes.api_endpoint       }       name = "my-cluster-name"     }]     users = [{       user = {         client-certificate-data : base64encode(module.k3s.kubernetes.client_certificate)         client-key-data : base64encode(module.k3s.kubernetes.client_key)       }       name : "my-user-name"     }]   }) }

License

# Generated with :heart: by terraform-docs