NOTE: This module follows the semantic versioning and versions prior to 1.0.0 should be consider pre-release versions.
This is the Dev/Test Standard for AKS pattern module for Azure Verified Modules (AVM) library. This module deploys a dev/test standard AKS cluster along with an Azure container registry. It provisions an environment sufficient for most dev/test deployments for AKS. It leverages the AzureRM provider and sets a number of initial defaults to minimize the overall inputs for simple configurations.
Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. A module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to https://semver.org/
- Set up a GitHub repo environment called
test. - Configure environment protection rule to ensure that approval is required before deploying to this environment.
- Create a user-assigned managed identity in your test subscription.
- Create a role assignment for the managed identity on your test subscription, use the minimum required role.
- Configure federated identity credentials on the user assigned managed identity. Use the GitHub environment.
- Create the following environment secrets on the
testenvironment:- AZURE_CLIENT_ID
- AZURE_TENANT_ID
- AZURE_SUBSCRIPTION_ID
- Search and update TODOs within the code and remove the TODO comments once complete.
The following requirements are needed by this module:
-
terraform (>= 1.3.0)
-
azapi (>= 2.0.1, < 3.0)
-
azurerm (>= 4.0.0, <5.0)
-
modtm (~> 0.3)
-
random (~> 3.5)
The following resources are used by this module:
- azapi_update_resource.aks_cluster_post_create (resource)
- azurerm_container_registry.this (resource)
- azurerm_kubernetes_cluster.this (resource)
- azurerm_management_lock.this (resource)
- azurerm_role_assignment.acr (resource)
- azurerm_user_assigned_identity.aks (resource)
- modtm_telemetry.telemetry (resource)
- random_string.acr_suffix (resource)
- random_uuid.telemetry (resource)
- terraform_data.kubernetes_version_keeper (resource)
- azurerm_client_config.telemetry (data source)
- modtm_module_source.telemetry (data source)
The following input variables are required:
Description: The Azure region where the resources should be deployed.
Type: string
Description: The name for the AKS resources created in the specified Azure Resource Group. This variable overwrites the 'prefix' var (The 'prefix' var will still be applied to the dns_prefix if it is set)
Type: string
Description: The resource group where the resources will be deployed.
Type: string
The following input variables are optional (have default values):
Description: (Optional) A mapping of tags to assign to the Node Pool.
Type: map(string)
Default: null
Description: (Optional) The name of the container registry to use for the AKS cluster.
Type: string
Default: null
Description: (Optional) 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
Description: (Optional) Specify which Kubernetes release to use. Specify only minor version, such as '1.28'.
Type: string
Default: null
Description: (Optional) Controls the Resource Lock configuration for this resource. The following properties can be specified:
kind- (Required) The type of lock. Possible values are\"CanNotDelete\"and\"ReadOnly\".name- (Optional) The name of the lock. If not specified, a name will be generated based on thekindvalue. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})Default: null
Description: (Optional) Specify which Kubernetes release to use. Specify only minor version, such as '1.28'.
Type: string
Default: null
Description: (Optional) Object ID of groups with admin access.
Type: list(string)
Default: null
Description: (Optional) Is Role Based Access Control based on Azure AD enabled?
Type: bool
Default: null
Description: (Optional) The Tenant ID used for Azure Active Directory Application. If this isn't specified the Tenant ID of the current Subscription is used.
Type: string
Default: null
Description: (Optional) Tags of the resource.
Type: map(string)
Default: null
Description: (Optional) The name of the User Assigned Managed Identity to create.
Type: string
Default: null
Description: (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.
Type: set(string)
Default: []
The following outputs are exported:
Description: This is the full output for the resource.
Description: The azurerm_kubernetes_cluster's resource id.
No modules.
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.