Cloud

Redpanda BYOVNet Module Options for Azure

This reference lists the inputs of the Redpanda BYOVNet Terraform module for Azure, version 2.0.1, grouped by purpose.

Use this reference to:

  • Look up the inputs of the Redpanda BYOVNet Terraform module for Azure

  • Find the default value of each input

  • Identify the inputs for deploying into existing VNets and resource groups

For the inputs of later releases, see the Inputs tab of the module on the Terraform Registry.

Inputs that the module declares but does not use, such as azure_subscription_id and the azure_use_* and azure_client_* authentication inputs, are not listed. Configure the subscription and authentication on the azurerm provider instead.

General

Input Type Default Description

region

string

"eastus"

The Azure region for the resources.

zones

list(string)

["eastus-az2"]

The physical availability zone IDs in the region, such as eastus-az1. The module places the NAT gateway in the first zone. The default fits only the eastus region, so set region and zones together.

azure_tenant_id

string

None usable. Always set.

The ID of your Microsoft Entra tenant, used for the key vaults. Always set this input: the module’s default is not your tenant ID.

tags

map(string)

None (required)

Tags applied to the resources that the module creates. To tag the Azure resources that the Redpanda agent creates, set tags on the redpanda_cluster resource.

resource_name_prefix

string

"pz-"

Text added to the start of the name of every resource other than resource groups. Storage account names use it with dashes removed and must fit the 24-character limit, so keep it short.

resource_group_name_prefix

string

""

Text added to the start of the name of every resource group.

Resource groups

Input Type Default Description

create_resource_groups

bool

true

When true, the module creates the resource groups. Set to false to use resource groups that already exist, and provide their names in the following inputs.

redpanda_resource_group_name

string

"redpanda-rg"

The name of the resource group for Redpanda resources.

redpanda_storage_resource_group_name

string

"storage-rg"

The name of the resource group for the storage accounts.

redpanda_network_resource_group_name

string

"network-rg"

The name of the resource group for the network resources. With an existing VNet, use the resource group that contains it.

redpanda_iam_resource_group_name

string

"iam-rg"

The name of the resource group for the user-assigned identities.

VNet and subnets

By default, the module creates the VNet, the subnets, and a NAT gateway. To deploy into a VNet that you manage, see Deploy with a pre-existing VNet.

Input Type Default Description

vnet_name

string

""

The name of an existing VNet. If empty, the module creates a VNet. The module creates the subnets in either case.

vnet_addresses

list(string)

["10.0.0.0/20"]

The address space of the VNet that the module creates.

private_subnets

map(map(string))

13 subnets. See Default private subnets.

The private subnets, keyed by role. Each entry sets the subnet’s cidr and name. Subnets must be at least /24. Keep the default keys: the module outputs that the redpanda_network resource reads are keyed on them.

egress_subnets

map(map(string))

{ "agent-public" = { "cidr" = "10.0.0.0/24", "name" = "snet-agent-public" } }

The egress subnets, in the same format as private_subnets. Subnets must be at least /24.

reserved_subnet_cidrs

map(string)

{ "k8s-service" = "10.0.15.0/24" }

The CIDR for AKS services. The module creates no subnet for it and reports it in its outputs. Pass the same value to customer_managed_resources.azure.cidrs.aks_service_cidr on the redpanda_cluster resource. Must not overlap any subnet.

create_nat

bool

true

When true, the module creates a NAT gateway for outbound traffic from the private subnets. If you set it to false, provide outbound internet access another way, for example through a peered hub VNet.

redpanda_security_group_name

string

"redpanda-nsg"

The name of the network security group for the cluster.

User-assigned identities

The names of the user-assigned identities that the module creates.

Input Type Default Description

redpanda_agent_identity_name

string

"agent-uai"

The identity for the Redpanda agent.

aks_identity_name

string

"aks-uai"

The identity for AKS.

redpanda_cluster_identity_name

string

"cluster-uai"

The identity for the Redpanda cluster.

redpanda_cert_manager_identity_name

string

"cert-manager-uai"

The identity for cert-manager.

redpanda_external_dns_identity_name

string

"external-dns-uai"

