Merge pull request #48 from khanh-ph/release/2.0.0

Release version 2.0.0

Author: khanh-ph

.github/release.yml

@@ -15,6 +15,9 @@ changelog:
     - title: Bug Fixes
       labels:
         - bugfix
-    - title: Other Changes
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Other
       labels:
         - "*"

.github/workflows/add-pr-label.yml

@@ -33,3 +33,9 @@ jobs:
       if: ${{ startsWith(github.head_ref, 'breakingchange/') }}
       with:
         labels: breaking-change
+    
+    - name: Add `documentation` label
+      uses: actions-ecosystem/action-add-labels@v1
+      if: ${{ startsWith(github.head_ref, 'docs/') }}
+      with:
+        labels: documentation

README.md

@@ -1,8 +1,8 @@
 ## About the project
 
-An Infrastructure as Code (IaC) project to build up a bare metal Kubernetes cluster on [Proxmox VE](https://pve.proxmox.com/wiki/Main_Page) using [Terraform](https://www.terraform.io/) and [Kubespray](https://github.com/kubernetes-sigs/kubespray).
+An Infrastructure as Code (IaC) project to create a Kubernetes cluster on [Proxmox VE](https://pve.proxmox.com/wiki/Main_Page) using [Terraform](https://www.terraform.io/) and [Kubespray](https://github.com/kubernetes-sigs/kubespray).
 
-![Bare metal Kubernetes](baremetal-kubernetes.png)
+![Proxmox Kubernetes clusters](proxmox-kubernetes.png)
 
 ## Terminology
 
@@ -27,8 +27,8 @@ Throughout the guide, the term `deployment agent` is used to mean the machine wh
 
     ```sh
     # Clone the repo
-    git clone https://github.com/khanh-ph/baremetal-kubernetes.git
-    cd baremetal-kubernetes
+    git clone https://github.com/khanh-ph/proxmox-kubernetes.git
+    cd proxmox-kubernetes
     ```
 
 3. Set up the required environment variables:
@@ -76,7 +76,7 @@ Throughout the guide, the term `deployment agent` is used to mean the machine wh
 
 4. Once the deployment is complete, it's time to try `kubectl`:
     ```sh
-    ssh IP_OF_THE_CONTROL_PLANE_NODE
+    ssh CONTROL_PLANE_IP
     sudo kubectl get all -A
     ```
 
@@ -109,9 +109,9 @@ Below is the list of available options:
 
 ##### Deploy Kubernetes cluster on a private network
 
-* TF_VAR_vm_net_dhcp_enabled
+* TF_VAR_vm_net_use_dhcp
 * TF_VAR_vm_net_bridge
 * TF_VAR_vm_net_cidr
-* TF_VAR_bastion_host_ssh_ip
-* TF_VAR_bastion_host_ssh_user
-* TF_VAR_bastion_host_ssh_port
+* TF_VAR_bastion_ssh_ip
+* TF_VAR_bastion_ssh_user
+* TF_VAR_bastion_ssh_port

kube-config-vars.tf

@@ -53,19 +53,19 @@ variable "base64_ansible_private_key" {
   description = "The ansible private key for SSH based authentication in base64"
 }
 
-variable "bastion_host_ssh_ip" {
+variable "bastion_ssh_ip" {
   type        = string
   description = "IP of the bastion host. It could be either a public IP or an internal IP that the deployment agent can reach to."
   default     = ""
 }
 
-variable "bastion_host_ssh_user" {
+variable "bastion_ssh_user" {
   type        = string
   description = "Username of the bastion host"
   default     = "ubuntu"
 }
 
-variable "bastion_host_ssh_port" {
+variable "bastion_ssh_port" {
   type        = number
   description = "SSH port of the bastion host"
   default     = 22

kube-config.tf

@@ -4,7 +4,7 @@ resource "local_file" "inventory" {
     {
       control_plane_ips = "${join("\n", [for hostname, ip in module.infrastructure.control_planes : join("", [hostname, " ansible_ssh_host=${ip}", " ansible_connection=ssh"])])}"
       worker_ips        = "${join("\n", [for hostname, ip in module.infrastructure.workers : join("", [hostname, " ansible_ssh_host=${ip}", " ansible_connection=ssh"])])}"
-      bastion           = var.bastion_host_ssh_ip != "" ? "[bastion]\nbastion ansible_host=${var.bastion_host_ssh_ip} ansible_port=${var.bastion_host_ssh_port} ansible_user=${var.bastion_host_ssh_user}" : ""
+      bastion           = var.bastion_ssh_ip != "" ? "[bastion]\nbastion ansible_host=${var.bastion_ssh_ip} ansible_port=${var.bastion_ssh_port} ansible_user=${var.bastion_ssh_user}" : ""
     }
   )
   filename = "${var.ks_tmp}/inventory.ini"

kube-infra-vars.tf

@@ -58,7 +58,7 @@ variable "base64_vm_authorized_keys" {
   default     = ""
 }
 
-variable "vm_net_dhcp_enabled" {
+variable "vm_net_use_dhcp" {
   type        = bool
   description = "use DHCP for all VMs IP"
   default     = true

kube-infra.tf

@@ -10,27 +10,27 @@ module "infrastructure" {
   name = var.cluster_name
 
   control_plane = {
-    vm_count            = var.control_plane_node_count
-    vm_disk_storage     = var.vm_disk_storage
-    vm_os_disk_size_gb  = var.vm_os_disk_size_gb
-    vm_memory_mb        = var.vm_memory_mb
-    vm_cpus             = var.vm_cpus
-    vm_authorized_keys  = base64decode(var.base64_vm_authorized_keys)
-    vm_net_dhcp_enabled = var.vm_net_dhcp_enabled
-    vm_net_bridge       = var.vm_net_bridge
-    vm_net_cidr         = var.vm_net_cidr
+    vm_count           = var.control_plane_node_count
+    vm_disk_storage    = var.vm_disk_storage
+    vm_os_disk_size_gb = var.vm_os_disk_size_gb
+    vm_memory_mb       = var.vm_memory_mb
+    vm_cpus            = var.vm_cpus
+    vm_authorized_keys = base64decode(var.base64_vm_authorized_keys)
+    vm_net_use_dhcp    = var.vm_net_use_dhcp
+    vm_net_bridge      = var.vm_net_bridge
+    vm_net_cidr        = var.vm_net_cidr
   }
 
   worker = {
-    vm_count            = var.worker_node_count
-    vm_disk_storage     = var.vm_disk_storage
-    vm_os_disk_size_gb  = var.vm_os_disk_size_gb
-    vm_memory_mb        = var.vm_memory_mb
-    vm_cpus             = var.vm_cpus
-    vm_authorized_keys  = base64decode(var.base64_vm_authorized_keys)
-    vm_net_dhcp_enabled = var.vm_net_dhcp_enabled
-    vm_net_bridge       = var.vm_net_bridge
-    vm_net_cidr         = var.vm_net_cidr
+    vm_count           = var.worker_node_count
+    vm_disk_storage    = var.vm_disk_storage
+    vm_os_disk_size_gb = var.vm_os_disk_size_gb
+    vm_memory_mb       = var.vm_memory_mb
+    vm_cpus            = var.vm_cpus
+    vm_authorized_keys = base64decode(var.base64_vm_authorized_keys)
+    vm_net_use_dhcp    = var.vm_net_use_dhcp
+    vm_net_bridge      = var.vm_net_bridge
+    vm_net_cidr        = var.vm_net_cidr
   }
 }
 

modules/proxmox_kubernetes_cluster/main.tf

@@ -15,7 +15,7 @@ module "promox_kubernetes_worker" {
   vm_cpus              = var.worker.vm_cpus
   vm_os_disk_size_gb   = var.worker.vm_os_disk_size_gb
   vm_authorized_keys   = var.worker.vm_authorized_keys
-  vm_net_dhcp_enabled  = var.worker.vm_net_dhcp_enabled
+  vm_net_use_dhcp      = var.worker.vm_net_use_dhcp
   vm_net_bridge        = var.worker.vm_net_bridge
   vm_net_cidr          = var.worker.vm_net_cidr
   vm_net_hostnum_start = 20
@@ -38,7 +38,7 @@ module "promox_kubernetes_control_plane" {
   vm_cpus              = var.control_plane.vm_cpus
   vm_os_disk_size_gb   = var.control_plane.vm_os_disk_size_gb
   vm_authorized_keys   = var.control_plane.vm_authorized_keys
-  vm_net_dhcp_enabled  = var.control_plane.vm_net_dhcp_enabled
+  vm_net_use_dhcp      = var.control_plane.vm_net_use_dhcp
   vm_net_bridge        = var.control_plane.vm_net_bridge
   vm_net_cidr          = var.control_plane.vm_net_cidr
   vm_net_hostnum_start = 10

modules/proxmox_ubuntu_vm/main.tf

@@ -43,7 +43,7 @@ resource "proxmox_vm_qemu" "vm" {
     bridge = var.vm_net_bridge
   }
 
-  ipconfig0 = var.vm_net_dhcp_enabled == true ? "ip=dhcp" : "ip=${cidrhost(var.vm_net_cidr, var.vm_net_hostnum_start + count.index + 1)}/${split("/", var.vm_net_cidr)[1]},gw=${cidrhost(var.vm_net_cidr, 1)}"
+  ipconfig0 = var.vm_net_use_dhcp == true ? "ip=dhcp" : "ip=${cidrhost(var.vm_net_cidr, var.vm_net_hostnum_start + count.index + 1)}/${split("/", var.vm_net_cidr)[1]},gw=${cidrhost(var.vm_net_cidr, 1)}"
 
   ciuser  = var.vm_user
   sshkeys = <<EOF

modules/proxmox_ubuntu_vm/variables.tf

@@ -95,7 +95,7 @@ variable "vm_socket" {
   default     = 1
 }
 
-variable "vm_net_dhcp_enabled" {
+variable "vm_net_use_dhcp" {
   type        = bool
   description = "use DHCP for all VMs IP"
   default     = true