設定自動化架構的自訂命名
SAP 部署自動化架構會針對 Azure 資源命名使用標準的命名慣例。
Terraform 模組 sap_namegenerator
會定義自動化架構部署的所有資源名稱。 模組位於 /deploy/terraform/terraform-units/modules/sap_namegenerator/
存放庫中。 此架構也支援使用參數檔案,針對部分資源提供您自己的名稱。
資源的命名會使用下列格式:
資源前置詞 + resource_group_prefix + 分隔符號 + 資源名稱 + 資源後置詞。
如果上述功能不足,您可透過提供包含資源名稱的自訂 JSON 檔案,或修改自動化所使用的命名模組來使用自訂的命名邏輯。
使用 JSON 檔案提供命名覆寫
您可以使用 name_override_file
參數,在 tfvars
參數檔案中指定自訂命名 JSON 檔案。
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 部署自動化架構會在金鑰保存庫名稱結尾附加三個隨機字元 (在此範例中為 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 部署自動化架構會在金鑰保存庫名稱結尾附加三個隨機字元 (在此範例中為 abc),以降低名稱衝突的機率。
虛擬機器名稱
虛擬機器的名稱將定義在 virtualmachine_names
結構中。 您可以同時提供電腦和虛擬機器名稱。
下列範例會列出西歐DEV
環境中部署的虛擬機器名稱。 部署具有資料庫伺服器、兩個應用程式伺服器、中央服務伺服器和 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"
]
}
設定自訂命名模組
模組內有多個檔案可用於命名資源:
- 虛擬機器和電腦名稱將定義在 (
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 環境以進行自訂命名,您必須先建立自訂命名模組。 最簡單的方法是複製現有的模組,並在複製的模組中進行必要的變更。
- 在 Terraform 環境中建立根層級的資料夾。 例如
Azure_SAP_Automated_Deployment
。 - 移至新的根層級資料夾。
- 複製自動化架構存放庫。 此步驟會建立新的資料夾
sap-automation
。 - 在根層級資料夾內建立名為
Contoso_naming
的資料夾。 - 移至
sap-automation
資料夾。 - 在 Git 中查看適當分支。
- 移至
sap-automation
資料夾中的\deploy\terraform\terraform-units\modules
。 - 將資料夾
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"
}
}