Disclaimer!: We use this as a base for our own and customer setup at puzzle. Heavy work in progress and a lot of things that can be improved. Feel free to contribute. We are happy to assist.
These Ansible playbook and roles can be used to:
- create a Rancher Control Plane using rke and helm
- add a [custom kubernetes cluster] to an existing Rancher Control Plane
Check inventories/site for a sample inventory.
There are two special ansible groups:
rke_rancher_clusters: Hosts in this group represent a Rancher Control Plane instancecustom_k8s_clusters: Hosts in this group represent a custom kubernetes cluster added to a Rancher Control Plane
Members (Nodes) of the Rancher Control Plane and the Kubernetes cluster are managed with the following ansible groups.
For Rancher Control Plane: Assuming we have a Rancher Control Plane with the name cluster_rancher, we create the cluster_rancher host to the rke_rancher_clusters group and then add all nodes for this to the group rke_cluster_rancher, so the Rancher Control Plane name with a rke_ prefix.
[rke_rancher_clusters]
cluster_rancher # Belongs to Ansible Group rke_cluster_rancher
[rke_cluster_rancher]
rancher01
rancher02
rancher03
Make sure to set at least the following vars:
- For the
cluster_rancherspecial host, you have to setrancher_hostname,rancher_admin_passwordandrancher_failover_ipwith its sub-configurations (see roles/rke_rancher_clusters/README.md for more information). Check inventories/host_vars/cluster_rancher.yml and roles/rke_rancher_clusters/defaults/main.yml for more details. - Set the
k8s_roleseach of the member should have (for a Rancher Control Plane this is normallycontrolplane,etcd,worker). See inventories/group_vars/rke_cluster_rancher.yml as an example.
For a custom Kubernetes cluster managed with a Rancher Control Plane: Assuming our cluster has the name mycluster we create a host rancher_mycluster in the custom_k8s_clusters group (so cluster name with a rancher_ prefix). The member nodes of this cluster are then added to a group with the name mycluster. To use some dedicated roles on some nodes you can use other ansible groups which are children of the mycluster group.
[custom_k8s_clusters]
rancher_mycluster
[mycluster:children]
mycluster_master
mycluster_worker
[mycluster_master]
master01
[mycluster_worker]
worker01Make sure to set at least the following vars:
- For the
ranchr_myclusterspecial host you have to set at least thecustom_k8s_cluster_api_key&custom_k8s_cluster_rancher_hostvariable. Check roles/custom_k8s_cluster/defaults/main.yml for more details and variables. - Set the
k8s_roleseach member should have. See inventories/group_vars/mycluster_master.yml and inventories/group_vars/mycluster_worker.yml as an example.
Playbook to apply docker, rke_node, rke_rancher_clusters & custom_rk8s_cluster. Check plays/prepare_k8s_nodes.yml, plays/deploy_rancher.yml & plays/deploy_k8s_cluster.yml for details.
With this playbook to can cleanup a node which was already added to a kubernetes cluster. Based on https://rancher.com/docs/rancher/v2.x/en/cluster-admin/cleaning-cluster-nodes/
Simple role to install Docker. Check roles/docker/README.md for more details.
Role to prepare a vm which then can be used as a node in a Rancher Control Plane or a custom Kubernetes Cluster. The role currently only configures firewalld depending on the k8s_role the node has. Based on https://rancher.com/docs/rancher/v2.x/en/installation/options/firewall/
Role to deploy a Rancher Control Plane with rke and helm. Check roles/rke_rancher_clusters/README.md for more details.
Role to create a custom Kubernetes cluster on a Rancher Control Plane and add nodes to the cluster. Check roles/custom_k8s_cluster/README.md for more details.
Role to deploy keepalived Daemonsets on Rancher Control Plane and custom Kubernetes clusters. Provides one or multiple highly available virtual IPv4/IPv6 address(es) to the regarding cluster. Usually directly called from rke_rancher_clusters and custom_rk8s_cluster.
GPLv3
- Sebastian Plattner
- Philip Schmid