|
| 1 | +--- |
| 2 | +sidebar_position: 7 |
| 3 | +sidebar_label: Rancher Terraform |
| 4 | +title: "Rancher Terraform" |
| 5 | +keywords: |
| 6 | + - Harvester |
| 7 | + - harvester |
| 8 | + - Rancher |
| 9 | + - rancher |
| 10 | + - Terraform |
| 11 | + - terraform |
| 12 | +description: Rancher Terraform allows administrators to create and manage RKE2 guest clusters using Terraform. |
| 13 | +--- |
| 14 | + |
| 15 | +The [Rancher Terraform Provider](https://registry.terraform.io/providers/rancher/rancher2/) allows administrators to create and manage RKE2 guest clusters using Terraform. |
| 16 | + |
| 17 | +## Deployment |
| 18 | + |
| 19 | +### Prerequisites |
| 20 | + |
| 21 | +- The Kubernetes cluster is built on top of Harvester VMs. |
| 22 | +- The Harvester VMs that run as guest Kubernetes nodes are in the same namespace. |
| 23 | + |
| 24 | + |
| 25 | +### Deploy Guest Clusters Using the Rancher Terraform Provider |
| 26 | + |
| 27 | +1. Create an API key. |
| 28 | + |
| 29 | + On the Rancher UI, go to **Account & API Keys** > **Create API key** > **Create**. |
| 30 | + |
| 31 | +  |
| 32 | +  |
| 33 | + |
| 34 | +1. Obtain the Harvester cluster ID. |
| 35 | + |
| 36 | + On the Rancher UI, go to **Virtualization Management** > **Manage** > **Related Resources** > **Mgmt Cluster Name**. |
| 37 | + |
| 38 | +  |
| 39 | + |
| 40 | +1. Obtain the kubeconfig for the Harvester Cloud Provider and the Harvester CSI Driver. |
| 41 | + |
| 42 | + |
| 43 | + ```shell |
| 44 | + # Generate harvester cloud provider kubeconfig |
| 45 | + RANCHER_SERVER_URL="<RANCHER_SERVER_URL>" # Pure server URL like https://192.168.0.181:6443 |
| 46 | + RANCHER_ACCESS_KEY="<RANCHER_ACCESS_KEY>" |
| 47 | + RANCHER_SECRET_KEY="<RANCHER_SECRET_KEY>" |
| 48 | + HARVESTER_CLUSTER_ID="<HARVESTER_CLUSTER_ID>" |
| 49 | + CLUSTER_NAME="rke2-demo" |
| 50 | + curl -k -X POST ${RANCHER_SERVER_URL}/k8s/clusters/${HARVESTER_CLUSTER_ID}/v1/harvester/kubeconfig \ |
| 51 | + -H 'Content-Type: application/json' \ |
| 52 | + -u ${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY} \ |
| 53 | + -d '{"clusterRoleName": "harvesterhci.io:cloudprovider", "namespace": "default", "serviceAccountName": "'${CLUSTER_NAME}'"}' | xargs | sed 's/\\n/\n/g' > ${CLUSTER_NAME}-kubeconfig |
| 54 | + ``` |
| 55 | + |
| 56 | +1. Prepare a `provider.tf` file with the following content: |
| 57 | + |
| 58 | + ```hcl |
| 59 | + terraform { |
| 60 | + required_providers { |
| 61 | + rancher2 = { |
| 62 | + source = "rancher/rancher2" |
| 63 | + version = "4.2.0" |
| 64 | + } |
| 65 | + } |
| 66 | + } |
| 67 | +
|
| 68 | + # Configure the Rancher2 provider to admin |
| 69 | + provider "rancher2" { |
| 70 | + api_url = "<api_url>" # API Endpoint on Account & API Keys page |
| 71 | + access_key = "<access_key>" |
| 72 | + secret_key = "<secret_key>" |
| 73 | + insecure = true # Set to true if the Rancher server uses a self-signed certificate |
| 74 | + } |
| 75 | + ``` |
| 76 | + |
| 77 | +1. Prepare a `main.tf` file with the following content: |
| 78 | + |
| 79 | + ```hcl |
| 80 | + # Get imported harvester cluster info |
| 81 | + data "rancher2_cluster_v2" "harv" { |
| 82 | + name = "<harvester_cluster_name_in_rancher>" |
| 83 | + } |
| 84 | +
|
| 85 | + # Create a new Cloud Credential for an imported Harvester cluster |
| 86 | + resource "rancher2_cloud_credential" "harv-cred" { |
| 87 | + name = "harv-cred" |
| 88 | + harvester_credential_config { |
| 89 | + cluster_id = data.rancher2_cluster_v2.harv.cluster_v1_id |
| 90 | + cluster_type = "imported" |
| 91 | + kubeconfig_content = data.rancher2_cluster_v2.harv.kube_config |
| 92 | + } |
| 93 | + } |
| 94 | +
|
| 95 | + # Create a new rancher2 machine config v2 using harvester node_driver |
| 96 | + resource "rancher2_machine_config_v2" "rke2-machine" { |
| 97 | + generate_name = "rke2-machine" |
| 98 | + harvester_config { |
| 99 | + vm_namespace = "default" |
| 100 | + cpu_count = "2" |
| 101 | + memory_size = "4" |
| 102 | + disk_info = <<EOF |
| 103 | + { |
| 104 | + "disks": [{ |
| 105 | + "imageName": "default/<vmimage-name>", |
| 106 | + "size": 15, |
| 107 | + "bootOrder": 1 |
| 108 | + }] |
| 109 | + } |
| 110 | + EOF |
| 111 | + network_info = <<EOF |
| 112 | + { |
| 113 | + "interfaces": [{ |
| 114 | + "networkName": "default/<network-name>" |
| 115 | + }] |
| 116 | + } |
| 117 | + EOF |
| 118 | + ssh_user = "<ssh_user>" |
| 119 | + user_data = <<EOF |
| 120 | + package_update: true |
| 121 | + packages: |
| 122 | + - qemu-guest-agent |
| 123 | + - iptables |
| 124 | + runcmd: |
| 125 | + - - systemctl |
| 126 | + - enable |
| 127 | + - '--now' |
| 128 | + - qemu-guest-agent.service |
| 129 | + EOF |
| 130 | + } |
| 131 | + } |
| 132 | +
|
| 133 | + resource "rancher2_cluster_v2" "rke2-demo" { |
| 134 | + name = "rke2-demo" |
| 135 | + kubernetes_version = "v1.28.10+rke2r1" |
| 136 | + rke_config { |
| 137 | + machine_pools { |
| 138 | + name = "pool1" |
| 139 | + cloud_credential_secret_name = rancher2_cloud_credential.harv-cred.id |
| 140 | + control_plane_role = true |
| 141 | + etcd_role = true |
| 142 | + worker_role = true |
| 143 | + quantity = 1 |
| 144 | + machine_config { |
| 145 | + kind = rancher2_machine_config_v2.rke2-machine.kind |
| 146 | + name = rancher2_machine_config_v2.rke2-machine.name |
| 147 | + } |
| 148 | + } |
| 149 | +
|
| 150 | + machine_selector_config { |
| 151 | + config = yamlencode({ |
| 152 | + cloud-provider-config = file("${path.module}/rke2-demo-kubeconfig") |
| 153 | + cloud-provider-name = "harvester" |
| 154 | + }) |
| 155 | + } |
| 156 | +
|
| 157 | + machine_global_config = <<EOF |
| 158 | + cni: "calico" |
| 159 | + disable-kube-proxy: false |
| 160 | + etcd-expose-metrics: false |
| 161 | + EOF |
| 162 | +
|
| 163 | + upgrade_strategy { |
| 164 | + control_plane_concurrency = "1" |
| 165 | + worker_concurrency = "1" |
| 166 | + } |
| 167 | +
|
| 168 | + etcd { |
| 169 | + snapshot_schedule_cron = "0 */5 * * *" |
| 170 | + snapshot_retention = 5 |
| 171 | + } |
| 172 | +
|
| 173 | + chart_values = <<EOF |
| 174 | + harvester-cloud-provider: |
| 175 | + clusterName: rke2-demo |
| 176 | + cloudConfigPath: /var/lib/rancher/rke2/etc/config-files/cloud-provider-config |
| 177 | + EOF |
| 178 | + } |
| 179 | + } |
| 180 | + ``` |
| 181 | +
|
| 182 | +1. Run `terraform init`. |
| 183 | +
|
| 184 | +1. Run `terraform apply`. |
0 commit comments