arillso.container.k3s role – Install and configure K3s lightweight Kubernetes

Note

This role is part of the arillso.container collection (version 1.0.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install arillso.container.

To use it in a playbook, specify: arillso.container.k3s.

Entry point agent – K3s agent entry point

Synopsis

  • Entry point for K3s worker nodes (agents). Automatically sets k3s_role=agent.

Parameters

Parameter

Comments

k3s_node_labels

list / elements=string

Node labels to apply

Default: []

k3s_node_name

string / required

K3s node name

k3s_node_taints

list / elements=string

Node taints to apply

Default: []

k3s_server_url

string / required

K3s server URL to connect to

k3s_token

string / required

K3s cluster token

k3s_version

string / required

K3s version to install

Authors

  • Simon Bärlocher

Entry point main – Install and configure K3s lightweight Kubernetes

Synopsis

  • Main entry point for K3s installation with full configuration options. Supports both server and agent roles with manual configuration.

Parameters

Parameter

Comments

k3s_bind_address

string

K3s API server bind address

Default: "{{ ansible_default_ipv4.address }}"

k3s_https_listen_port

integer

K3s HTTPS API server listen port

Default: 6443

k3s_node_ip

string

K3s node IP address

Default: "{{ ansible_default_ipv4.address }}"

k3s_node_labels

list / elements=string

Node labels to apply (format: key=value)

Default: []

k3s_node_name

string / required

K3s node name (usually inventory_hostname)

k3s_node_taints

list / elements=string

Node taints to apply (format: key=value:effect)

Default: []

k3s_role

string / required

K3s node role - server (control plane) or agent (worker)

Choices:

  • "server"

  • "agent"

k3s_server_init

boolean

Initialize K3s cluster (only for first server node)

Choices:

  • false ← (default)

  • true

k3s_server_url

string

K3s server URL for agents and joining servers

Default: ""

k3s_tls_san

list / elements=string

Additional TLS SANs for API server certificate

Default: []

k3s_token

string

K3s cluster token for authentication

Default: ""

k3s_version

string / required

K3s version to install (e.g., v1.33.3+k3s1)

Authors

  • Simon Bärlocher

Entry point server_init – K3s server initialization entry point

Synopsis

  • Entry point for initializing a new K3s cluster. Automatically sets k3s_role=server and k3s_server_init=true.

Parameters

Parameter

Comments

k3s_bind_address

string

K3s API server bind address

Default: "{{ ansible_default_ipv4.address }}"

k3s_https_listen_port

integer

K3s HTTPS API server listen port

Default: 6443

k3s_node_name

string / required

K3s node name

k3s_tls_san

list / elements=string

Additional TLS SANs for API server

Default: []

k3s_version

string / required

K3s version to install

Authors

  • Simon Bärlocher

Entry point server_join – K3s server join entry point

Synopsis

  • Entry point for joining additional servers to existing K3s cluster. Automatically sets k3s_role=server and k3s_server_init=false.

Parameters

Parameter

Comments

k3s_bind_address

string

K3s API server bind address

Default: "{{ ansible_default_ipv4.address }}"

k3s_https_listen_port

integer

K3s HTTPS API server listen port

Default: 6443

k3s_node_name

string / required

K3s node name

k3s_server_url

string / required

K3s server URL to join

k3s_token

string / required

K3s cluster token

k3s_version

string / required

K3s version to install

Authors

  • Simon Bärlocher