feat!: rename variables for consistency with Azure resource schema

BREAKING CHANGES:
- Rename �nable_auto_scaling to �uto_scaling_enabled in variables and node_pools
- Rename �nable_host_encryption to host_encryption_enabled in variables and node_pools
- Rename �nable_node_public_ip to
ode_public_ip_enabled in variables and node_pools

These changes align variable naming with Azure resource schema conventions
and improve API consistency. Updated all references across:
- Root module variables and main resources
- Additional node pool resources
- Example configurations
- Documentation and upgrade notices

Fixes #685

Author: lonegunmanb

NoticeOnUpgradeTov11.0.md

@@ -1,3 +1,17 @@
-# Notice on Upgrade to v10.x
+# Notice on Upgrade to v11.0
+
+## AzureRM provider v3 support has been removed
 
 `v11.0.0` removed support for Terraform AzureRM provider `v3` and removed `//v4` folder. All users need to use `Azure/aks/azurerm` instead of `Azure/aks/azurerm//v4` as module `source`.
+
+## `var.enable_auto_scaling` has been renamed to `var.auto_scaling_enabled`
+
+This change also affects the `node_pools` variable where `node_pools[*].enable_auto_scaling` should be replaced with `node_pools[*].auto_scaling_enabled`.
+
+## `var.enable_host_encryption` has been renamed to `var.host_encryption_enabled`
+
+This change also affects the `node_pools` variable where `node_pools[*].enable_host_encryption` should be replaced with `node_pools[*].host_encryption_enabled`.
+
+## `var.enable_node_public_ip` has been renamed to `var.node_public_ip_enabled`
+
+This change also affects the `node_pools` variable where `node_pools[*].enable_node_public_ip` should be replaced with `node_pools[*].node_public_ip_enabled`.

README.md

@@ -162,10 +162,10 @@ module "aks" {
       ]
     }
   ]
