https://github.com/belgaied2/tf-module-rancher-rke2-vsphere
A Terraform module for deploying Rancher and a Downstream Cluster on vSphere.
https://github.com/belgaied2/tf-module-rancher-rke2-vsphere
Last synced: 3 months ago
JSON representation
A Terraform module for deploying Rancher and a Downstream Cluster on vSphere.
- Host: GitHub
- URL: https://github.com/belgaied2/tf-module-rancher-rke2-vsphere
- Owner: belgaied2
- Created: 2021-10-04T22:36:00.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-13T08:34:20.000Z (over 3 years ago)
- Last Synced: 2025-02-08T06:43:18.014Z (4 months ago)
- Language: HCL
- Homepage:
- Size: 35.2 KB
- Stars: 2
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Terraform Module for RKE2 and Rancher v2.6.0 on vSphere
This repository aims at providing a reference configuration / module to use in order to:
- Create a set of VMs on vSphere using CentOS 8.4
- Deploy 2 RKE2 Clusters, one with 3 nodes for Rancher and one with a variable amount of nodes as a downstream (application) cluster
- Have Rancher automatically installed with a given certificate on the 3-node cluster
- Have the other cluster automatically be imported into the Rancher installation.
# Principle
The principle to achieve the above uses Terraform Modules:
- A module for the infrastructure (creating VMs in vSphere)
- A module for the installation of RKE2 (with or without Rancher)
- A module for installing Apps through the Rancher Market Place.
- A module for importing a cluster into Rancher
Naturally, it is possible to modify the configuration to adapt it to you own needs. Example: if you don't need the provisioning of VMs in vSphere, you can use remove the call to that module in the `main.tf` and modify the other module calls (`rke2-upstream-provision` and `rke2-downstream-provision`) to use some other source for the IP addresses.
# Usage
## Pre-requisites
### Variables
A number of values necessary to the deployment of a Rancher platform were parametrized, making the module quite flexible. Some variables do not have a default value, it is necessary to provide these values for the configuration to apply. You can run `terraform apply` and answer the prompts with the necessary values, but this would be cumbursome. A better solution is to make use of a `tfvars` kind of file, which is a simple file with key,value pairs providing Terraform with all the necessary input it needs.
An sample `terraform.tfvars` is provided in the configuration, you can adapt it for your own environment.
### RKE2 Binaries
The module `tf-module-rke2-provision` deploys RKE2 in an Air Gapped environment using the procedure described [here](https://docs.rke2.io/install/airgap/#tarball-method) using the tarvall method. This procedure needs pre-downloaded tarball distribution of RKE2 including the RKE2 binary, all the system container images as well as a SHA256 checksum file, all of which can be found on the [Github Releases page for RKE2](https://github.com/rancher/rke2/releases/). These files should be copied into the folder `tf-module-rke2-provision/rke2`. Please also make sure to have a `install.sh` file in the same folder, coming from the current [RKE2 installation script](https://get.rke2.io/).
# Module description
## Requirements
| Name | Version |
|------|---------|
| [kubectl](#requirement\_kubectl) | 1.13.0 |
| [rancher2](#requirement\_rancher2) | 1.20.0 |
## Providers
| Name | Version |
|------|---------|
| [null](#provider\_null) | 3.1.0 |
| [rancher2.bootstrap](#provider\_rancher2.bootstrap) | 1.20.0 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| [rke2-downstream-import-cluster](#module\_rke2-downstream-import-cluster) | ./tf-module-downstream-deploy | n/a |
| [rke2-downstream-provision](#module\_rke2-downstream-provision) | ./tf-module-rke2-provision | n/a |
| [rke2-upstream-provision](#module\_rke2-upstream-provision) | ./tf-module-rke2-provision | n/a |
| [vsphere-infra-downstream](#module\_vsphere-infra-downstream) | ./tf-module-vsphere-infra | n/a |
| [vsphere-infra-rancher](#module\_vsphere-infra-rancher) | ./tf-module-vsphere-infra | n/a |
## Resources
| Name | Type |
|------|------|
| [null_resource.rancher_availability_check](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
| [rancher2_bootstrap.admin](https://registry.terraform.io/providers/rancher/rancher2/1.20.0/docs/resources/bootstrap) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [app\_cluster\_description](#input\_app\_cluster\_description) | Description of the Downstream Cluster to be created | `string` | n/a | yes |
| [app\_cluster\_name](#input\_app\_cluster\_name) | Name of the Downstream Cluster to be created | `string` | n/a | yes |
| [downstream\_cp\_vm\_count](#input\_downstream\_cp\_vm\_count) | Number of Control Plane VMs for the downstream Cluster | `number` | n/a | yes |
| [downstream\_vm\_name\_prefix](#input\_downstream\_vm\_name\_prefix) | Name prefix for the Downstream VMs | `string` | n/a | yes |
| [downstream\_wk\_vm\_count](#input\_downstream\_wk\_vm\_count) | Number of Worker VMs for the downstream Cluster | `number` | n/a | yes |
| [public\_key\_path](#input\_public\_key\_path) | path of public key to push to the VMs | `any` | n/a | yes |
| [rancher\_bootstrap\_password](#input\_rancher\_bootstrap\_password) | Desired password for Rancher | `string` | n/a | yes |
| [rancher\_hostname](#input\_rancher\_hostname) | Desired hostname for the Rancher App | `any` | n/a | yes |
| [rancher\_vm\_count](#input\_rancher\_vm\_count) | Number of VMs to spin up for RKE | `number` | `3` | no |
| [rancher\_vm\_name\_prefix](#input\_rancher\_vm\_name\_prefix) | Prefix for the VM name in vSphere | `string` | `"rancher-ha"` | no |
| [rke2\_token](#input\_rke2\_token) | Desired RKE2 token | `any` | n/a | yes |
| [ssh\_password](#input\_ssh\_password) | SSH Password to connect to VM with | `any` | n/a | yes |
| [ssh\_user](#input\_ssh\_user) | SSH Username to connect to VM with | `any` | n/a | yes |
| [vcenter\_host](#input\_vcenter\_host) | n/a | `string` | `""` | no |
| [vcenter\_password](#input\_vcenter\_password) | n/a | `string` | `""` | no |
| [vcenter\_username](#input\_vcenter\_username) | n/a | `string` | `""` | no |
| [vm\_cpus](#input\_vm\_cpus) | Number of CPUs to give to VM | `number` | `2` | no |
| [vm\_disk\_size](#input\_vm\_disk\_size) | Size in GB of the main VM's Disk | `number` | `20` | no |
| [vm\_mem](#input\_vm\_mem) | Memory size in MB for VM | `number` | `8192` | no |
| [vm\_template](#input\_vm\_template) | n/a | `string` | `""` | no |
| [vsphere\_dc](#input\_vsphere\_dc) | vSphere Datacenter to use to create VMs | `any` | n/a | yes |
| [vsphere\_ds](#input\_vsphere\_ds) | vSphere Datastore to use to create VMs | `any` | n/a | yes |
| [vsphere\_guest\_id](#input\_vsphere\_guest\_id) | Type of OS for Guest | `string` | `"rhel7_64Guest"` | no |
| [vsphere\_net](#input\_vsphere\_net) | vSphere Network to attribute the VMs to | `any` | n/a | yes |
| [vsphere\_rp](#input\_vsphere\_rp) | vSphere Resource Pool to attribute the VMs to | `any` | n/a | yes |
## Outputs
| Name | Description |
|------|-------------|
| [downstream\_import\_manifest](#output\_downstream\_import\_manifest) | n/a |
| [downstream\_kubeconfig](#output\_downstream\_kubeconfig) | n/a |
| [upstream\_kubeconfig](#output\_upstream\_kubeconfig) | n/a |