Configurar nomenclatura personalizada para a estrutura de automação

Artigo
10/27/2023

O SAP Deployment Automation Framework usa uma convenção de nomenclatura padrão para nomenclatura de recursos do Azure.

O módulo sap_namegenerator Terraform define os nomes de todos os recursos que a estrutura de automação implanta. O módulo está localizado no /deploy/terraform/terraform-units/modules/sap_namegenerator/ repositório. A estrutura também suporta fornecer seus próprios nomes para alguns dos recursos usando os arquivos de parâmetro.

A nomenclatura dos recursos usa o seguinte formato:

prefixo do recurso + resource_group_prefix + separador + nome do recurso + sufixo do recurso.

Se esses recursos não forem suficientes, você também poderá usar a lógica de nomenclatura personalizada fornecendo um arquivo JSON personalizado que contenha os nomes dos recursos ou modificando o módulo de nomenclatura usado pela automação.

Fornecer substituições de nome usando um arquivo JSON

Você pode especificar um arquivo JSON de nomenclatura personalizado em seu tfvars arquivo de parâmetros usando o name_override_file parâmetro.

O arquivo JSON tem seções para os diferentes tipos de recursos.

Os tipos de implantação são:

DEPLOYER (plano de controlo)
SDU (infraestrutura do sistema SAP)
WORKLOAD_ZONE (zona de carga de trabalho)

Nomes de conjuntos de disponibilidade

Os nomes para os conjuntos de disponibilidade são definidos na availabilityset_names estrutura. O exemplo a seguir lista os nomes dos conjuntos de disponibilidade para uma implantação.

  "availabilityset_names" : {
        "app": "app-avset",
        "db" : "db-avset",
        "scs": "scs-avset",
        "web": "web-avset"
    }

Nomes dos cofres de chaves

Os nomes dos cofres de chaves são definidos na keyvault_names estrutura. O exemplo a seguir lista os nomes dos cofres de chaves para uma implantação no DEV ambiente na Europa Ocidental.

"keyvault_names": {
        "DEPLOYER": {
            "private_access": "DEVWEEUprvtABC",
            "user_access": "DEVWEEUuserABC"
        },
        "SDU": {
            "private_access": "DEVWEEUSAP01X00pABC",
            "user_access": "DEVWEEUSAP01X00uABC"
        },
        "WORKLOAD_ZONE": {
            "private_access": "DEVWEEUSAP01prvtABC",
            "user_access": "DEVWEEUSAP01userABC"
        }
    }

Os nomes dos cofres de chaves precisam ser exclusivos no Azure. O SAP Deployment Automation Framework acrescenta três caracteres aleatórios (ABC no exemplo) no final do nome do cofre de chaves para reduzir a probabilidade de conflitos de nomes.

Os private_access nomes não são usados no momento.

Nomes de contas de armazenamento

Os nomes das contas de armazenamento são definidos na storageaccount_names estrutura. O exemplo a seguir lista os nomes de conta de armazenamento para uma implantação no DEV ambiente na Europa Ocidental.

"storageaccount_names": {
        "DEPLOYER": "devweeudiagabc",
        "LIBRARY": {
            "library_storageaccount_name": "devweeusaplibabc",
            "terraformstate_storageaccount_name": "devweeutfstateabc"
        },
        "SDU": "devweeusap01diagabc",
        "WORKLOAD_ZONE": {
            "landscape_shared_transport_storage_account_name": "devweeusap01sharedabc",
            "landscape_storageaccount_name": "devweeusap01diagabc",
            "witness_storageaccount_name": "devweeusap01witnessabc"
        }
    }

Os nomes dos cofres de chaves precisam ser exclusivos no Azure. O SAP Deployment Automation Framework acrescenta três caracteres aleatórios (abc no exemplo) no final do nome do cofre de chaves para reduzir a probabilidade de conflitos de nomes.

Nomes de máquinas virtuais

Os nomes para as máquinas virtuais são definidos na virtualmachine_names estrutura. Os nomes do computador e da máquina virtual podem ser fornecidos.