The identity for ExternalDNS.

redpanda_console_identity_name

string

"console-uai"

The identity for Redpanda Console.

kafka_connect_identity_name

string

"kafka-connect-uai"

The identity for Kafka Connect.

redpanda_connect_identity_name

string

"redpanda-connect-uai"

The identity for Redpanda Connect.

redpanda_connect_api_identity_name

string

"redpanda-connect-api-uai"

The identity for the Redpanda Connect API.

redpanda_operator_identity_name

string

"redpanda-operator-uai"

The identity for the Redpanda Operator.

Roles and role assignments

The module adds resource_name_prefix to the names of the custom roles that it creates.

Input Type Default Description

create_role_assignment

bool

true

When true, the module assigns the custom roles to the identities.

grant_caller_management_storage_access

bool

false

When true, grants the identity that runs Terraform the Storage Blob Data Contributor role on the management storage account. The Redpanda agent bootstrap keeps its state there, and the account allows only Microsoft Entra ID authentication. If you set it to false, assign the role yourself before you create the cluster.

redpanda_agent_role_name

string

"agent-role"

The name of the custom role for the Redpanda agent.

redpanda_private_link_role_name

string

"private-link-role"

The name of the custom role for Azure Private Link.

redpanda_console_role_name

string

"console-role"

The name of the custom role for Redpanda Console.

kafka_connect_role_name

string

"kafka-connect-role"

The name of the custom role for Kafka Connect.

redpanda_connect_role_name

string

"redpanda-connect-role"

The name of the custom role for Redpanda Connect.

redpanda_connect_api_role_name

string

"redpanda-connect-api-role"

The name of the custom role for the Redpanda Connect API.

redpanda_secrets_reader_role_name

string

"redpanda-secrets-reader-role"

The name of the custom role that reads secrets.

Storage and key vaults

Storage account names must be globally unique. The module adds resource_name_prefix to them with dashes removed.

Input Type Default Description

redpanda_management_storage_account_name

string

"managementa"

The name of the management storage account.

redpanda_management_storage_container_name

string

"managementc"

The name of the container in the management storage account.

redpanda_tiered_storage_account_name

string

"tieredstoragea"

The name of the Tiered Storage account.

redpanda_tiered_storage_container_name

string

"tieredstoragec"

The name of the container in the Tiered Storage account.

redpanda_management_key_vault_name

string

"rp-vault"

The name of the key vault for Redpanda management.

redpanda_console_key_vault_name

string

"console-vault"

The name of the key vault for Redpanda Console.

Default private subnets

The default value of private_subnets:

private_subnets = {
  "system-pod"         = { "cidr" = "10.0.1.0/24", "name" = "snet-system-pods" }
  "system-vnet"        = { "cidr" = "10.0.2.0/24", "name" = "snet-system-vnet" }
  "agent-private"      = { "cidr" = "10.0.3.0/24", "name" = "snet-agent-private" }
  "rp-0-pods"          = { "cidr" = "10.0.4.0/24", "name" = "snet-rp-0-pods" }
  "rp-0-vnet"          = { "cidr" = "10.0.5.0/24", "name" = "snet-rp-0-vnet" }
  "rp-1-pods"          = { "cidr" = "10.0.6.0/24", "name" = "snet-rp-1-pods" }
  "rp-1-vnet"          = { "cidr" = "10.0.7.0/24", "name" = "snet-rp-1-vnet" }
  "rp-2-pods"          = { "cidr" = "10.0.8.0/24", "name" = "snet-rp-2-pods" }
  "rp-2-vnet"          = { "cidr" = "10.0.9.0/24", "name" = "snet-rp-2-vnet" }
  "connect-pod"        = { "cidr" = "10.0.10.0/24", "name" = "snet-connect-pods" }
  "connect-vnet"       = { "cidr" = "10.0.11.0/24", "name" = "snet-connect-vnet" }
  "kafka-connect-pod"  = { "cidr" = "10.0.12.0/24", "name" = "snet-kafka-connect-pods" }
  "kafka-connect-vnet" = { "cidr" = "10.0.13.0/24", "name" = "snet-kafka-connect-vnet" }
}