updates to make module more production ready

examples/default/README.md

@@ -61,15 +61,14 @@ data "azurerm_client_config" "current" {}
 # Leaving location as `null` will cause the module to use the resource group location
 # with a data source.
 module "test" {
-  source                      = "../../"
-  kubernetes_version          = "1.30"
-  enable_telemetry            = var.enable_telemetry # see variables.tf
-  name                        = module.naming.kubernetes_cluster.name_unique
-  resource_group_name         = azurerm_resource_group.this.name
-  location                    = azurerm_resource_group.this.location
-  private_dns_zone_id         = azurerm_private_dns_zone.mydomain.id
-  private_dns_zone_id_enabled = true
-  rbac_aad_tenant_id          = data.azurerm_client_config.current.tenant_id
+  source              = "../../"
+  kubernetes_version  = "1.30"
+  enable_telemetry    = var.enable_telemetry # see variables.tf
+  name                = module.naming.kubernetes_cluster.name_unique
+  resource_group_name = azurerm_resource_group.this.name
+  location            = azurerm_resource_group.this.location
+  private_dns_zone_id = azurerm_private_dns_zone.mydomain.id
+  rbac_aad_tenant_id  = data.azurerm_client_config.current.tenant_id
   network = {
     name                = module.avm_res_network_virtualnetwork.name
     resource_group_name = azurerm_resource_group.this.name

examples/default/main.tf

@@ -55,15 +55,14 @@ data "azurerm_client_config" "current" {}
 # Leaving location as `null` will cause the module to use the resource group location
 # with a data source.
 module "test" {
-  source                      = "../../"
-  kubernetes_version          = "1.30"
-  enable_telemetry            = var.enable_telemetry # see variables.tf
-  name                        = module.naming.kubernetes_cluster.name_unique
-  resource_group_name         = azurerm_resource_group.this.name
-  location                    = azurerm_resource_group.this.location
-  private_dns_zone_id         = azurerm_private_dns_zone.mydomain.id
-  private_dns_zone_id_enabled = true
-  rbac_aad_tenant_id          = data.azurerm_client_config.current.tenant_id
+  source              = "../../"
+  kubernetes_version  = "1.30"
+  enable_telemetry    = var.enable_telemetry # see variables.tf
+  name                = module.naming.kubernetes_cluster.name_unique
+  resource_group_name = azurerm_resource_group.this.name
+  location            = azurerm_resource_group.this.location
+  private_dns_zone_id = azurerm_private_dns_zone.mydomain.id
+  rbac_aad_tenant_id  = data.azurerm_client_config.current.tenant_id
   network = {
     name                = module.avm_res_network_virtualnetwork.name
     resource_group_name = azurerm_resource_group.this.name

examples/with_availability_zone/README.md

@@ -37,7 +37,7 @@ module "naming" {
 
 resource "azurerm_user_assigned_identity" "this" {
   location            = azurerm_resource_group.this.location
-  name                = "uami-${var.kubernetes_cluster_name}"
+  name                = module.naming.user_assigned_identity.name_unique
   resource_group_name = azurerm_resource_group.this.name
 }
 
@@ -163,14 +163,6 @@ Type: `bool`
 
 Default: `true`
 
-### <a name="input_kubernetes_cluster_name"></a> [kubernetes\_cluster\_name](#input\_kubernetes\_cluster\_name)
-
-Description: The name of the Kubernetes cluster.
-
-Type: `string`
-
-Default: `"myAks"`
-
 ## Outputs
 
 No outputs.

examples/with_availability_zone/main.tf

@@ -31,7 +31,7 @@ module "naming" {
 
 resource "azurerm_user_assigned_identity" "this" {
   location            = azurerm_resource_group.this.location
-  name                = "uami-${var.kubernetes_cluster_name}"
+  name                = module.naming.user_assigned_identity.name_unique
   resource_group_name = azurerm_resource_group.this.name
 }
 
@@ -117,4 +117,4 @@ module "avm_res_network_virtualnetwork" {
       address_prefixes = ["10.31.129.0/24"]
     }
   }
-}
+}

examples/with_availability_zone/variables.tf

@@ -7,9 +7,3 @@ For more information see <https://aka.ms/avm/telemetryinfo>.
 If it is set to false, then no telemetry will be collected.
 DESCRIPTION
 }
-
-variable "kubernetes_cluster_name" {
-  type        = string
-  default     = "myAks"
-  description = "The name of the Kubernetes cluster."
-}

examples/without_acr/README.md

@@ -0,0 +1,165 @@
+<!-- BEGIN_TF_DOCS -->
+# AKS cluster without Container Registry
+
+This deploys the module without the Container Registry.
+
+```hcl
+terraform {
+  required_version = ">= 1.3.0"
+  required_providers {
+    azurerm = {
+      source  = "hashicorp/azurerm"
+      version = ">= 4, <5"
+    }
+  }
+}
+
+provider "azurerm" {
+  features {
+    resource_group {
+      prevent_deletion_if_contains_resources = false
+    }
+  }
+}
+
+# This ensures we have unique CAF compliant names for our resources.
+module "naming" {
+  source  = "Azure/naming/azurerm"
+  version = ">= 0.3.0"
+}
+
+# This is required for resource modules
+resource "azurerm_resource_group" "this" {
+  location = "West US" # Hardcoded because we have to test in a region without availability zones
+  name     = module.naming.resource_group.name_unique
+}
+
+resource "azurerm_user_assigned_identity" "this" {
+  location            = azurerm_resource_group.this.location
+  name                = module.naming.user_assigned_identity.name_unique
+  resource_group_name = azurerm_resource_group.this.name
+}
+
+data "azurerm_client_config" "current" {}
+
+# This is the module call
+# Do not specify location here due to the randomization above.
+module "test" {
+  source              = "../../"
+  kubernetes_version  = "1.31"
+  enable_telemetry    = var.enable_telemetry # see variables.tf
+  name                = module.naming.kubernetes_cluster.name_unique
+  resource_group_name = azurerm_resource_group.this.name
+  network = {
+    node_subnet_id = module.avm_res_network_virtualnetwork.subnets["subnet"].resource_id
+    pod_cidr       = "192.168.0.0/16"
+  }
+  managed_identities = {
+    user_assigned_resource_ids = [
+      azurerm_user_assigned_identity.this.id
+    ]
+  }
+  rbac_aad_admin_group_object_ids = [data.azurerm_client_config.current.object_id]
+
+  location = "AustraliaEast" # Hardcoded because we have to test in a region without availability zones
+  node_pools = {
+    workload = {
+      name                 = "workload"
+      vm_size              = "Standard_D2d_v5"
+      orchestrator_version = "1.31"
+      max_count            = 110
+      min_count            = 2
+      os_sku               = "AzureLinux"
+      mode                 = "User"
+    }
+  }
+}
+
+module "avm_res_network_virtualnetwork" {
+  source  = "Azure/avm-res-network-virtualnetwork/azurerm"
+  version = "0.5.0"
+
+  address_space       = ["10.31.0.0/16"]
+  location            = azurerm_resource_group.this.location
+  name                = "myvnet"
+  resource_group_name = azurerm_resource_group.this.name
+  subnets = {
+    "subnet" = {
+      name             = "nodecidr"
+      address_prefixes = ["10.31.0.0/17"]
+    }
+    "private_link_subnet" = {
+      name             = "private_link_subnet"
+      address_prefixes = ["10.31.129.0/24"]
+    }
+  }
+}
+```
+
+<!-- markdownlint-disable MD033 -->
+## Requirements
+
+The following requirements are needed by this module:
+
+- <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) (>= 1.3.0)
+
+- <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) (>= 4, <5)
+
+## Resources
+
+The following resources are used by this module:
+
+- [azurerm_resource_group.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) (resource)
+- [azurerm_user_assigned_identity.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity) (resource)
+- [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) (data source)
+
+<!-- markdownlint-disable MD013 -->
+## Required Inputs
+
+No required inputs.
+
+## Optional Inputs
+
+The following input variables are optional (have default values):
+
+### <a name="input_enable_telemetry"></a> [enable\_telemetry](#input\_enable\_telemetry)
+
+Description: This variable controls whether or not telemetry is enabled for the module.  
+For more information see <https://aka.ms/avm/telemetryinfo>.  
+If it is set to false, then no telemetry will be collected.
+
+Type: `bool`
+
+Default: `true`
+
+## Outputs
+
+No outputs.
+
+## Modules
+
+The following Modules are called:
+
+### <a name="module_avm_res_network_virtualnetwork"></a> [avm\_res\_network\_virtualnetwork](#module\_avm\_res\_network\_virtualnetwork)
+
+Source: Azure/avm-res-network-virtualnetwork/azurerm
+
+Version: 0.5.0
+
+### <a name="module_naming"></a> [naming](#module\_naming)
+
+Source: Azure/naming/azurerm
+
+Version: >= 0.3.0
+
+### <a name="module_test"></a> [test](#module\_test)
+
+Source: ../../
+
+Version:
+
+<!-- markdownlint-disable-next-line MD041 -->
+## Data Collection
+
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
+<!-- END_TF_DOCS -->