-  agents_type            = "VirtualMachineScaleSets"
-  azure_policy_enabled   = true
-  enable_auto_scaling    = true
-  enable_host_encryption = true
+  agents_type             = "VirtualMachineScaleSets"
+  azure_policy_enabled    = true
+  auto_scaling_enabled    = true
+  host_encryption_enabled = true
   green_field_application_gateway_for_ingress = var.use_brown_field_application_gateway ? null : {
     name        = "ingress"
     subnet_cidr = local.appgw_cidr

examples/application_gateway_ingress/main.tf

@@ -68,9 +68,9 @@ module "aks" {
   confidential_computing = {
     sgx_quote_helper_enabled = true
   }
-  disk_encryption_set_id = azurerm_disk_encryption_set.des.id
-  enable_auto_scaling    = true
-  enable_host_encryption = true
+  disk_encryption_set_id  = azurerm_disk_encryption_set.des.id
+  auto_scaling_enabled    = true
+  host_encryption_enabled = true
   green_field_application_gateway_for_ingress = {
     name        = "${random_id.prefix.hex}-agw"
     subnet_cidr = "10.52.1.0/24"

examples/startup/main.tf

@@ -8,12 +8,12 @@ resource "azurerm_kubernetes_cluster_node_pool" "node_pool_create_before_destroy
 
   kubernetes_cluster_id         = azurerm_kubernetes_cluster.main.id
   name                          = "${each.value.name}${substr(md5(uuid()), 0, 4)}"
-  auto_scaling_enabled          = each.value.enable_auto_scaling
+  auto_scaling_enabled          = each.value.auto_scaling_enabled
   capacity_reservation_group_id = each.value.capacity_reservation_group_id
   eviction_policy               = each.value.eviction_policy
   fips_enabled                  = each.value.fips_enabled
   gpu_instance                  = each.value.gpu_instance
-  host_encryption_enabled       = each.value.enable_host_encryption
+  host_encryption_enabled       = each.value.host_encryption_enabled
   host_group_id                 = each.value.host_group_id
   kubelet_disk_type             = each.value.kubelet_disk_type
   max_count                     = each.value.max_count
@@ -22,7 +22,7 @@ resource "azurerm_kubernetes_cluster_node_pool" "node_pool_create_before_destroy
   mode                          = each.value.mode
   node_count                    = each.value.node_count
   node_labels                   = each.value.node_labels
-  node_public_ip_enabled        = each.value.enable_node_public_ip
+  node_public_ip_enabled        = each.value.node_public_ip_enabled
   node_public_ip_prefix_id      = each.value.node_public_ip_prefix_id
   node_taints                   = each.value.node_taints
   orchestrator_version          = each.value.orchestrator_version
@@ -171,11 +171,11 @@ resource "azurerm_kubernetes_cluster_node_pool" "node_pool_create_after_destroy"
 
   kubernetes_cluster_id         = azurerm_kubernetes_cluster.main.id
   name                          = each.value.name
-  auto_scaling_enabled          = each.value.enable_auto_scaling
+  auto_scaling_enabled          = each.value.auto_scaling_enabled
   capacity_reservation_group_id = each.value.capacity_reservation_group_id
   eviction_policy               = each.value.eviction_policy
   fips_enabled                  = each.value.fips_enabled
-  host_encryption_enabled       = each.value.enable_host_encryption
+  host_encryption_enabled       = each.value.host_encryption_enabled
   host_group_id                 = each.value.host_group_id
   kubelet_disk_type             = each.value.kubelet_disk_type
   max_count                     = each.value.max_count
@@ -184,7 +184,7 @@ resource "azurerm_kubernetes_cluster_node_pool" "node_pool_create_after_destroy"
   mode                          = each.value.mode
   node_count                    = each.value.node_count
   node_labels                   = each.value.node_labels
-  node_public_ip_enabled        = each.value.enable_node_public_ip
+  node_public_ip_enabled        = each.value.node_public_ip_enabled
   node_public_ip_prefix_id      = each.value.node_public_ip_prefix_id
   node_taints                   = each.value.node_taints
   orchestrator_version          = each.value.orchestrator_version

extra_node_pool.tf

@@ -39,20 +39,20 @@ resource "azurerm_kubernetes_cluster" "main" {
   workload_identity_enabled           = var.workload_identity_enabled
 
   dynamic "default_node_pool" {
-    for_each = var.enable_auto_scaling == true ? [] : ["default_node_pool_manually_scaled"]
+    for_each = var.auto_scaling_enabled == true ? [] : ["default_node_pool_manually_scaled"]
 
     content {
       name                         = var.agents_pool_name
       vm_size                      = var.agents_size
-      auto_scaling_enabled         = var.enable_auto_scaling
+      auto_scaling_enabled         = var.auto_scaling_enabled
       fips_enabled                 = var.default_node_pool_fips_enabled
-      host_encryption_enabled      = var.enable_host_encryption
+      host_encryption_enabled      = var.host_encryption_enabled
       max_count                    = null
       max_pods                     = var.agents_max_pods
       min_count                    = null
       node_count                   = var.agents_count
       node_labels                  = var.agents_labels
-      node_public_ip_enabled       = var.enable_node_public_ip
+      node_public_ip_enabled       = var.node_public_ip_enabled
       only_critical_addons_enabled = var.only_critical_addons_enabled
       orchestrator_version         = var.orchestrator_version
       os_disk_size_gb              = var.os_disk_size_gb
@@ -160,19 +160,19 @@ resource "azurerm_kubernetes_cluster" "main" {
     }
   }
   dynamic "default_node_pool" {
-    for_each = var.enable_auto_scaling == true ? ["default_node_pool_auto_scaled"] : []
+    for_each = var.auto_scaling_enabled == true ? ["default_node_pool_auto_scaled"] : []
 
     content {
       name                         = var.agents_pool_name
       vm_size                      = var.agents_size
-      auto_scaling_enabled         = var.enable_auto_scaling
+      auto_scaling_enabled         = var.auto_scaling_enabled
       fips_enabled                 = var.default_node_pool_fips_enabled
-      host_encryption_enabled      = var.enable_host_encryption
+      host_encryption_enabled      = var.host_encryption_enabled
       max_count                    = var.agents_max_count
       max_pods                     = var.agents_max_pods
       min_count                    = var.agents_min_count
       node_labels                  = var.agents_labels
-      node_public_ip_enabled       = var.enable_node_public_ip
+      node_public_ip_enabled       = var.node_public_ip_enabled
       only_critical_addons_enabled = var.only_critical_addons_enabled
       orchestrator_version         = var.orchestrator_version
       os_disk_size_gb              = var.os_disk_size_gb
@@ -644,7 +644,7 @@ resource "azurerm_kubernetes_cluster" "main" {
       error_message = "When `kubelet_identity` is enabled - The `type` field in the `identity` block must be set to `UserAssigned` and `identity_ids` must be set."
     }
     precondition {
-      condition     = var.enable_auto_scaling != true || var.agents_type == "VirtualMachineScaleSets"
+      condition     = var.auto_scaling_enabled != true || var.agents_type == "VirtualMachineScaleSets"
       error_message = "Autoscaling on default node pools is only supported when the Kubernetes Cluster is using Virtual Machine Scale Sets type nodes."
     }
     precondition {

main.tf

@@ -35,7 +35,7 @@ variable "agents_availability_zones" {
 variable "agents_count" {
   type        = number
   default     = 2
-  description = "The number of Agents that should exist in the Agent Pool. Please set `agents_count` `null` while `enable_auto_scaling` is `true` to avoid possible `agents_count` changes."
+  description = "The number of Agents that should exist in the Agent Pool. Please set `agents_count` `null` while `auto_scaling_enabled` is `true` to avoid possible `agents_count` changes."
 }
 
 variable "agents_labels" {
@@ -503,19 +503,19 @@ variable "ebpf_data_plane" {
   description = "(Optional) Specifies the eBPF data plane used for building the Kubernetes network. Possible value is `cilium`. Changing this forces a new resource to be created."
 }
 
-variable "enable_auto_scaling" {
+variable "auto_scaling_enabled" {
   type        = bool
   default     = false
   description = "Enable node pool autoscaling"
 }
 
-variable "enable_host_encryption" {
+variable "host_encryption_enabled" {
   type        = bool
   default     = false
   description = "Enable Host Encryption for default node pool. Encryption at host feature must be enabled on the subscription: https://docs.microsoft.com/azure/virtual-machines/linux/disks-enable-host-based-encryption-cli"
 }
 
-variable "enable_node_public_ip" {
+variable "node_public_ip_enabled" {
   type        = bool
   default     = false
   description = "(Optional) Should nodes in this Node Pool have a Public IP Address? Defaults to false."
@@ -1058,9 +1058,9 @@ variable "node_pools" {
     host_group_id                 = optional(string)
     capacity_reservation_group_id = optional(string)
     custom_ca_trust_enabled       = optional(bool)
-    enable_auto_scaling           = optional(bool)
-    enable_host_encryption        = optional(bool)
-    enable_node_public_ip         = optional(bool)
+    auto_scaling_enabled          = optional(bool)
+    host_encryption_enabled       = optional(bool)
+    node_public_ip_enabled        = optional(bool)
     eviction_policy               = optional(string)
     gpu_instance                  = optional(string)
     kubelet_config = optional(object({
@@ -1171,9 +1171,9 @@ variable "node_pools" {
     host_group_id                 = (Optional) The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from. Changing this forces a new resource to be created.
     capacity_reservation_group_id = (Optional) Specifies the ID of the Capacity Reservation Group where this Node Pool should exist. Changing this forces a new resource to be created.
     custom_ca_trust_enabled       = (Optional) Specifies whether to trust a Custom CA. This requires that the Preview Feature `Microsoft.ContainerService/CustomCATrustPreview` is enabled and the Resource Provider is re-registered, see [the documentation](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority) for more information.
-    enable_auto_scaling           = (Optional) Whether to enable [auto-scaler](https://docs.microsoft.com/azure/aks/cluster-autoscaler).
-    enable_host_encryption        = (Optional) Should the nodes in this Node Pool have host encryption enabled? Changing this forces a new resource to be created.
-    enable_node_public_ip         = (Optional) Should each node have a Public IP Address? Changing this forces a new resource to be created.
+    auto_scaling_enabled          = (Optional) Whether to enable [auto-scaler](https://docs.microsoft.com/azure/aks/cluster-autoscaler).
+    host_encryption_enabled       = (Optional) Should the nodes in this Node Pool have host encryption enabled? Changing this forces a new resource to be created.
+    node_public_ip_enabled        = (Optional) Should each node have a Public IP Address? Changing this forces a new resource to be created.
     eviction_policy               = (Optional) The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are `Deallocate` and `Delete`. Changing this forces a new resource to be created. An Eviction Policy can only be configured when `priority` is set to `Spot` and will default to `Delete` unless otherwise specified.
     gpu_instance                  = (Optional) Specifies the GPU MIG instance profile for supported GPU VM SKU. The allowed values are `MIG1g`, `MIG2g`, `MIG3g`, `MIG4g` and `MIG7g`. Changing this forces a new resource to be created.
     kubelet_config = optional(object({
@@ -1241,7 +1241,7 @@ variable "node_pools" {
       }))
     }))
     node_labels                  = (Optional) A map of Kubernetes labels which should be applied to nodes in this Node Pool.
-    node_public_ip_prefix_id     = (Optional) Resource ID for the Public IP Addresses Prefix for the nodes in this Node Pool. `enable_node_public_ip` should be `true`. Changing this forces a new resource to be created.
+    node_public_ip_prefix_id     = (Optional) Resource ID for the Public IP Addresses Prefix for the nodes in this Node Pool. `node_public_ip_enabled` should be `true`. Changing this forces a new resource to be created.
     node_taints                  = (Optional) A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g `key=value:NoSchedule`). Changing this forces a new resource to be created.
     orchestrator_version         = (Optional) Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won't auto-upgrade). AKS does not require an exact patch version to be specified, minor version aliases such as `1.22` are also supported. - The minor version's latest GA patch is automatically chosen in that case. More details can be found in [the documentation](https://docs.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli#alias-minor-version). This version must be supported by the Kubernetes Cluster - as such the version of Kubernetes used on the Cluster/Control Plane may need to be upgraded first.
     os_disk_size_gb              = (Optional) The Agent Operating System disk size in GB. Changing this forces a new resource to be created.