ansible_k3s
CyVerse Ansible k3s
This role will create a k3s standalone or cluster.
Requirements
If using Docker with k3s, then this role will depend on Docker already installed or a role that provides it.
This role will setup a firewall (ufw) and by default allow all nodes within the k3s cluster to communicate with each other.
This role makes assumptions in your host files. The following is an example inventory file with k3s_masters, k3s_agents, and k3s_cluster defined, which is the minimum declaration.
Note: At this time, only 1 master is supported
In .ini format
[k3s_masters]
w.x.y.z
[k3s_agents]
a.b.c.d
e.f.g.h
[k3s_cluster:children]
k3s_masters
k3s_agents
In yaml format
all:
hosts:
k1:
ansible_host: w.x.y.z
ansible_user: root
k2:
ansible_host: a.b.c.d
ansible_user: root
k3:
ansible_host: e.f.g.h
ansible_user: root
children:
k3s_masters:
hosts:
k1:
k3s_agents:
hosts:
k2:
k3:
k3s_cluster:
children:
k3s_masters:
k3s_agents:
Role Variables
The following table lists optional ansible variables along with the default values if not defined.
| Variable Name | Default value if not defined | Description |
|---|---|---|
| K3S_DOCKER_ENABLE | version_dependent | enables the docker engine if not set will be true unless the os version is ubuntu2204 or newer |
| K3S_GPU_ENABLE | false | enables nvidia gpu driver |
| K3S_GPU_TIMESLICE_ENABLE | false | if gpu enabled, this setting will enable time slicing |
| K3S_GPU_TIMESLICE_NUM | 2 | default time slices is two, if K3S_GPU_TIMESLICE_ENABLE |
| K3S_NVIDIA_USE_GPU_OPERATOR | true | default is to use nvidia's gpu operator (if gpu enabled) |
| K3S_NVIDIA_GPU_OPERATOR_DRIVER | false | use driver in container (see https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html) |
| K3S_NVIDIA_GPU_OPERATOR_TOOLKIT | false | use toolkit in container (see https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html) |
| K3S_TRAEFIK_ENABLE | false | disable traefik ingress |
| K3s_FLANNEL_BACKEND | none | if set, it will pass the value to --flannel-backend= |
| K3S_CALICO_ENABLE (not working) | false | enable calico |
| K3S_CLUSTER_TOKEN | none | if set, the cluster will be initialized to this token, rather than randomly generated |
| K3S_CLUSTER_CIDR | none | if set, cidr for cluster e.g. 192.168.0.0/16 |
| K3S_VERSION | none | if set, will attempt to set the k3s version |
| K3S_IS_MULTINODE | false | if true, then will do additional setup to prepare hosts for multinodes (like ip forwarding) |
| K3S_MASTER_INSTALL | true | reinstall master node(s) |
| K3S_MASTER_IP | none | sets the k3s masters ip for when ansible_default_ipv4 is getting an incorrect value |
| K3S_MASTER_PORT | 6443 | master node port |
| K3S_POSTGRESQL_ENABLE | false | enables the use of postgresql |
| K3S_POSTGRESQL_INSTALL | false | enables installation of postgresql on the first k3s master; K3S_POSTGRESQL_ENABLE must be true |
| K3S_POSTGRESQL_HOST | 127.0.0.1 | host name or ip setting for postgresql db, from the k3s master configuration |
| K3S_POSTGRESQL_PORT | 5432 | port for postgresql db |
| K3S_POSTGRESQL_DB | kubernetes | postgres database name |
| K3S_POSTGRESQL_USER | k3suser | db username to K3S_POSTGRESQL_DB |
| K3S_POSTGRESQL_PASS | randomly generated | password to use for K3S_POSTGRESQL_USER to access K3S_POSTGRESQL_DB; stored in /opt/k3s after being generated |
| K3S_FIREWALL_MANAGE | false | enables firewall management through this role |
| K3S_FIREWALL_ADD_PORTS | none | This is an array of dictionaries (see example playbook for examples); each element should have port, rule, proto, and src |
| K3S_REGISTRIES_MIRRORS | none | If defined, will place the everything under the "mirrors:" in /etc/rancher/k3s/registries.yaml; ensure that the included yaml containers "mirrors:" |
Example Playbook
This is a sample playbook:
- hosts: k3s_cluster
become: true
roles:
- k3s
vars:
K3S_FORCE_UNINSTALL: true
K3S_POSTGRESQL_ENABLE: true
K3S_POSTGRESQL_INSTALL: true
K3S_FIREWALL_ADD_PORTS:
- port: "8888"
rule: "allow"
proto: "tcp"
src: "1.2.3.0/24"
- port: "443"
rule: "deny"
proto: "tcp"
src: "any"
Author Information
Edwin Skidmore (edwin@cyverse.org)
About
This role will install a single or multi-cluster k3s, with the option of installing with postgresql. At this time, this is not suppose to be a comprehensive k3s, but rather a role sufficient for CyVerse's needs
Install
ansible-galaxy install CyVerse-Ansible/ansible-k3sLicense
other
Downloads
2155
Owner