jtfogarty / rke2

RKE2 Cluster Setup and Rancher Deployment Playbook

This Ansible playbook automates the process of setting up an RKE2 (Rancher Kubernetes Engine 2) cluster and deploying Rancher. Here's a breakdown of its actions:

1. Prepare Nodes:

   • Applies the prepare-nodes role to all hosts in the inventory.
   • Involves system preparations like updating packages, configuring firewall rules, etc.

2. Download RKE2 Binaries:

   • Applies the rke2-download role to all hosts.
   • Downloads the necessary RKE2 binaries on all nodes.

3. Prepare RKE2 Configuration:

   • Applies the rke2-prepare role to all hosts.
   • Sets up RKE2 configuration files and systemd services.

4. Configure RKE2 Server Nodes:

   • Applies the add-server role to hosts in the server_nodes group.
   • Sets up the RKE2 control plane nodes.

5. Configure RKE2 Agent Nodes:

   • Applies the add-agent role to hosts in the agent_nodes group.
   • Sets up the RKE2 worker nodes.

⚠️ Note:

MetalLB is currently not being installed. pfSense is being used as a LB.

6. Apply MetalLB and Rancher Manifests:
   • Applies the apply-manifests role to server_nodes.
   • Configures MetalLB for load balancing in bare metal environments.
   • Deploys Rancher and its dependencies: a. Creates the cattle-system namespace for Rancher. b. Installs cert-manager CRDs (Custom Resource Definitions). c. Creates the cert-manager namespace. d. Deploys cert-manager using Helm. e. Deploys Rancher using Helm, setting the hostname and replica count.

⚠️ Note:

Cert Manager is currently not being installed by Ansible. install-cert-mgr.sh in the script folder is installing cert manager. This is congfigured to use Let's Encrypt and NameCheap. see README

commnads

./search_helm_values.sh "tls-rancher-ingress"

Project Structure

├── README.md
├── collections
│   └── requirements.yaml
├── docs
│   └── domain.md
├── inventory
│   ├── group_vars
│   │   └── all.yaml
│   └── hosts.ini
├── roles
│   ├── add-agent
│   │   ├── README.md
│   │   ├── tasks
│   │   │   └── main.yaml
│   │   └── templates
│   │       ├── rke2-agent-config.j2
│   │       └── rke2-agent.service.j2
│   ├── add-server
│   │   ├── README.md
│   │   ├── tasks
│   │   │   └── main.yaml
│   │   └── templates
│   │       └── rke2-server-config.j2
│   ├── apply-manifests
│   │   ├── README.md
│   │   ├── tasks
│   │   │   └── main.yaml
│   │   └── templates
│   │       ├── metallb-ippool.j2
│   │       └── rancher-values.j2
│   ├── prepare-nodes
│   │   ├── README.md
│   │   ├── handlers
│   │   │   └── main.yaml
│   │   ├── tasks
│   │   │   └── main.yaml
│   │   └── templates
│   │       ├── chrony.conf.j2
│   │       └── ntp.conf.j2
│   ├── rke2-download
│   │   ├── README.md
│   │   └── tasks
│   │       └── main.yaml
│   └── rke2-prepare
│       ├── README.md
│       ├── tasks
│       │   └── main.yaml
│       └── templates
│           ├── rke2-agent.service.j2
│           ├── rke2-server-config.j2
│           └── rke2-server.service.j2
├── site.yaml
└── troubleshooting
    ├── hosts.ini
    ├── rancher_health_check.yaml
    └── uninstall.yaml

Each role has its own README file with detailed information about its tasks and variables.

Notes:

• The playbook is configured to use pfSense for load balancing instead of kube-vip.
• There are areas for potential improvement, including support for different OS & architectures, multiple CNIs, improved wait logic, better use of Kubernetes Ansible plugins, optimized flow logic, and general clean-up.
• Important: Remember to review and modify variables in the inventory/group_vars/all.yaml file before running the playbook.

This playbook provides a comprehensive setup for an RKE2 cluster with Rancher management. It's designed to work with pfSense for load balancing but can be customized based on specific deployment needs.

For detailed information about each role, please refer to the linked README files above.

Variables in inventory/group_vars/all.yaml

The all.yaml file contains important variables used throughout the playbook. Here's a breakdown of key variables:

• os and arch: Specify the operating system and architecture.
• ansible_ssh_private_key_file: Path to the SSH private key for authentication.
• ansible_python_interpreter: Path to the Python interpreter on the remote hosts.
• vip_interface and vip: Network interface and IP for the Virtual IP.
• metallb_version and lb_range: Version and IP range for MetalLB.
• rke2_version and rke2_install_dir: Version and installation directory for RKE2.
• cluster_cidr and service_cidr: CIDR ranges for the Kubernetes cluster and services.
• cert_manager_version: Version of cert-manager to install.
• rancher_hostname and rancher_bootstrap_password: Hostname and initial password for Rancher.

For a complete list and detailed explanations, refer to the all.yaml file directly.

Troubleshooting

For common issues and their solutions, please refer to the Troubleshooting Guide.