Skip to content

Commit 59b331b

Browse files
authored
Merge pull request #211239 from KimForss/main
Release 3.5 updates
2 parents 227bdd7 + 6e4d1bb commit 59b331b

File tree

5 files changed

+98
-85
lines changed

5 files changed

+98
-85
lines changed

articles/virtual-machines/workloads/sap/automation-configure-control-plane.md

Lines changed: 60 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The control plane for the [SAP deployment automation framework on Azure](automat
1919

2020
## Deployer
2121

22-
The [deployer](automation-deployment-framework.md#deployment-components) is the execution engine of the [SAP automation framework](automation-deployment-framework.md). It's a pre-configured virtual machine (VM) that is used for executing Terraform and Ansible commands.
22+
The [deployer](automation-deployment-framework.md#deployment-components) is the execution engine of the [SAP automation framework](automation-deployment-framework.md). It's a pre-configured virtual machine (VM) that is used for executing Terraform and Ansible commands.
2323

2424
The configuration of the deployer is performed in a Terraform tfvars variable file.
2525

@@ -29,8 +29,8 @@ The table below contains the Terraform parameters, these parameters need to be
2929

3030
> [!div class="mx-tdCol2BreakAll "]
3131
> | Variable | Description | Type |
32-
> | ----------------------- | ------------------------------------------------------------------------------------------------------------ | ---------- |
33-
> | `tfstate_resource_id` | Azure resource identifier for the storage account in the SAP Library that contains the Terraform state files | Required |
32+
> | ----------------------- | ------------------------------------------------------------------------------------------------------------ | ---------- |
33+
> | `tfstate_resource_id` | Azure resource identifier for the storage account in the SAP Library that contains the Terraform state files | Required |
3434
3535

3636
### Environment Parameters
@@ -49,20 +49,20 @@ The table below contains the parameters that define the resource naming.
4949
The table below contains the parameters that define the resource group.
5050

5151
> [!div class="mx-tdCol2BreakAll "]
52-
> | Variable | Description | Type |
53-
> | ----------------------- | -------------------------------------------------------- | ---------- |
52+
> | Variable | Description | Type |
53+
> | ----------------------- | -------------------------------------------------------- | ---------- |
5454
> | `resource_group_name` | Name of the resource group to be created | Optional |
55-
> | `resource_group_arm_id` | Azure resource identifier for an existing resource group | Optional |
56-
> | `resourcegroup_tags` | Tags to be associated with the resource group | Optional |
55+
> | `resource_group_arm_id` | Azure resource identifier for an existing resource group | Optional |
56+
> | `resourcegroup_tags` | Tags to be associated with the resource group | Optional |
5757
5858

5959
### Network Parameters
6060

6161
The automation framework supports both creating the virtual network and the subnets (green field) or using an existing virtual network and existing subnets (brown field) or a combination of green field and brown field.
62-
- For the green field scenario, the virtual network address space and the subnet address prefixes must be specified
62+
- For the green field scenario, the virtual network address space and the subnet address prefixes must be specified
6363
- For the brown field scenario, the Azure resource identifier for the virtual network and the subnets must be specified
6464

65-
The recommended CIDR of the virtual network address space is /27, which allows space for 32 IP addresses. A CIDR value of /28 only allows 16 IP addresses. If you want to include Azure Firewall, use a CIDR value of /25, because Azure Firewall requires a range of /26.
65+
The recommended CIDR of the virtual network address space is /27, which allows space for 32 IP addresses. A CIDR value of /28 only allows 16 IP addresses. If you want to include Azure Firewall, use a CIDR value of /25, because Azure Firewall requires a range of /26.
6666

6767
The recommended CIDR value for the management subnet is /28 that allows 16 IP addresses.
6868
The recommended CIDR value for the firewall subnet is /26 that allows 64 IP addresses.
@@ -82,58 +82,74 @@ The table below contains the networking parameters.
8282
> | `management_subnet_arm_id` | The Azure resource identifier for the subnet | Mandatory | For brown field deployments. |
8383
> | `management_subnet_nsg_name` | The name of the Network Security Group name | Optional | |
8484
> | `management_subnet_nsg_arm_id` | The Azure resource identifier for the Network Security Group | Mandatory | Mandatory For brown field deployments. |
85-
> | `management_subnet_nsg_allowed_ips` | Range of allowed IP addresses to add to Azure Firewall | Optional | |
85+
> | `management_subnet_nsg_allowed_ips` | Range of allowed IP addresses to add to Azure Firewall | Optional | |
8686
> | | | | |
8787
> | `management_firewall_subnet_arm_id` | The Azure resource identifier for the Firewall subnet | Mandatory | For brown field deployments. |
88-
> | `management_firewall_subnet_address_prefix` | The address range for the subnet | Mandatory | For green field deployments. |
88+
> | `management_firewall_subnet_address_prefix` | The address range for the subnet | Mandatory | For green field deployments. |
8989
> | | | | |
9090
> | `management_bastion_subnet_arm_id` | The Azure resource identifier for the Bastion subnet | Mandatory | For brown field deployments. |
9191
> | `management_bastion_subnet_address_prefix` | The address range for the subnet | Mandatory | For green field deployments. |
9292
> | | | | |
9393
> | `webapp_subnet_arm_id` | The Azure resource identifier for the web app subnet | Mandatory | For brown field deployments using the web app |
94-
> | `webapp_subnet_address_prefix` | The address range for the subnet | Mandatory | For green field deployments using the web app |
94+
> | `webapp_subnet_address_prefix` | The address range for the subnet | Mandatory | For green field deployments using the web app |
9595
9696
> [!NOTE]
9797
> When using an existing subnet for the web app, the subnet must be empty, in the same region as the resource group being deployed, and delegated to Microsoft.Web/serverFarms
98-
98+
9999

100100
### Deployer Virtual Machine Parameters
101101

102-
The table below contains the parameters related to the deployer virtual machine.
102+
The table below contains the parameters related to the deployer virtual machine.
103103

104104
> [!div class="mx-tdCol2BreakAll "]
105105
> | Variable | Description | Type |
106106
> | ------------------------------- | -------------------------------------------------------------------------------------- | ---------- |
107107
> | `deployer_size` | Defines the Virtual machine SKU to use, for example Standard_D4s_v3 | Optional |
108108
> | `deployer_count` | Defines the number of Deployers | Optional |
109109
> | `deployer_image` | Defines the Virtual machine image to use, see below | Optional |
110+
> | `plan` | Defines the plan associated to the Virtual machine image, see below | Optional |
110111
> | `deployer_disk_type` | Defines the disk type, for example Premium_LRS | Optional |
111112
> | `deployer_use_DHCP` | Controls if Azure subnet provided IP addresses should be used (dynamic) true | Optional |
112113
> | `deployer_private_ip_address` | Defines the Private IP address to use | Optional |
113114
> | `deployer_enable_public_ip` | Defines if the deployer has a public IP | Optional |
114115
> | `auto_configure_deployer` | Defines deployer will be configured with the required software (Terraform and Ansible) | Optional |
115116
116117

117-
The Virtual Machine image is defined using the following structure:
118-
```python
119-
{
120-
os_type=""
121-
source_image_id=""
122-
publisher="Canonical"
123-
offer="0001-com-ubuntu-server-focal"
124-
sku="20_04-lts"
125-
version="latest"
118+
The Virtual Machine image is defined using the following structure:
119+
```python
120+
{
121+
"os_type" = ""
122+
"source_image_id" = ""
123+
"publisher" = "Canonical"
124+
"offer" = "0001-com-ubuntu-server-focal"
125+
"sku" = "20_04-lts"
126+
"version" = "latest"
126127
}
127128
```
128129

130+
The plan defined using the following structure:
131+
```python
132+
{
133+
"use" = false
134+
"name" = "0001-com-ubuntu-server-focal"
135+
"publisher" = "Canonical"
136+
"product" = "20_04-lts"
137+
}
138+
```
139+
140+
> [!NOTE]
141+
> Note that using the plan attribute will require that the image in question has been used at least once in the subscription. This is because the first usage prompts the user to accept the License terms and the automation has no mean to approve it.
142+
143+
144+
129145
### Authentication Parameters
130146

131147
The table below defines the parameters used for defining the Virtual Machine authentication
132148

133149

134150
> [!div class="mx-tdCol2BreakAll "]
135-
> | Variable | Description | Type |
136-
> | ------------------------------------------------ | --------------------------------------------------- | --------- |
151+
> | Variable | Description | Type |
152+
> | ------------------------------------------------ | --------------------------------------------------- | --------- |
137153
> | `deployer_vm_authentication_type` | Defines the default authentication for the Deployer | Optional |
138154
> | `deployer_authentication_username` | Administrator account name | Optional |
139155
> | `deployer_authentication_password` | Administrator password | Optional |
@@ -145,8 +161,8 @@ The table below defines the parameters used for defining the Virtual Machine aut
145161
The table below defines the parameters used for defining the Key Vault information
146162

147163
> [!div class="mx-tdCol2BreakAll "]
148-
> | Variable | Description | Type |
149-
> | ------------------------------------------------ | --------------------------------------------------------------------------- | ---------- |
164+
> | Variable | Description | Type |
165+
> | ------------------------------------------------ | --------------------------------------------------------------------------- | ---------- |
150166
> | `user_keyvault_id` | Azure resource identifier for the user key vault | Optional |
151167
> | `spn_keyvault_id` | Azure resource identifier for the user key vault containing the SPN details | Optional |
152168
> | `deployer_private_key_secret_name` | The Azure Key Vault secret name for the deployer private key | Optional |
@@ -162,7 +178,7 @@ The table below defines the parameters used for defining the Key Vault informati
162178
> | Variable | Description | Type | Notes |
163179
> | ------------------------------------ | ---------------------------------------------------------------------- | ----------- | ----------------------------- |
164180
> | `firewall_deployment` | Boolean flag controlling if an Azure firewall is to be deployed | Optional | |
165-
> | `bastion_deployment` | Boolean flag controlling if Azure Bastion host is to be deployed | Optional | |
181+
> | `bastion_deployment` | Boolean flag controlling if Azure Bastion host is to be deployed | Optional | |
166182
> | `enable_purge_control_for_keyvaults` | Boolean flag controlling if purge control is enabled on the Key Vault. | Optional | Use only for test deployments |
167183
> | `use_private_endpoint` | Are private endpoints created for storage accounts and key vaults. | Optional | |
168184
> | `use_service_endpoint` | Are service endpoints defined for the subnets. | Optional | |
@@ -198,7 +214,7 @@ bastion_deployment=true
198214

199215
## SAP Library
200216

201-
The [SAP Library](automation-deployment-framework.md#deployment-components) provides the persistent storage of the Terraform state files and the downloaded SAP installation media for the control plane.
217+
The [SAP Library](automation-deployment-framework.md#deployment-components) provides the persistent storage of the Terraform state files and the downloaded SAP installation media for the control plane.
202218

203219
The configuration of the SAP Library is performed in a Terraform tfvars variable file.
204220

@@ -207,9 +223,9 @@ The configuration of the SAP Library is performed in a Terraform tfvars variable
207223
The table below contains the Terraform parameters, these parameters need to be entered manually when not using the deployment scripts
208224

209225
> [!div class="mx-tdCol2BreakAll "]
210-
> | Variable | Description | Type |
211-
> | ----------------------- | ------------------------------------- | ---------- |
212-
> | `deployer_tfstate_key` | The state file name for the deployer | Required |
226+
> | Variable | Description | Type |
227+
> | ----------------------- | ------------------------------------- | ---------- |
228+
> | `deployer_tfstate_key` | The state file name for the deployer | Required |
213229
214230
### Environment Parameters
215231

@@ -227,47 +243,37 @@ The table below contains the parameters that define the resource naming.
227243
The table below contains the parameters that define the resource group.
228244

229245
> [!div class="mx-tdCol2BreakAll "]
230-
> | Variable | Description | Type |
231-
> | ----------------------- | -------------------------------------------------------- | ---------- |
246+
> | Variable | Description | Type |
247+
> | ----------------------- | -------------------------------------------------------- | ---------- |
232248
> | `resource_group_name` | Name of the resource group to be created | Optional |
233-
> | `resource_group_arm_id` | Azure resource identifier for an existing resource group | Optional |
234-
> | `resourcegroup_tags` | Tags to be associated with the resource group | Optional |
235-
249+
> | `resource_group_arm_id` | Azure resource identifier for an existing resource group | Optional |
250+
> | `resourcegroup_tags` | Tags to be associated with the resource group | Optional |
236251
237-
### Deployer Parameters
238252

239-
The table below contains the parameters that define the resource group and the resource naming.
240-
241-
> [!div class="mx-tdCol2BreakAll "]
242-
> | Variable | Description | Type | Notes |
243-
> | --------------------- | ------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------- |
244-
> | `deployer_environment` | Identifier for the control plane (max 5 chars) | Mandatory | For example, `PROD` for a production environment and `NP` for a non-production environment. |
245-
> | `deployer_location` | The Azure region in which to deploy. | Mandatory | |
246-
> | `deployer_vnet` | The logical name for the deployer VNet | Mandatory | |
247253

248254

249255
### SAP Installation media storage account
250256

251257
> [!div class="mx-tdCol2BreakAll "]
252-
> | Variable | Description | Type |
253-
> | ------------------------- | --------------------------- | ---------- |
258+
> | Variable | Description | Type |
259+
> | ------------------------- | --------------------------- | ---------- |
254260
> | `library_sapmedia_arm_id` | Azure resource identifier | Optional |
255261
256262
### Terraform remote state storage account
257263

258264
> [!div class="mx-tdCol2BreakAll "]
259-
> | Variable | Description | Type |
260-
> | -------------------------------- | -------------------------- | ---------- |
265+
> | Variable | Description | Type |
266+
> | -------------------------------- | -------------------------- | ---------- |
261267
> | `library_terraform_state_arm_id` | Azure resource identifier | Optional |
262268
263269
### Extra parameters
264270

265271

266272
> [!div class="mx-tdCol2BreakAll "]
267-
> | Variable | Description | Type |
268-
> | ---------------------------------- | -------------------------------- | -------- |
269-
> | `dns_label` | DNS name of the private DNS zone | Optional |
270-
> | `use_private_endpoint` | Use private endpoints | Optional |
273+
> | Variable | Description | Type |
274+
> | ---------------------------------- | -------------------------------- | -------- |
275+
> | `dns_label` | DNS name of the private DNS zone | Optional |
276+
> | `use_private_endpoint` | Use private endpoints | Optional |
271277
272278
### Example parameters file for sap library (required parameters only)
273279

0 commit comments

Comments
 (0)