Skip to content

Commit 3864fbc

Browse files
ShawnJacksonShawnJackson
authored
Merge pull request #249923 from paulth1/sap-automation-batch4
[AQ] edit pass: sap-automation-batch4
2 parents bb2b06b + dbededc commit 3864fbc

File tree

4 files changed

+220
-225
lines changed

4 files changed

+220
-225
lines changed

‎articles/sap/automation/naming-module.md

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configure custom naming for the automation framework
3-
description: Explanation of how to implement custom naming conventions for the SAP on Azure Deployment Automation Framework.
3+
description: Explanation of how to implement custom naming conventions for SAP Deployment Automation Framework.
44
author: kimforss
55
ms.author: kimforss
66
ms.reviewer: kimforss
@@ -10,34 +10,33 @@ ms.service: sap-on-azure
1010
ms.subservice: sap-automation
1111
---
1212

13-
# Overview
13+
# Configure custom naming for the automation framework
1414

15-
The [SAP on Azure Deployment Automation Framework](deployment-framework.md) uses a standard naming convention for Azure [resource naming](naming.md).
15+
[SAP Deployment Automation Framework](deployment-framework.md) uses a standard naming convention for Azure [resource naming](naming.md).
1616

17-
The Terraform module `sap_namegenerator` defines the names of all resources that the automation framework deploys. The module is located at `/deploy/terraform/terraform-units/modules/sap_namegenerator/` in the repository. The framework also supports providing your own names for some of the resources using the [parameter files](configure-system.md).
17+
The Terraform module `sap_namegenerator` defines the names of all resources that the automation framework deploys. The module is located at `/deploy/terraform/terraform-units/modules/sap_namegenerator/` in the repository. The framework also supports providing your own names for some of the resources by using the [parameter files](configure-system.md).
1818

1919
The naming of the resources uses the following format:
2020

2121
resource prefix + resource_group_prefix + separator + resource name + resource suffix.
2222

23+
If these capabilities aren't enough, you can also use custom naming logic by either providing a custom JSON file that contains the resource names or by modifying the naming module used by the automation.
2324

24-
If these capabilities are not enough, you can also use custom naming logic by either providing a custom json file containing the resource names or by modifying the naming module used by the automation.
25+
## Provide name overrides by using a JSON file
2526

26-
## Provide name overrides using a json file
27+
You can specify a custom naming JSON file in your `tfvars` parameter file by using the `name_override_file` parameter.
2728

28-
You can specify a custom naming json file in your tfvars parameter file using the 'name_override_file' parameter.
29-
30-
The json file has sections for the different resource types.
29+
The JSON file has sections for the different resource types.
3130

3231
The deployment types are:
3332

34-
- DEPLOYER (Control Plane)
35-
- SDU (SAP System Infrastructure)
36-
- WORKLOAD_ZONE (Workload zone)
33+
- DEPLOYER (control plane)
34+
- SDU (SAP system infrastructure)
35+
- WORKLOAD_ZONE (workload zone)
3736

3837
### Availability set names
3938

40-
The names for the availability sets are defined in the "availabilityset_names" structure. The example below lists the availability set names for a deployment.
39+
The names for the availability sets are defined in the `availabilityset_names` structure. The following example lists the availability set names for a deployment.
4140

4241
```json
4342
"availabilityset_names" : {
@@ -47,9 +46,10 @@ The names for the availability sets are defined in the "availabilityset_names" s
4746
"web": "web-avset"
4847
}
4948
```
50-
### Key Vault names
5149

52-
The names for the key vaults are defined in the "keyvault_names" structure. The example below lists the key vault names for a deployment in the "DEV" environment in West Europe.
50+
### Key vault names
51+
52+
The names for the key vaults are defined in the `keyvault_names` structure. The following example lists the key vault names for a deployment in the `DEV` environment in West Europe.
5353

5454
```json
5555
"keyvault_names": {
@@ -68,14 +68,13 @@ The names for the key vaults are defined in the "keyvault_names" structure. The
6868
}
6969
```
7070

71-
> [!NOTE]
72-
> This key vault names need to be unique across Azure, SAP on Azure Deployment Automation Framework appends 3 random characters (ABC in the example) at the end of the key vault name to reduce the likelihood for name conflicts.
71+
The key vault names need to be unique across Azure. SAP Deployment Automation Framework appends three random characters (ABC in the example) at the end of the key vault name to reduce the likelihood for name conflicts.
7372

74-
The "private_access" names are currently not used.
73+
The `private_access` names are currently not used.
7574

