如何在Terraform中按命名规范定义Azure AKS基础架构资源组

核心实现思路 #

要让Terraform部署的资源遵循客户命名规范，核心是通过抽离规范变量+动态拼接名称的方式，把命名规则固化到配置中，确保资源组名称严格符合要求（比如常见的「前缀-环境-区域-资源类型后缀」格式）。

具体操作步骤 #

1. 定义命名规范相关变量 #

先把命名规则里的固定/可配置部分抽成Terraform变量，方便统一维护和修改：

variable "naming_prefix" {
  description = "资源命名统一前缀（如客户业务线缩写）"
  type        = string
  default     = "contoso"
}

variable "environment" {
  description = "部署环境标识（如dev/prod/staging）"
  type        = string
  default     = "dev"
}

variable "region" {
  description = "Azure区域缩写（如eastus/westus）"
  type        = string
  default     = "eastus"
}

variable "rg_suffix" {
  description = "资源组专用后缀（如rg表示resource group）"
  type        = string
  default     = "rg"
}

2. 拼接名称并定义资源组 #

通过字符串拼接生成符合规范的资源组名称，再定义Azure资源组：

# 示例生成名称：contoso-dev-eastus-rg
resource "azurerm_resource_group" "aks_infra" {
  name     = "${var.naming_prefix}-${var.environment}-${var.region}-${var.rg_suffix}"
  location = var.region
}

如果客户规范要求包含「资源用途」标识（比如contoso-aks-dev-eastus-rg），只需调整拼接逻辑：

resource "azurerm_resource_group" "aks_infra" {
  name     = "${var.naming_prefix}-aks-${var.environment}-${var.region}-${var.rg_suffix}"
  location = var.region
}

3. 关联AKS集群到该资源组 #

后续定义AKS集群时，直接引用这个资源组的名称和位置即可：

resource "azurerm_kubernetes_cluster" "aks_cluster" {
  name                = "${var.naming_prefix}-aks-${var.environment}-${var.region}-cluster"
  location            = azurerm_resource_group.aks_infra.location
  resource_group_name = azurerm_resource_group.aks_infra.name
  # 其他AKS配置（节点池、网络等）...
}

4. 可选：用本地值固化命名逻辑 #

如果多个资源都要遵循同一规范，可以用locals统一管理命名模板，避免重复代码：

locals {
  ak_infra_naming = "${var.naming_prefix}-aks-${var.environment}-${var.region}"
}

resource "azurerm_resource_group" "aks_infra" {
  name     = "${local.ak_infra_naming}-rg"
  location = var.region
}

resource "azurerm_kubernetes_cluster" "aks_cluster" {
  name                = "${local.ak_infra_naming}-cluster"
  location            = azurerm_resource_group.aks_infra.location
  resource_group_name = azurerm_resource_group.aks_infra.name
  # 其他配置...
}

关键注意事项 #

• 确保生成的资源组名称符合Azure命名规则：长度1-90字符，仅允许字母、数字、连字符、下划线、句号和括号，且不能以连字符结尾。
• 可通过变量校验强制规范，比如限制环境值只能是指定选项：

variable "environment" {
  description = "部署环境标识"
  type        = string
  default     = "dev"
  validation {
    condition     = contains(["dev", "prod", "staging"], var.environment)
    error_message = "环境值必须是dev、prod或staging之一。"
  }
}

内容的提问来源于stack exchange，提问作者user21420008