terraform-azurerm-avm-res-containerinstance-containergroup
AVM Module Repo for Azure ACI
MIT License
terraform-azurerm-avm-res-containerinstance-containergroup
[!IMPORTANT] As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules MUST NOT be published at version
1.0.0or higher at this time.All module MUST be published as a pre-release version (e.g.,
0.1.0,0.1.1,0.2.0, etc.) until the AVM framework becomes GA.However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.
Requirements
The following requirements are needed by this module:
Providers
The following providers are used by this module:
Resources
The following resources are used by this module:
- azurerm_container_group.this (resource)
- azurerm_private_endpoint.this (resource)
- azurerm_private_endpoint_application_security_group_association.this (resource)
- azurerm_role_assignment.this (resource)
- modtm_telemetry.telemetry (resource)
- random_uuid.telemetry (resource)
- azurerm_client_config.telemetry (data source)
- modtm_module_source.telemetry (data source)
Required Inputs
The following input variables are required:
location
Description: Azure region where the resource should be deployed.
Type: string
name
Description: The name of the resource.
Type: string
os_type
Description: The operating system type for the container group.
Type: string
resource_group_name
Description: The name of the resource group in which to create the resource.
Type: string
restart_policy
Description: The restart policy for the container group.
Type: string
Optional Inputs
The following input variables are optional (have default values):
containers
Description: A map of containers to run in the container group.
Type:
map(object({
image = string
cpu = number
memory = number
ports = list(object({
port = number
protocol = string
}))
volumes = map(object({
mount_path = string
name = string
read_only = optional(bool, false)
empty_dir = optional(bool, false)
secret = optional(map(string), null)
storage_account_name = optional(string, null)
storage_account_key = optional(string, null)
share_name = optional(string, null)
git_repo = optional(object({
url = optional(string, null)
directory = optional(string, null)
revision = optional(string, null)
}))
}))
environment_variables = optional(map(string), {})
secure_environment_variables = optional(map(string), {})
commands = optional(list(string), null)
}))
Default: {}
diagnostics_log_analytics
Description: The Log Analytics workspace configuration for diagnostics.
Type:
object({
workspace_id = string
workspace_key = string
})
Default: null
dns_name_label
Description: The DNS name label for the container group.
Type: string
Default: null
dns_name_label_reuse_policy
Description: The DNS name label reuse policy for the container group.
Type: string
Default: null
dns_name_servers
Description: A list of DNS name servers to use for the container group.
Type: list(string)
Default: []
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
exposed_ports
Description: A list of ports to expose on the container group.
Type:
list(object({
port = number
protocol = string
}))
Default: []
image_registry_credential
Description: The credentials for the image registry.
Type:
map(object({
user_assigned_identity_id = string
server = string
username = string
password = string
}))
Default: {}
key_vault_key_id
Description: The Key Vault key ID for the container group.
Type: string
Default: null
key_vault_user_assigned_identity_id
Description: The Key Vault user-assigned identity ID for the container group.
Type: string
Default: null
liveness_probe
Description: The liveness probe configuration for the container group.
Type:
object({
exec = object({
command = list(string)
})
period_seconds = number
failure_threshold = number
success_threshold = number
timeout_seconds = number
initial_delay_seconds = number
http_get = object({
path = string
port = number
http_headers = map(string)
})
tcp_socket = object({
port = number
})
})
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: {}
priority
Description: The Priority for the container group.
Type: string
Default: null
private_endpoints
Description: Private Endpoints Configuration
Type:
map(object({
name = optional(string, null)
role_assignments = optional(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)
})), {})
lock = optional(object({
kind = string
name = optional(string, null)
}), null)
tags = optional(map(string), null)
subnet_resource_id = string
subresource_name = string # NOTE: `subresource_name` can be excluded if the resource does not support multiple sub resource types (e.g. storage account supports blob, queue, etc)
private_dns_zone_group_name = optional(string, "default")
private_dns_zone_resource_ids = optional(set(string), [])
application_security_group_associations = optional(map(string), {})
private_service_connection_name = optional(string, null)
network_interface_name = optional(string, null)
location = optional(string, null)
resource_group_name = optional(string, null)
ip_configurations = optional(map(object({
name = string
private_ip_address = string
})), {})
}))
Default: {}
readiness_probe
Description: The readiness probe configuration for the container group.
Type:
object({
exec = object({
command = list(string)
})
period_seconds = number
failure_threshold = number
success_threshold = number
timeout_seconds = number
initial_delay_seconds = number
http_get = object({
path = string
port = number
http_headers = map(string)
})
tcp_socket = object({
port = number
})
})
Default: null
role_assignments
Description: The role assignments for the container group.
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: {}
subnet_ids
Description: The subnet IDs for the container group.
Type: list(string)
Default: []
tags
Description: (Optional) Tags of the resource.
Type: map(string)
Default: null
zones
Description: A list of availability zones in which the resource should be created.
Type: list(string)
Default: []
Outputs
The following outputs are exported:
fqdn
Description: The FQDN of the container group derived from dns_name_label
ip_address
Description: The IP address allocated to the container group
name
Description: Name of the container group
resource_group_name
Description: Name of the container group resource group
resource_id
Description: Resource ID of Container Group Instance
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.