76-
### Storage Account names
75+
### Storage account names
7776

78-
The names for the storage accounts are defined in the "storageaccount_names" structure. The example below lists the storage account names for a deployment in the "DEV" environment in West Europe.
77+
The names for the storage accounts are defined in the `storageaccount_names` structure. The following example lists the storage account names for a deployment in the `DEV` environment in West Europe.
7978

8079
```json
8180
"storageaccount_names": {
@@ -93,14 +92,14 @@ The names for the storage accounts are defined in the "storageaccount_names" str
9392
}
9493
```
9594

96-
> [!NOTE]
97-
> This key vault names need to be unique across Azure, SAP on Azure Deployment Automation Framework appends 3 random characters (abc in the example) at the end of the key vault name to reduce the likelihood for name conflicts.
9895

99-
### Virtual Machine names
96+
The key vault names need to be unique across Azure. SAP Deployment Automation Framework appends three random characters (abc in the example) at the end of the key vault name to reduce the likelihood for name conflicts.
97+
98+
### Virtual machine names
10099

101-
The names for the virtual machines are defined in the "virtualmachine_names" structure. Both the computer and the virtual machine names can be provided.
100+
The names for the virtual machines are defined in the `virtualmachine_names` structure. Both the computer and the virtual machine names can be provided.
102101

103-
The example below lists the virtual machine names for a deployment in the "DEV" environment in West Europe. The deployment has a database server, two application servers, a Central Services server and a web dispatcher.
102+
The following example lists the virtual machine names for a deployment in the `DEV` environment in West Europe. The deployment has a database server, two application servers, a central services server, and a web dispatcher.
104103

105104
```json
106105
"virtualmachine_names": {
@@ -171,30 +170,31 @@ The example below lists the virtual machine names for a deployment in the "DEV"
171170
}
172171
```
173172

174-
## Configure custom naming module
173+
## Configure the custom naming module
175174

176175
There are multiple files within the module for naming resources:
177176

178-
- Virtual machine (VM) and computer names are defined in (`vm.tf`)
179-
- Resource group naming is defined in (`resourcegroup.tf`)
180-
- Key vaults in (`keyvault.tf`)
181-
- Resource suffixes (`variables_local.tf`)
177+
- Virtual machine and computer names are defined in (`vm.tf`).
178+
- Resource group naming is defined in (`resourcegroup.tf`).
179+
- Key vaults are defined in (`keyvault.tf`).
180+
- Resource suffixes are defined in (`variables_local.tf`).
181+
182+
The different resource names are identified by prefixes in the Terraform code:
182183

183-
The different resource names are identified by prefixes in the Terraform code.
184-
- SAP deployer deployments use resource names with the prefix `deployer_`
185-
- SAP library deployments use resource names with the prefix `library`
186-
- SAP landscape deployments use resource names with the prefix `vnet_`
187-
- SAP system deployments use resource names with the prefix `sdu_`
184+
- SAP deployer deployments use resource names with the prefix `deployer_`.
185+
- SAP library deployments use resource names with the prefix `library`.
186+
- SAP landscape deployments use resource names with the prefix `vnet_`.
187+
- SAP system deployments use resource names with the prefix `sdu_`.
188188

189-
The calculated names are returned in a data dictionary, which is used by all the terraform modules.
189+
The calculated names are returned in a data dictionary, which is used by all the Terraform modules.
190190

191-
## Using custom names
191+
## Use custom names
192192

193-
Some of the resource names can be changed by providing parameters in the tfvars parameter file.
193+
Some of the resource names can be changed by providing parameters in the `tfvars` parameter file.
194194

195195
| Resource | Parameter | Notes |
196196
| ---------------------- | ----------------------- | ------------------------------------------------------------------ |
197-
| `Prefix` | `custom_prefix` | This is used as prefix for all the resources in the resource group |
197+
| `Prefix` | `custom_prefix` | Used as prefix for all the resources in the resource group |
198198
| `Resource group` | `resourcegroup_name` | |
199199
| `admin subnet name` | `admin_subnet_name` | |
200200
| `admin nsg name` | `admin_subnet_nsg_name` | |
@@ -206,20 +206,20 @@ Some of the resource names can be changed by providing parameters in the tfvars
206206
| `web nsg name` | `web_subnet_nsg_name` | |
207207
| `admin nsg name` | `admin_subnet_nsg_name` | |
208208

209-
## Changing the naming module
209+
## Change the naming module
210210