O exemplo a seguir lista os nomes de máquina virtual para uma implantação no DEV ambiente na Europa Ocidental. A implantação tem um servidor de banco de dados, dois servidores de aplicativos, um servidor de serviços centrais e um despachante da Web.

    "virtualmachine_names": {
        "ANCHOR_COMPUTERNAME": [],
        "ANCHOR_SECONDARY_DNSNAME": [],
        "ANCHOR_VMNAME": [],
        "ANYDB_COMPUTERNAME": [
            "x00db00l0abc"
        ],
        "ANYDB_SECONDARY_DNSNAME": [
            "x00dhdb00l0abc",
            "x00dhdb00l1abc"
        ],
        "ANYDB_VMNAME": [
            "x00db00l0abc"
        ],
        "APP_COMPUTERNAME": [
            "x00app00labc",
            "x00app01labc"
        ],
        "APP_SECONDARY_DNSNAME": [
            "x00app00labc",
            "x00app01labc"
        ],
        "APP_VMNAME": [
            "x00app00labc",
            "x00app01labc"
        ],
        "DEPLOYER": [
            "devweeudeploy00"
        ],
        "HANA_COMPUTERNAME": [
            "x00dhdb00l0af"
        ],
        "HANA_SECONDARY_DNSNAME": [
            "x00dhdb00l0abc"
        ],
        "HANA_VMNAME": [
            "x00dhdb00l0abc"
        ],
        "ISCSI_COMPUTERNAME": [
            "devsap01weeuiscsi00"
        ],
        "OBSERVER_COMPUTERNAME": [
            "x00observer00labc"
        ],
        "OBSERVER_VMNAME": [
            "x00observer00labc"
        ],
        "SCS_COMPUTERNAME": [
            "x00scs00labc"
        ],
        "SCS_SECONDARY_DNSNAME": [
            "x00scs00labc"
        ],
        "SCS_VMNAME": [
            "x00scs00labc"
        ],
        "WEB_COMPUTERNAME": [
            "x00web00labc"
        ],
        "WEB_SECONDARY_DNSNAME": [
            "x00web00labc"
        ],
        "WEB_VMNAME": [
            "x00web00labc"
        ]
    }

Configurar o módulo de nomenclatura personalizado

Há vários arquivos dentro do módulo para nomear recursos:

Os nomes de máquinas virtuais e computadores são definidos em (vm.tf).
A nomenclatura do grupo de recursos é definida em (resourcegroup.tf).
Os cofres de chaves são definidos em (keyvault.tf).
Os sufixos de recurso são definidos em (variables_local.tf).

Os diferentes nomes de recursos são identificados por prefixos no código Terraform:

As implantações do SAP deployer usam nomes de recursos com o prefixo deployer_.
As implantações da biblioteca SAP usam nomes de recursos com o prefixo library.
As implantações de cenário SAP usam nomes de recursos com o prefixo vnet_.
As implantações do sistema SAP usam nomes de recursos com o prefixo sdu_.

Os nomes calculados são retornados em um dicionário de dados, que é usado por todos os módulos Terraform.

Usar nomes personalizados

Alguns dos nomes de recursos podem ser alterados fornecendo parâmetros no tfvars arquivo de parâmetros.

Recurso	Parâmetro	Notas
`Prefix`	`custom_prefix`	Usado como prefixo para todos os recursos no grupo de recursos
`Resource group`	`resourcegroup_name`
`admin subnet name`	`admin_subnet_name`
`admin nsg name`	`admin_subnet_nsg_name`
`db subnet name`	`db_subnet_name`
`db nsg name`	`db_subnet_nsg_name`
`app subnet name`	`app_subnet_name`
`app nsg name`	`app_subnet_nsg_name`
`web subnet name`	`web_subnet_name`
`web nsg name`	`web_subnet_nsg_name`
`admin nsg name`	`admin_subnet_nsg_name`

Alterar o módulo de nomenclatura

Para preparar seu ambiente Terraform para nomenclatura personalizada, primeiro você precisa criar um módulo de nomenclatura personalizado. A maneira mais fácil é copiar o módulo existente e fazer as alterações necessárias no módulo copiado.

Crie uma pasta de nível raiz em seu ambiente Terraform. Um exemplo é Azure_SAP_Automated_Deployment.
Vá para sua nova pasta de nível raiz.
Clone o repositório da estrutura de automação. Esta etapa cria uma nova pasta sap-automation.
Crie uma pasta dentro da pasta de nível raiz chamada Contoso_naming.
Aceda à pasta sap-automation.
Confira a ramificação apropriada no Git.
Vá para \deploy\terraform\terraform-units\modules dentro da sap-automation pasta.
Copie a pasta para a Contoso_naming pastasap_namegenerator.

