✨ Enhance variable descriptions in Terraform configuration for clarity and usability

main.tf

@@ -1,12 +1,22 @@
+/**
+ * # Root Configuration
+ *
+ * Orchestrates the homelab infrastructure:
+ * - **pip**      – Discovers the current public IP for firewall allowlisting.
+ * - **pangolin** – Deploys an Azure Linux VM as a reverse-proxy / WireGuard gateway.
+ * - **foundry**  – Creates a Proxmox LXC container running Foundry VTT.
+ * - **dns**      – Manages Cloudflare DNS records pointing at the Pangolin proxy.
+ */
+
 module "pip" {
   source = "./modules/pip"
 }
 
 module "pangolin" {
-  source = "./modules/pangolin"
-  ssh_pubkey = file(var.ssh_pubkey_path)
+  source                 = "./modules/pangolin"
+  ssh_pubkey             = file(var.ssh_pubkey_path)
   allowed_ssh_cidrs_ipv4 = ["${module.pip.ip}/32"]
-  admin_username = var.admin_username
+  admin_username         = var.admin_username
 }
 
 module "foundry" {
@@ -20,10 +30,10 @@ module "foundry" {
 }
 
 module "dns" {
-  source = "./modules/dns"
-  domain_zone_id = var.domain_zone_id
-  domain_name = var.domain
+  source            = "./modules/dns"
+  domain_zone_id    = var.domain_zone_id
+  domain_name       = var.domain
   pangolin-proxy-v4 = module.pangolin.public_ipv4
   pangolin-proxy-v6 = module.pangolin.public_ipv6
-  cdn_subdomains = ["foundry"]
+  cdn_subdomains    = ["foundry"]
 }

modules/dns/main.tf

@@ -1,3 +1,11 @@
+/**
+ * # DNS Module
+ *
+ * Manages Cloudflare DNS records for the root domain:
+ * - A / AAAA records for the apex and wildcard pointing at the Pangolin proxy.
+ * - CDN-proxied A / AAAA records for selected subdomains.
+ */
+
 terraform {
   required_providers {
     cloudflare = {

modules/dns/variables.tf

@@ -1,17 +1,21 @@
 variable "domain_zone_id" {
-  type = string
+  description = "Cloudflare Zone ID for the target domain."
+  type        = string
 }
 
 variable "domain_name" {
-  type = string
+  description = "Root domain name (e.g. 'example.com')."
+  type        = string
 }
 
 variable "pangolin-proxy-v4" {
-  type = string
+  description = "IPv4 address of the Pangolin reverse-proxy."
+  type        = string
 }
 
 variable "pangolin-proxy-v6" {
-  type = string
+  description = "IPv6 address of the Pangolin reverse-proxy."
+  type        = string
 }
 
 variable "cdn_subdomains" {

modules/foundry/main.tf

@@ -1,3 +1,10 @@
+/**
+ * # Foundry Module
+ *
+ * Creates a Proxmox LXC container running Foundry Virtual Tabletop.
+ * Supports configurable resources, networking, and static or DHCP addressing.
+ */
+
 terraform {
   required_providers {
     proxmox = {

modules/pangolin/main.tf

@@ -1,3 +1,10 @@
+/**
+ * # Pangolin Module
+ *
+ * Deploys an Azure Linux VM with dual-stack (IPv4 + IPv6) networking,
+ * intended as a reverse-proxy and WireGuard gateway for the homelab.
+ */
+
 terraform {
   required_providers {
      azurerm = {

modules/pangolin/outputs.tf

@@ -1,11 +1,14 @@
 output "public_ipv4" {
-  value = azurerm_public_ip.pip_v4.ip_address
+  description = "The static public IPv4 address of the Pangolin proxy."
+  value       = azurerm_public_ip.pip_v4.ip_address
 }
 
 output "public_ipv6" {
-  value = azurerm_public_ip.pip_v6.ip_address
+  description = "The static public IPv6 address of the Pangolin proxy."
+  value       = azurerm_public_ip.pip_v6.ip_address
 }
 
 output "ssh_ipv4" {
-  value = "ssh ${var.admin_username}@${azurerm_public_ip.pip_v4.ip_address}"
+  description = "Ready-to-use SSH command for connecting to the VM over IPv4."
+  value       = "ssh ${var.admin_username}@${azurerm_public_ip.pip_v4.ip_address}"
 }

modules/pangolin/variables.tf

@@ -1,20 +1,24 @@
 variable "location" {
-  type    = string
-  default = "westeurope"
+  description = "Azure region for all resources in this module."
+  type        = string
+  default     = "westeurope"
 }
 
 variable "environment" {
-  type    = string
-  default = "prod"
+  description = "Deployment environment label (e.g. 'prod', 'staging')."
+  type        = string
+  default     = "prod"
 }
 
 variable "instance" {
-  type    = string
-  default = "homelab"
+  description = "Instance identifier appended to resource names."
+  type        = string
+  default     = "homelab"
 }
 
 variable "tags" {
-  type = map(string)
+  description = "Tags applied to all Azure resources in this module."
+  type        = map(string)
   default = {
     project = "pangolin"
     env     = "prod"
@@ -22,47 +26,54 @@ variable "tags" {
 }
 
 variable "vm_name" {
-  type    = string
-  default = "pangolin-proxy"
+  description = "Name of the Azure Linux VM."
+  type        = string
+  default     = "pangolin-proxy"
 }
 
 variable "vm_size" {
-  type = string
-  default = "Standard_A2_v2"
+  description = "Azure VM size/SKU."
+  type        = string
+  default     = "Standard_A2_v2"
 }
 
 variable "admin_username" {
-  type = string
-  default = "azureuser"
+  description = "Admin SSH username for the VM."
+  type        = string
+  default     = "azureuser"
 }
 
 variable "ssh_pubkey" {
-  type = string
+  description = "SSH public key content for the admin user."
+  type        = string
 }
 
 variable "vnet_cidr_ipv4" {
-  type = string
-  default = "10.50.0.0/16"
+  description = "IPv4 address space for the virtual network."
+  type        = string
+  default     = "10.50.0.0/16"
 }
 
 variable "vnet_cidr_ipv6" {
-  type = string
-  default = "fd7d:bb99:1da4::/48"
+  description = "IPv6 address space for the virtual network."
+  type        = string
+  default     = "fd7d:bb99:1da4::/48"
 }
 
 variable "subnet_cidr_ipv4" {
-  type = string
-  default = "10.50.1.0/24"
+  description = "IPv4 CIDR for the VM subnet."
+  type        = string
+  default     = "10.50.1.0/24"
 }
 
-
 variable "subnet_cidr_ipv6" {
-  type = string
-  default = "fd7d:bb99:1da4:195::/64"
+  description = "IPv6 CIDR for the VM subnet."
+  type        = string
+  default     = "fd7d:bb99:1da4:195::/64"
 }
 
 variable "allowed_ssh_cidrs_ipv4" {
-  type = list(string)
   description = "IPv4 CIDRs allowed to SSH (22/tcp). Empty list means allow from anywhere."
-  default = []
+  type        = list(string)
+  default     = []
 }

modules/pip/main.tf

@@ -1,3 +1,10 @@
+/**
+ * # Public IP Module
+ *
+ * Discovers the caller's public IPv4 address using an external echo-IP service.
+ * Used to dynamically allowlist the deployer's IP in firewall rules.
+ */
+
 terraform {
   required_providers {
      http = { }

variables.tf

@@ -1,46 +1,84 @@
 variable "domain" {
-  type = string
+  description = "Root domain name managed in Cloudflare."
+  type        = string
 }
+
 variable "domain_zone_id" {
-  type = string
+  description = "Cloudflare Zone ID for the domain."
+  type        = string
 }
+
 variable "cloudflare_api_token" {
-  type = string
-  sensitive = true
+  description = "Cloudflare API token with DNS edit permissions."
+  type        = string
+  sensitive   = true
+}
+
+variable "pve_api_url" {
+  description = "Proxmox VE API endpoint URL."
+  type        = string
 }
 
-variable "pve_api_url"        { type = string }
 variable "pve_token" {
-  type = string
-  sensitive = true
+  description = "Proxmox VE API token in 'user@realm!tokenid=secret' format."
+  type        = string
+  sensitive   = true
 }
 
-variable "node_name"          { type = string }   # e.g. "pve"
-variable "datastore_id"       { type = string }   # e.g. "local-lvm"
-variable "bridge"             { type = string }   # e.g. "vmbr0"
+variable "node_name" {
+  description = "Proxmox node to deploy resources on (e.g. 'pve')."
+  type        = string
+}
 
-variable "template_vmid"      { type = number }   # VMID of your template
-variable "vm_id"              { type = number }   # VMID to assign
-variable "name"               { type = string }
+variable "datastore_id" {
+  description = "Proxmox datastore for VM/container disks (e.g. 'local-lvm')."
+  type        = string
+}
 
-variable "ssh_pubkey_path"    { type = string }   # e.g. "~/.ssh/id_ed25519.pub"
+variable "bridge" {
+  description = "Proxmox network bridge for VM/container NICs (e.g. 'vmbr0')."
+  type        = string
+}
+
+variable "template_vmid" {
+  description = "VMID of the Proxmox VM template to clone."
+  type        = number
+}
+
+variable "vm_id" {
+  description = "VMID to assign to the new VM."
+  type        = number
+}
+
+variable "name" {
+  description = "Name for the VM."
+  type        = string
+}
+
+variable "ssh_pubkey_path" {
+  description = "Path to the SSH public key file (e.g. '~/.ssh/id_ed25519.pub')."
+  type        = string
+}
 
 variable "admin_username" {
-  type = string
-  default = "azureuser"
+  description = "Admin username for provisioned VMs."
+  type        = string
+  default     = "azureuser"
 }
 
 variable "azure_location" {
-  type = string
-  default = "westeurope"
+  description = "Azure region for resource deployment."
+  type        = string
+  default     = "westeurope"
 }
 
 variable "azure_subscription_id" {
-  type = string
+  description = "Azure subscription ID to deploy resources into."
+  type        = string
 }
 
 variable "allowed_ssh_cidrs_ipv4" {
-  type = list(string)
   description = "IPv4 CIDRs allowed to SSH (22/tcp). Empty list means allow from anywhere."
-  default = []
+  type        = list(string)
+  default     = []
 }