211-
To prepare your Terraform environment for custom naming, you first need to create custom naming module. The easiest way is to copy the existing module and make the required changes in the copied module.
211+
To prepare your Terraform environment for custom naming, you first need to create a custom naming module. The easiest way is to copy the existing module and make the required changes in the copied module.
212212

213-
1. Create a root-level folder in your Terraform environment. For example, `Azure_SAP_Automated_Deployment`.
214-
1. Navigate to your new root-level folder.
213+
1. Create a root-level folder in your Terraform environment. An example is `Azure_SAP_Automated_Deployment`.
214+
1. Go to your new root-level folder.
215215
1. Clone the [automation framework repository](https://github.com/Azure/sap-automation). This step creates a new folder `sap-automation`.
216216
1. Create a folder within the root-level folder called `Contoso_naming`.
217-
1. Navigate to the `sap-automation` folder.
218-
1. Check out the appropriate branch in git.
219-
1. Navigate to `\deploy\terraform\terraform-units\modules` within the `sap-automation` folder.
217+
1. Go to the `sap-automation` folder.
218+
1. Check out the appropriate branch in Git.
219+
1. Go to `\deploy\terraform\terraform-units\modules` within the `sap-automation` folder.
220220
1. Copy the folder `sap_namegenerator` to the `Contoso_naming` folder.
221221

222-
The naming module is called from the root terraform folders:
222+
The naming module is called from the root `terraform` folders:
223223

224224
```terraform
225225
module "sap_namegenerator" {
@@ -261,7 +261,7 @@ For each file, change the source for the module `sap_namegenerator` to point to
261261

262262
## Change resource group naming logic
263263

264-
To change your resource group's naming logic, navigate to your custom naming module folder (for example, `Workspaces\Contoso_naming`). Then, edit the file `resourcegroup.tf`. Modify the following code with your own naming logic.
264+
To change your resource group's naming logic, go to your custom naming module folder (for example, `Workspaces\Contoso_naming`). Then, edit the file `resourcegroup.tf`. Modify the following code with your own naming logic.
265265

266266
```terraform
267267
locals {
@@ -288,10 +288,10 @@ locals {
288288

289289
## Change resource suffixes
290290

291-
To change your resource suffixes, navigate to your custom naming module folder (for example, `Workspaces\Contoso_naming`). Then, edit the file `variables_local.tf`. Modify the following map with your own resource suffixes.
291+
To change your resource suffixes, go to your custom naming module folder (for example, `Workspaces\Contoso_naming`). Then, edit the file `variables_local.tf`. Modify the following map with your own resource suffixes.
292292

293293
> [!NOTE]
294-
> Only change the map **values**. Don't change the map **key**, which the Terraform code uses.
294+
> Only change the map *values*. Don't change the map *key*, which the Terraform code uses.
295295
> For example, if you want to rename the administrator network interface component, change `"admin-nic" = "-admin-nic"` to `"admin-nic" = "yourNICname"`.
296296
297297
```terraform
@@ -362,7 +362,7 @@ variable resource_suffixes {
362362
}
363363
```
364364

365-
## Next steps
365+
## Next step
366366

367367
> [!div class="nextstepaction"]
368368
> [Learn about naming conventions](naming.md)

‎articles/sap/automation/naming.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Naming standards for the automation framework
3-
description: Explanation of naming conventions for the SAP on Azure Deployment Automation Framework.
3+
description: Explanation of naming conventions for SAP Deployment Automation Framework.
44
author: kimforss
55
ms.author: kimforss
66
ms.reviewer: kimforss
@@ -10,36 +10,32 @@ ms.service: sap-on-azure
1010
ms.subservice: sap-automation
1111
---
1212

13-
# Naming conventions for SAP automation framework
13+
# Naming conventions for SAP Deployment Automation Framework
1414

15-
The [SAP on Azure Deployment Automation Framework](deployment-framework.md) uses standard naming conventions. Consistent naming helps the automation framework run correctly with Terraform. Standard naming helps you deploy the automation framework smoothly. For example, consistent naming helps you to:
15+
[SAP Deployment Automation Framework](deployment-framework.md) uses standard naming conventions. Consistent naming helps the automation framework run correctly with Terraform. Standard naming helps you deploy the automation framework smoothly. For example, consistent naming helps you to:
1616

1717
- Deploy the SAP virtual network infrastructure into any supported Azure region.
18-
19-
- Do multiple deployments with partitioned virtual networks.
20-
21-
- Deploy the SAP system into any SAP workload zone.
22-
23-
- Run regular and high availability (HA) instances
24-
18+
- Do multiple deployments with partitioned virtual networks.
19+
- Deploy the SAP system into any SAP workload zone.
20+
- Run regular and high availability instances.
2521
- Do disaster recovery and fall forward behavior.
2622

27-
Review the standard terms, area paths, variable names before you begin your deployment. If necessary, you can also [configure custom naming](naming-module.md).
23+
Review the standard terms, area paths, and variable names before you begin your deployment. If necessary, you can also [configure custom naming](naming-module.md).
2824

2925
## Placeholder values
3026

3127
The naming convention's example formats use the following placeholder values.
3228

33-
| Placeholder | Concept | Character limit | Example |
29+
| Placeholder | Concept | Character limit | Example |
3430
| ----------- | ------- | --------------- | ------- |
3531
| `{ENVIRONMENT}` | Environment | 5 | `DEV`, `PROTO`, `NP`, `PROD` |
3632
| `{REGION_MAP}` | [Region](#azure-region-names) map | 4 | `weus` for `westus` |
37-
| `{SAP_VNET}` | SAP virtual network (VNet) | 7 | `SAP0` |
33+
| `{SAP_VNET}` | SAP virtual network | 7 | `SAP0` |
3834
| `{SID}` | SAP system identifier | 3 | `X01` |
3935
| `{PREFIX}` | SAP resource prefix | | `DEV-WEEU-SAP01-X01` |
40-
| `{DEPLOY_VNET}` | Deployer VNet | 7 | |
41-
| `{REMOTE_VNET}` | Remote VNet | 7 | |
42-
| `{LOCAL_VNET}` |Local VNet | 7 | |
36+
| `{DEPLOY_VNET}` | Deployer virtual network | 7 | |
37+
| `{REMOTE_VNET}` | Remote virtual network | 7 | |
38+
| `{LOCAL_VNET}` |Local virtual network | 7 | |
4339
| `{CODENAME}` | Logical name for version | | `version1`, `beta` |
4440
| `{VM_NAME}` | VM name | | |
4541
| `{SUBNET}` | Subnet | | |
@@ -55,7 +51,7 @@ For an explanation of the **Format** column, see the [definitions for placeholde
5551

5652
| Concept | Character limit | Format | Example |
5753
| ------- | --------------- | ------ | ------- |
58-
| Resource Group | 80 | `{ENVIRONMENT}-{REGION_MAP}-{DEPLOY_VNET}-INFRASTRUCTURE` | `MGMT-WEEU-DEP00-INFRASTRUCTURE` |
54+
| Resource group | 80 | `{ENVIRONMENT}-{REGION_MAP}-{DEPLOY_VNET}-INFRASTRUCTURE` | `MGMT-WEEU-DEP00-INFRASTRUCTURE` |
5955
| Virtual network | 38 (64) | `{ENVIRONMENT}-{REGION_MAP}-{DEPLOY_VNET}-vnet` | `MGMT-WEEU-DEP00-vnet` |
6056
| Subnet | 80 | `{ENVIRONMENT}-{REGION_MAP}-{DEPLOY_VNET}_deployment-subnet` | `MGMT-WEEU-DEP00_deployment-subnet` |
6157
| Storage account | 24 | `{ENVIRONMENT}{REGION_MAP}{SAP_VNET}{DIAG}{RND}` | `mgmtweeudep00diagxxx` |
@@ -69,7 +65,7 @@ For an explanation of the **Format** column, see the [definitions for placeholde
6965
| Key vault | 24 | `{ENVIRONMENT}{REGION_MAP}{DEPLOY_VNET}{USER}{RND}` (deployment credentials) | `MGMTWEEUDEP00userxxx` |
7066
| Public IP address | | `{ENVIRONMENT}-{REGION_MAP}-{DEPLOY_VNET}_{COMPUTER_NAME}-pip` | `MGMT-WEEU-DEP00_permweeudep00deploy00-pip` |
7167

72-
### SAP Library names
68+
### SAP library names
7369

7470
For an explanation of the **Format** column, see the [definitions for placeholder values](#placeholder-values).
7571

@@ -79,7 +75,7 @@ For an explanation of the **Format** column, see the [definitions for placeholde
7975
| Storage account | 24 | `{ENVIRONMENT}{REGION_MAP}saplib(12CHAR){RND}` | `mgmtweeusaplibxxx` |
8076
| Storage account | 24 | `{ENVIRONMENT}{REGION_MAP}tfstate(12CHAR){RND}` | `mgmtweeutfstatexxx` |
8177

82-
### SAP Workload zone names
78+
### SAP workload zone names
8379

8480
For an explanation of the **Format** column, see the [definitions for placeholder values](#placeholder-values).
8581

@@ -104,7 +100,7 @@ For an explanation of the **Format** column, see the [definitions for placeholde
104100
| NetApp account | | `{ENVIRONMENT}{REGION_MAP}{SAP_VNET}_netapp_account` | `DEV-WEEU-SAP01_netapp_account` |
105101
| NetApp capacity pool | 24 | `{ENVIRONMENT}{REGION_MAP}{SAP_VNET}_netapp_pool` | `DEV-WEEU-SAP01_netapp_pool` |
106102

107-
### SAP System names
103+
### SAP system names
108104

109105
For an explanation of the **Format** column, see the [definitions for placeholder values](#placeholder-values).
110106

@@ -118,19 +114,17 @@ For an explanation of the **Format** column, see the [definitions for placeholde
118114
| Network security group | 80 | `{PREFIX}_utility-nsg` | `DEV-WEEU-SAP01_X01_dbSubnet-nsg` |
119115
| Network interface component | | `{PREFIX}_{VM_NAME}-{SUBNET}-nic` | `-app-nic`, `-web-nic`, `-admin-nic`, `-db-nic` |
120116
| Computer name (database) | 14 | `{SID}d{DBSID}##{OS flag l/w}{primary/secondary 0/1}{RND}` | `DEV-WEEU-SAP01-X01_x01dxdb00l0xxx` |
121-
| Computer name (non-database) | 14 | `{SID}{ROLE}##{OS flag l/w}{RND}` | `DEV-WEEU-SAP01-X01_x01app01l538`, `DEV-WEEU-SAP01-X01_x01scs01l538` |
117+
| Computer name (nondatabase) | 14 | `{SID}{ROLE}##{OS flag l/w}{RND}` | `DEV-WEEU-SAP01-X01_x01app01l538`, `DEV-WEEU-SAP01-X01_x01scs01l538` |
122118
| VM | | `{PREFIX}_{COMPUTER-NAME}` | |
123119
| Disk | | `{PREFIX}_{VM_NAME}-{disk_type}{counter}` | `{VM-NAME}-sap00`, `{VM-NAME}-data00`, `{VM-NAME}-log00`, `{VM-NAME}-backup00` |
124120
| OS disk | | `{PREFIX}_{VM_NAME}-osDisk` | `DEV-WEEU-SAP01-X01_x01scs00lxxx-OsDisk` |
125121
| Azure load balancer (utility)| 80 | `{PREFIX}_db-alb` | `DEV-WEEU-SAP01-X01_db-alb` |
126122
| Load balancer front-end IP address (utility)| | `{PREFIX}_dbAlb-feip` | `DEV-WEEU-SAP01-X01_dbAlb-feip` |
127-
| Load balancer backend pool (utility)| | `{PREFIX}_dbAlb-bePool` | `DEV-WEEU-SAP01-X01_dbAlb-bePool` |
123+
| Load balancer back-end pool (utility)| | `{PREFIX}_dbAlb-bePool` | `DEV-WEEU-SAP01-X01_dbAlb-bePool` |
128124
| Load balancer health probe (utility)| | `{PREFIX}_dbAlb-hp` | `DEV-WEEU-SAP01-X01_dbAlb-hp`|
129125
| Key vault (user) | 24 | `{SHORTPREFIX}u{RND}` | `DEVWEEUSAP01uX01xxx` |
130126
| NetApp volume (utility) | 24 | `{PREFIX}-utility` | `DEV-WEEU-SAP01-X01_sapmnt` |
131127

132-
133-
134128
> [!NOTE]
135129
> Disk numbering starts at zero. The naming convention uses a two-character format; for example, `00`.
136130
@@ -142,7 +136,7 @@ You can set the mapping under the variable `_region_mapping` in the name generat
142136

143137
Then, you can use the `_region_mapping` variable elsewhere, such as an area path. The format for an area path is `{ENVIRONMENT}-{REGION_MAP}-{SAP_VNET}-{ARTIFACT}` where:
144138

145-
- `{ENVIRONMENT}` is the name of the environment, or workload zone.
139+
- `{ENVIRONMENT}` is the name of the environment or workload zone.
146140
- `{REGION_MAP}` is the short form of the Azure region name.
147141
- `{SAP_VNET}` is the SAP virtual network within the environment.
148142
- `{ARTIFACT}` is the deployment artifact within the virtual network, such as `INFRASTRUCTURE`.

0 commit comments

Comments
 (0)