hybrid-cs-prov-cluster
Report Package hybrid-cs-prov-cluster
If you believe that this package or its contents contain harmful information, please inform us.
Please be aware that we will never share your credentials.
This Terraform Azure Verified Module deploys: terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance
ipm add --package avm-terraform/hybrid-cs-prov-cluster --version 2.0.2
Published: 26-03-2025
Project URL: https://ipmhub.io/avm-terraform
Package Type: Terraform
License: MIT
terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance
Module to onboard arc aks in azure stack hci.
Requirements
The following requirements are needed by this module:
Resources
The following resources are used by this module:
- azapi_resource.agent_pool (resource)
- azapi_resource.connected_cluster (resource)
- azapi_resource.provisioned_cluster_instance (resource)
- azurerm_key_vault_secret.ssh_private_key_pem (resource)
- azurerm_key_vault_secret.ssh_public_key (resource)
- azurerm_management_lock.this (resource)
- azurerm_role_assignment.this (resource)
- modtm_telemetry.telemetry (resource)
- random_uuid.telemetry (resource)
- terraform_data.replacement (resource)
- terraform_data.wait_aks_vhd_ready (resource)
- tls_private_key.rsa_key (resource)
- azurerm_client_config.current (data source)
- azurerm_client_config.telemetry (data source)
- modtm_module_source.telemetry (data source)
Required Inputs
The following input variables are required:
agent_pool_profiles
Description: The agent pool profiles
Type:
list(object({
count = number
enableAutoScaling = optional(bool)
nodeTaints = optional(list(string))
nodeLabels = optional(map(string))
maxPods = optional(number)
name = optional(string)
osSKU = optional(string, "CBLMariner")
osType = optional(string, "Linux")
vmSize = optional(string, "Standard_A4_v2")
}))
custom_location_id
Description: The id of the Custom location that used to create hybrid aks
Type: string
location
Description: Azure region where the resource should be deployed.
Type: string
logical_network_id
Description: The id of the logical network that the AKS nodes will be connected to.
Type: string
name
Description: The name of the hybrid aks
Type: string
resource_group_id
Description: The resource group id where the resources will be deployed.
Type: string
Optional Inputs
The following input variables are optional (have default values):
additional_nodepools
Description: Map of agent pool configurations
Type:
list(object({
name = string
count = number
enableAutoScaling = optional(bool)
nodeTaints = optional(list(string))
nodeLabels = optional(map(string))
maxPods = optional(number)
osSKU = optional(string, "CBLMariner")
osType = optional(string, "Linux")
vmSize = optional(string)
original = optional(bool, false)
}))
Default: []
azure_hybrid_benefit
Description: The Azure Hybrid Benefit for the kubernetes cluster.
Type: string
Default: "False"
control_plane_count
Description: The count of the control plane
Type: number
Default: 1
control_plane_ip
Description: The ip address of the control plane
Type: string
Default: null
control_plane_vm_size
Description: The size of the control plane VM
Type: string
Default: "Standard_A4_v2"
customer_managed_key
Description: A map describing customer-managed keys to associate with the resource. This includes the following properties:
key_vault_resource_id
- The resource ID of the Key Vault where the key is stored.key_name
- The name of the key.key_version
- (Optional) The version of the key. If not specified, the latest version is used.user_assigned_identity
- (Optional) An object representing a user-assigned identity with the following properties:resource_id
- The resource ID of the user-assigned identity.
Type:
object({
key_vault_resource_id = string
key_name = string
key_version = optional(string, null)
user_assigned_identity = optional(object({
resource_id = string
}), null)
})
Default: null
enable_azure_rbac
Description: Enable Azure RBAC for the kubernetes cluster
Type: bool
Default: true
enable_oidc_issuer
Description: (Optional) Enable OIDC Issuer
Type: bool
Default: null
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: false
enable_workload_identity
Description: (Optional) Enable Workload Identity
Type: bool
Default: null
is_exported
Description: Indicates whether the resource is exported
Type: bool
Default: false
kubernetes_version
Description: The kubernetes version
Type: string
Default: ""
lock
Description: 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 thekind
value. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})
Default: null
managed_identities
Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:
system_assigned
- (Optional) Specifies if the System Assigned Managed Identity should be enabled.user_assigned_resource_ids
- (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.
Type:
object({
system_assigned = optional(bool, false)
user_assigned_resource_ids = optional(set(string), [])
})
Default: {}
nfs_csi_driver_enabled
Description: Enable the NFS CSI driver for the kubernetes cluster.
Type: bool
Default: true
pod_cidr
Description: The CIDR range for the pods in the kubernetes cluster
Type: string
Default: "10.244.0.0/16"
rbac_admin_group_object_ids
Description: The object id of the admin group of the azure rbac
Type: list(string)
Default: []
role_assignments
Description: A map of role assignments to create on this resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
role_definition_id_or_name
- The ID or name of the role definition to assign to the principal.principal_id
- The ID of the principal to assign the role to.description
- The description of the role assignment.skip_service_principal_aad_check
- If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.condition
- The condition which will be used to scope the role assignment.condition_version
- The version of the condition syntax. Valid values are '2.0'.
Note: only set
skip_service_principal_aad_check
to true if you are assigning a role to a service principal.
Type:
map(object({
role_definition_id_or_name = string
principal_id = string
description = optional(string, null)
skip_service_principal_aad_check = optional(bool, false)
condition = optional(string, null)
condition_version = optional(string, null)
delegated_managed_identity_resource_id = optional(string, null)
principal_type = optional(string, null)
}))
Default: {}
smb_csi_driver_enabled
Description: Enable the SMB CSI driver for the kubernetes cluster.
Type: bool
Default: true
ssh_key_vault_id
Description: The id of the key vault that contains the SSH public and private keys.
Type: string
Default: null
ssh_private_key_pem_secret_name
Description: The name of the secret in the key vault that contains the SSH private key PEM.
Type: string
Default: "AksArcAgentSshPrivateKeyPem"
ssh_public_key
Description: The SSH public key that will be used to access the kubernetes cluster nodes. If not specified, a new SSH key pair will be generated.
Type: string
Default: null
ssh_public_key_secret_name
Description: The name of the secret in the key vault that contains the SSH public key.
Type: string
Default: "AksArcAgentSshPublicKey"
tags
Description: (Optional) Tags of the resource.
Type: map(string)
Default: null
tenant_id
Description: (Optional) Value of the tenant id
Type: string
Default: ""
Outputs
The following outputs are exported:
aks_cluster
Description: AKS Arc Cluster instance
resource_id
Description: AKS Arc Provisioned Cluster instance
rsa_private_key
Description: The RSA private key
Modules
No modules.
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.
Release History
Version 2.0.2 - 2025-03-17
What's Changed
- fix json format by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/57
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/2.0.1...2.0.2
Version 2.0.1 - 2025-02-27
What's Changed
- add timeout for aks arc & fix mac compatible by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/52
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/2.0.0...2.0.1
Version 2.0.0 - 2025-02-19
No release notes were published in the GitHub Release for this version.
Version 1.0.0 - 2025-01-26
What's Changed
- support azurerm 4.0 by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/44
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.6.0...1.0.0
Version 0.6.0 - 2024-12-24
What's Changed
- Support nodepool by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/38
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.5.2...0.6.0
Version 0.5.2 - 2024-12-16
What's Changed
- use az rest instead of aksarc by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/37
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.5.1...0.5.2
Version 0.5.1 - 2024-12-11
What's Changed
- Support nullable for oidc by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/34
- fix bug for azurerm rbac by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/35
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.5.0...0.5.1
Version 0.5.0 - 2024-11-13
What's Changed
- Add support for using latest kubernetes version if not specified by @sarathys in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/26
New Contributors
- @sarathys made their first contribution in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/26
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.4.0...0.5.0
Version 0.4.0 - 2024-10-16
What's Changed
- Add new variable 'tenant_id' by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/20
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.3.3...0.4.0
Version 0.3.3 - 2024-10-15
What's Changed
- Add tags for connected_cluster by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/19
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.3.2...0.3.3
Version 0.3.2 - 2024-10-15
What's Changed
- aadProfile = {} when enableAzureRBAC is null by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/17
- Fix bug: addProfile inconsistent by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/18
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.3.0...0.3.2
Version 0.3.0 - 2024-10-11
What's Changed
- Use resource group id by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/16
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.2.0...0.3.0
Version 0.2.0 - 2024-10-09
What's Changed
- Add new variables for export by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/15
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.1.3...0.2.0
Version 0.1.3 - 2024-09-30
No release notes were published in the GitHub Release for this version.
Version 0.1.2 - 2024-09-23
No release notes were published in the GitHub Release for this version.
Version 0.1.1 - 2024-09-14
What's Changed
- Update sample by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/8
- Update sample by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/9
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/compare/0.1.0...0.1.1
Version 0.1.0 - 2024-08-26
What's Changed
- chore: repository governance by @mbilalamjad in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/2
- AVM-Review-PR by @xhy8759 in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/1
- chore: repository governance by @segraef in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/4
New Contributors
- @mbilalamjad made their first contribution in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/2
- @xhy8759 made their first contribution in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/1
- @segraef made their first contribution in https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/pull/4
Full Changelog: https://github.com/Azure/terraform-azurerm-avm-res-hybridcontainerservice-provisionedclusterinstance/commits/0.1.0
{
"workingFolder": "packages",
"packages": [
// packages defined earlier
{
"name": "avm-terraform/hybrid-cs-prov-cluster",
"version": "2.0.2"
}
]
}
This package has no dependencies
Stats
Selected version:
2.0.2
Downloads this version:
0
Downloads all versions:
0
Latest version:
2.0.2
Latest update:
26-03-2025