Настройка пользовательского именования для платформы автоматизации

  • Статья

Sap Deployment Automation Framework использует стандартное соглашение об именовании ресурсов Azure.

Модуль Terraform sap_namegenerator определяет имена для всех ресурсов, которые развертываются платформой автоматизации. Этот модуль находится в репозитории /deploy/terraform/terraform-units/modules/sap_namegenerator/. Платформа также поддерживает предоставление собственных имен для некоторых ресурсов с помощью файлов параметров.

При именовании ресурсов используется следующий формат:

префикс ресурса + префикс группы ресурсов + разделитель + имя ресурса + суффикс ресурса.

Если эти возможности недостаточно, можно также использовать пользовательскую логику именования, предоставив пользовательский JSON-файл, содержащий имена ресурсов или изменив модуль именования, используемый автоматизацией.

Указание переопределения имен с помощью JSON-файла

В файле параметров можно указать пользовательский json-файл tfvars именования с помощью name_override_file параметра.

JSON-файл содержит разделы для различных типов ресурсов.

Типы развертывания:

  • DEPLOYER (плоскость управления)
  • SDU (инфраструктура системы SAP)
  • WORKLOAD_ZONE (зона рабочей нагрузки)

Имена групп доступности

Имена групп доступности определяются в availabilityset_names структуре. В следующем примере перечислены имена групп доступности для развертывания.

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

Имена хранилища ключей

Имена хранилищ ключей определяются в keyvault_names структуре. В следующем примере перечислены имена хранилища ключей для развертывания в DEV среде в Западной Европе.

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

Имена хранилища ключей должны быть уникальными в Azure. Sap Deployment Automation Framework добавляет три случайных символа (ABC в примере) в конце имени хранилища ключей, чтобы снизить вероятность конфликтов имен.

Имена в private_access настоящее время не используются.

Имена учетных записей хранения

Имена учетных записей хранения определяются в storageaccount_names структуре. В следующем примере перечислены имена учетных записей хранения для развертывания в DEV среде в Западной Европе.

"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"
        }
    }

Имена хранилища ключей должны быть уникальными в Azure. SAP Deployment Automation Framework добавляет три случайных символа (abc в примере) в конце имени хранилища ключей, чтобы снизить вероятность конфликтов имен.

Имена виртуальных машин

Имена виртуальных машин определяются в virtualmachine_names структуре. Можно указать имена компьютеров и виртуальных машин.

В следующем примере перечислены имена виртуальных машин для развертывания в DEV среде в Западной Европе. В развертывании есть сервер базы данных, два сервера приложений, сервер центральных служб и веб-диспетчер.

    "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"
        ]
    }

Настройка пользовательского модуля именования

В модуле именования ресурсов размещено несколько файлов:

  • Имена виртуальных машин и компьютеров определены в (vm.tf).
  • Именование групп ресурсов определено в (resourcegroup.tf).
  • Хранилища ключей определены в (keyvault.tf).
  • Суффиксы ресурсов определены в (variables_local.tf).

Различные имена ресурсов определяются префиксами в коде Terraform:

  • Развертывания развертывания развертывания SAP используют имена ресурсов с префиксом deployer_.
  • Развертывания библиотек SAP используют имена ресурсов с префиксом library.
  • Для развертывания ландшафтных сред SAP используются имена ресурсов с префиксом vnet_.
  • Развертывания системы SAP используют имена ресурсов с префиксом sdu_.

Вычисляемые имена возвращаются в словаре данных, который используется всеми модулями Terraform.

Использование пользовательских имен

Некоторые имена ресурсов можно изменить, указав параметры в tfvars файле параметров.

Ресурс Параметр Примечания.
Prefix custom_prefix Используется в качестве префикса для всех ресурсов в группе ресурсов
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

Изменение модуля именования

Чтобы подготовить среду Terraform для пользовательского именования, сначала необходимо создать пользовательский модуль именования. Проще всего скопировать существующий модуль и внести в эту копию необходимые изменения.

  1. Создайте в среде Terraform папку корневого уровня. Например, Azure_SAP_Automated_Deployment.
  2. Перейдите в новую папку корневого уровня.
  3. Клонируйте сюда репозиторий платформы автоматизации. Это действие создает новую папку sap-automation.
  4. Создайте в папке корневого уровня вложенную папку с именем Contoso_naming.
  5. Перейдите к папке sap-automation.
  6. Ознакомьтесь с соответствующей ветвью в Git.
  7. Перейдите \deploy\terraform\terraform-units\modules в папку sap-automation .
  8. Скопируйте папку sap_namegenerator в папку Contoso_naming.

Модуль именования вызывается из корневых 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
}

Теперь вам нужно указать другие файлы модуля Terraform для настраиваемого модуля именования. Сюда входят следующие файлы модулей:

  • 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

Для каждого файла измените источник для модуля sap_namegenerator, чтобы он указывал расположение нового модуля именования. Например:

module "sap_namegenerator" { source = "../../terraform-units/modules/sap_namegenerator" превращается в module "sap_namegenerator" { source = "../../../../Contoso_naming".

Изменение логики именования для групп ресурсов

Чтобы изменить логику именования группы ресурсов, перейдите в папку пользовательского модуля именования (например, Workspaces\Contoso_naming). Здесь измените файл resourcegroup.tf. Измените следующий код, добавив собственную логику именования.

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)

}

Изменение суффиксов ресурсов

Чтобы изменить суффиксы ресурсов, перейдите в папку пользовательского модуля именования (например, Workspaces\Contoso_naming). Здесь измените файл variables_local.tf. Измените приведенную ниже карту сопоставления, указав собственные суффиксы ресурсов.

Примечание.

Изменяйте в сопоставлении только значения. Не изменяйте ключ сопоставления, так как они используются в коде Terraform. Например, если вам нужно переименовать компонент сетевого интерфейса администратора, измените "admin-nic" = "-admin-nic" на "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"

  }
}

Следующий шаг

Learn about naming conventions (Сведения о соглашениях об именовании)