examples/without_acr/_footer.md

@@ -0,0 +1,4 @@
+<!-- markdownlint-disable-next-line MD041 -->
+## Data Collection
+
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

examples/without_acr/_header.md

@@ -0,0 +1,3 @@
+# AKS cluster without Container Registry
+
+This deploys the module without the Container Registry.

examples/without_acr/main.tf

@@ -0,0 +1,90 @@
+terraform {
+  required_version = ">= 1.3.0"
+  required_providers {
+    azurerm = {
+      source  = "hashicorp/azurerm"
+      version = ">= 4, <5"
+    }
+  }
+}
+
+provider "azurerm" {
+  features {
+    resource_group {
+      prevent_deletion_if_contains_resources = false
+    }
+  }
+}
+
+# This ensures we have unique CAF compliant names for our resources.
+module "naming" {
+  source  = "Azure/naming/azurerm"
+  version = ">= 0.3.0"
+}
+
+# This is required for resource modules
+resource "azurerm_resource_group" "this" {
+  location = "West US" # Hardcoded because we have to test in a region without availability zones
+  name     = module.naming.resource_group.name_unique
+}
+
+resource "azurerm_user_assigned_identity" "this" {
+  location            = azurerm_resource_group.this.location
+  name                = module.naming.user_assigned_identity.name_unique
+  resource_group_name = azurerm_resource_group.this.name
+}
+
+data "azurerm_client_config" "current" {}
+
+# This is the module call
+# Do not specify location here due to the randomization above.
+module "test" {
+  source              = "../../"
+  kubernetes_version  = "1.31"
+  enable_telemetry    = var.enable_telemetry # see variables.tf
+  name                = module.naming.kubernetes_cluster.name_unique
+  resource_group_name = azurerm_resource_group.this.name
+  network = {
+    node_subnet_id = module.avm_res_network_virtualnetwork.subnets["subnet"].resource_id
+    pod_cidr       = "192.168.0.0/16"
+  }
+  managed_identities = {
+    user_assigned_resource_ids = [
+      azurerm_user_assigned_identity.this.id
+    ]
+  }
+  rbac_aad_admin_group_object_ids = [data.azurerm_client_config.current.object_id]
+
+  location = "AustraliaEast" # Hardcoded because we have to test in a region without availability zones
+  node_pools = {
+    workload = {
+      name                 = "workload"
+      vm_size              = "Standard_D2d_v5"
+      orchestrator_version = "1.31"
+      max_count            = 110
+      min_count            = 2
+      os_sku               = "AzureLinux"
+      mode                 = "User"
+    }
+  }
+}
+
+module "avm_res_network_virtualnetwork" {
+  source  = "Azure/avm-res-network-virtualnetwork/azurerm"
+  version = "0.5.0"
+
+  address_space       = ["10.31.0.0/16"]
+  location            = azurerm_resource_group.this.location
+  name                = "myvnet"
+  resource_group_name = azurerm_resource_group.this.name
+  subnets = {
+    "subnet" = {
+      name             = "nodecidr"
+      address_prefixes = ["10.31.0.0/17"]
+    }
+    "private_link_subnet" = {
+      name             = "private_link_subnet"
+      address_prefixes = ["10.31.129.0/24"]
+    }
+  }
+}

examples/without_acr/variables.tf

@@ -0,0 +1,9 @@
+variable "enable_telemetry" {
+  type        = bool
+  default     = true
+  description = <<DESCRIPTION
+This variable controls whether or not telemetry is enabled for the module.
+For more information see <https://aka.ms/avm/telemetryinfo>.
+If it is set to false, then no telemetry will be collected.
+DESCRIPTION
+}

examples/without_availability_zone/README.md

@@ -36,7 +36,7 @@ resource "azurerm_resource_group" "this" {
 
 resource "azurerm_user_assigned_identity" "this" {
   location            = azurerm_resource_group.this.location
-  name                = "uami-${var.kubernetes_cluster_name}"
+  name                = "uami-${var.name}"
   resource_group_name = azurerm_resource_group.this.name
 }
 
@@ -161,7 +161,7 @@ Type: `bool`
 
 Default: `true`
 
-### <a name="input_kubernetes_cluster_name"></a> [kubernetes\_cluster\_name](#input\_kubernetes\_cluster\_name)
+### <a name="input_name"></a> [name](#input\_name)
 
 Description: The name of the Kubernetes cluster.