homeserver/roles/PyratLabs.k3s/documentation

ansible-role-k3s

This document describes a number of ways of consuming this Ansible role for use in your own k3s deployments. It will not be able to cover every use case scenario but will provide some common example configurations.

Requirements

Before you start you will need an Ansible controller. This can either be your workstation, or a dedicated system that you have access to. The instructions in this documentation assume you are using ansible CLI, there are no instructions available for Ansible Tower at this time.

Follow the below guide to get Ansible installed.

https://docs.ansible.com/ansible/latest/installation_guide/index.html

Quickstart

Below are quickstart examples for a single node k3s server, a k3s cluster with a single control node and HA k3s cluster. These represent the bare minimum configuration.

• Single node k3s
• Simple k3s cluster
• HA k3s cluster using embedded etcd

Example configurations and operations

Configuration

• Setting up 2-node HA control plane with external datastore
• Provision multiple standalone k3s nodes
• Set node labels and component arguments
• Use an alternate CNI
• IPv4/IPv6 Dual-Stack config
• Start K3S after another service

Operations

• Stop/Start a cluster
• Updating k3s
• Extending a cluster
• Shrinking a cluster