O módulo de nomenclatura é chamado a partir das pastas raiz terraform :

module "sap_namegenerator" {
  source           = "../../terraform-units/modules/sap_namegenerator"
  environment      = local.infrastructure.environment
  location         = local.infrastructure.region
  codename         = lower(try(local.infrastructure.codename, ""))
  random_id        = module.common_infrastructure.random_id
  sap_vnet_name    = local.vnet_logical_name
  sap_sid          = local.sap_sid
  db_sid           = local.db_sid
  app_ostype       = try(local.application.os.os_type, "LINUX")
  anchor_ostype    = upper(try(local.anchor_vms.os.os_type, "LINUX"))
  db_ostype        = try(local.databases[0].os.os_type, "LINUX")
  db_server_count  = var.database_server_count
  app_server_count = try(local.application.application_server_count, 0)
  web_server_count = try(local.application.webdispatcher_count, 0)
  scs_server_count = local.application.scs_high_availability ? 2 * local.application.scs_server_count : local.application.scs_server_count
  app_zones        = local.app_zones
  scs_zones        = local.scs_zones
  web_zones        = local.web_zones
  db_zones         = local.db_zones
  resource_offset  = try(var.options.resource_offset, 0)
  custom_prefix    = var.custom_prefix
}

Em seguida, você precisa apontar seus outros arquivos de módulo Terraform para seu módulo de nomenclatura personalizado. Esses arquivos de módulo incluem:

deploy\terraform\run\sap_system\module.tf
deploy\terraform\bootstrap\sap_deployer\module.tf
deploy\terraform\bootstrap\sap_library\module.tf
deploy\terraform\run\sap_library\module.tf
deploy\terraform\run\sap_deployer\module.tf

Para cada arquivo, altere a origem do módulo para apontar para o local do novo módulo sap_namegenerator de nomenclatura. Por exemplo:

module "sap_namegenerator" { source = "../../terraform-units/modules/sap_namegenerator" torna-se module "sap_namegenerator" { source = "../../../../Contoso_naming".

Alterar a lógica de nomenclatura do grupo de recursos

Para alterar a lógica de nomenclatura do grupo de recursos, vá para a pasta personalizada do módulo de nomenclatura (por exemplo, Workspaces\Contoso_naming). Em seguida, edite o arquivo resourcegroup.tf. Modifique o código a seguir com sua própria lógica de nomenclatura.

locals {

  // Resource group naming
  sdu_name = length(var.codename) > 0 ? (
    upper(format("%s-%s-%s_%s-%s", local.env_verified, local.location_short, local.sap_vnet_verified, var.codename, var.sap_sid))) : (
    upper(format("%s-%s-%s-%s", local.env_verified, local.location_short, local.sap_vnet_verified, var.sap_sid))
  )

  deployer_name  = upper(format("%s-%s-%s", local.deployer_env_verified, local.deployer_location_short, local.dep_vnet_verified))
  landscape_name = upper(format("%s-%s-%s", local.landscape_env_verified, local.location_short, local.sap_vnet_verified))
  library_name   = upper(format("%s-%s", local.library_env_verified, local.location_short))

  // Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. The name must be unique.
  deployer_storageaccount_name       = substr(replace(lower(format("%s%s%sdiag%s", local.deployer_env_verified, local.deployer_location_short, local.dep_vnet_verified, local.random_id_verified)), "/[^a-z0-9]/", ""), 0, var.azlimits.stgaccnt)
  landscape_storageaccount_name      = substr(replace(lower(format("%s%s%sdiag%s", local.landscape_env_verified, local.location_short, local.sap_vnet_verified, local.random_id_verified)), "/[^a-z0-9]/", ""), 0, var.azlimits.stgaccnt)
  library_storageaccount_name        = substr(replace(lower(format("%s%ssaplib%s", local.library_env_verified, local.location_short, local.random_id_verified)), "/[^a-z0-9]/", ""), 0, var.azlimits.stgaccnt)
  sdu_storageaccount_name            = substr(replace(lower(format("%s%s%sdiag%s", local.env_verified, local.location_short, local.sap_vnet_verified, local.random_id_verified)), "/[^a-z0-9]/", ""), 0, var.azlimits.stgaccnt)
  terraformstate_storageaccount_name = substr(replace(lower(format("%s%stfstate%s", local.library_env_verified, local.location_short, local.random_id_verified)), "/[^a-z0-9]/", ""), 0, var.azlimits.stgaccnt)

}

Alterar sufixos de recurso

Para alterar os sufixos de recursos, vá para a pasta personalizada do módulo de nomenclatura (por exemplo, Workspaces\Contoso_naming). Em seguida, edite o arquivo variables_local.tf. Modifique o mapa a seguir com seus próprios sufixos de recurso.

Nota

Altere apenas os valores do mapa. Não altere a chave do mapa, que o código Terraform usa. Por exemplo, se você quiser renomear o componente de interface de rede do administrador, altere "admin-nic" = "-admin-nic" para "admin-nic" = "yourNICname".

variable resource_suffixes {
  type        = map(string)
  description = "Extension of resource name"

  default = {
    "admin_nic"           = "-admin-nic"
    "admin_subnet"        = "admin-subnet"
    "admin_subnet_nsg"    = "adminSubnet-nsg"
    "app_alb"             = "app-alb"
    "app_avset"           = "app-avset"
    "app_subnet"          = "app-subnet"
    "app_subnet_nsg"      = "appSubnet-nsg"
    "db_alb"              = "db-alb"
    "db_alb_bepool"       = "dbAlb-bePool"
    "db_alb_feip"         = "dbAlb-feip"
    "db_alb_hp"           = "dbAlb-hp"
    "db_alb_rule"         = "dbAlb-rule_"
    "db_avset"            = "db-avset"
    "db_nic"              = "-db-nic"
    "db_subnet"           = "db-subnet"
    "db_subnet_nsg"       = "dbSubnet-nsg"
    "deployer_rg"         = "-INFRASTRUCTURE"
    "deployer_state"      = "_DEPLOYER.terraform.tfstate"
    "deployer_subnet"     = "_deployment-subnet"
    "deployer_subnet_nsg" = "_deployment-nsg"
    "iscsi_subnet"        = "iscsi-subnet"
    "iscsi_subnet_nsg"    = "iscsiSubnet-nsg"
    "library_rg"          = "-SAP_LIBRARY"
    "library_state"       = "_SAP-LIBRARY.terraform.tfstate"
    "kv"                  = ""
    "msi"                 = "-msi"
    "nic"                 = "-nic"
    "osdisk"              = "-OsDisk"
    "pip"                 = "-pip"
    "ppg"                 = "-ppg"
    "sapbits"             = "sapbits"
    "storage_nic"         = "-storage-nic"
    "storage_subnet"      = "_storage-subnet"
    "storage_subnet_nsg"  = "_storageSubnet-nsg"
    "scs_alb"             = "scs-alb"
    "scs_alb_bepool"      = "scsAlb-bePool"
    "scs_alb_feip"        = "scsAlb-feip"
    "scs_alb_hp"          = "scsAlb-hp"
    "scs_alb_rule"        = "scsAlb-rule_"
    "scs_avset"           = "scs-avset"
    "scs_ers_feip"        = "scsErs-feip"
    "scs_ers_hp"          = "scsErs-hp"
    "scs_ers_rule"        = "scsErs-rule_"
    "scs_scs_rule"        = "scsScs-rule_"
    "sdu_rg"              = ""
    "tfstate"             = "tfstate"
    "vm"                  = ""
    "vnet"                = "-vnet"
    "vnet_rg"             = "-INFRASTRUCTURE"
    "web_alb"             = "web-alb"
    "web_alb_bepool"      = "webAlb-bePool"
    "web_alb_feip"        = "webAlb-feip"
    "web_alb_hp"          = "webAlb-hp"
    "web_alb_inrule"      = "webAlb-inRule"
    "web_avset"           = "web-avset"
    "web_subnet"          = "web-subnet"
    "web_subnet_nsg"      = "webSubnet-nsg"

  }
}

Próximo passo

Saiba mais sobre convenções de nomenclatura

Partilhar via