You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Pull Request
## Description
Update the docs to reference the single region config files for the VBD.
## License
By submitting this pull request, I confirm that my contribution is made
under the terms of the projects associated license.
The following table describes the inputs required for the `complete` starter module.
11
5
12
6
| Input | Placeholder | Description |
@@ -17,6 +11,12 @@ The following table describes the inputs required for the `complete` starter mod
17
11
|`networkType`|`hubNetworking`| The type of network configuration to deploy. Currently only `hubNetworking`, `hubNetworkingMultiRegion`, `vwanConnectivity,``vwanConnectivityMultiRegion` or `none` are supported. |
18
12
|`SecurityContact`|`<email-address>`| The email address of the security contact for the landing zone. |
Copy file name to clipboardExpand all lines: docs/wiki/[User-Guide]-Starter-Module-Terraform-Complete-Multi-Region.md
+20-19
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,9 @@
1
1
<!-- markdownlint-disable first-line-h1 -->
2
-
The `complete_multi_region` starter module provides full customization of the Azure Landing Zone using the `config.yaml`file. The `config.yaml` file provides the ability to enable and disable modules, configure module inputs and outputs, and configure module resources. It is multi-regional by default and can support 2 or more regions.
2
+
The `complete_multi_region` starter module provides full customization of the Azure Landing Zone using a YAML or JSON configuration file. The configuration file provides the ability to enable and disable modules, configure module inputs and outputs, and configure module resources. It is multi-regional by default and can support 1 or more regions.
3
3
4
-
A custom config file can be passed to the `configuration_file_path` argument of the ALZ PowerShell Module. This allows you to firstly design your Azure Landing Zone, and then deploy it. The config file can be in `yaml` or `json` format, our examples are all `yaml`.
4
+
A custom config file can be passed to the `configuration_file_path` argument of the ALZ PowerShell Module. This allows you to firstly design your Azure Landing Zone, and then deploy it. The config file can be in YAML or JSON format, our examples are all YAML.
5
5
6
-
If not specified, the default `config-hub-and-spoke-vnet.yaml` file will be used, which can be seen [here](https://github.com/Azure/alz-terraform-accelerator/blob/main/templates/complete_multi_region/config-hub-and-spoke-vnet.yaml).
If not specified, the default `config-hub-and-spoke-vnet-multi-region.yaml` file will be used, which can be seen [here][example_starter_module_complete_config_hub_spoke_multi_region].
13
7
14
8
The following table describes the inputs required for the `complete_multi_region` starter module.
15
9
@@ -18,18 +12,24 @@ The following table describes the inputs required for the `complete_multi_region
18
12
|`configuration_file_path`|`<configuration-file-path>`| This is the absolute path to the configuration file. E.g. `c:\my-config\config.yaml` or `~/my-config/config.yaml`. For YAML on Windows you will need to escape the `\`, i.e. `c:\\my-config\\config.yaml`. |
19
13
|`default_postfix`|`<postfix>`| This is the default postfix used for resource names. |
20
14
21
-
You can create a custom yaml config to tailor to your needs, for example an Azure Landing Zone with a three-region mesh. Get started with our two region samples:
15
+
Example input files can be found here:
22
16
23
-
- Example config file for hub and spoke virtual network: [config-hub-and-spoke-vnet.yaml][example_starter_module_complete_config_hub_spoke_multi_region]
24
-
- Example config file for virtual WAN: [config-virtual-wan.yaml][example_starter_module_complete_config_vwan_multi_region]
## Further details on the Complete Starter Module and config file
21
+
You can create a custom yaml config to tailor to your needs, for example an Azure Landing Zone with a three-region mesh. Get started with our samples:
27
22
28
-
The example config files have helpful templated variables such as `starter_location_##` and `root_parent_management_group_id` which get prompted for during the ALZ PowerShell Module run. Alternatively, you can opt to not use the templated variables and hard-code the values in your config file.
23
+
- Multi region hub and spoke virtual network: [config-hub-and-spoke-vnet.yaml][example_starter_module_complete_config_hub_spoke_multi_region]
24
+
- Multi region virtual WAN: [config-virtual-wan.yaml][example_starter_module_complete_config_vwan_multi_region]
25
+
- Single region hub and spoke virtual network: [config-hub-and-spoke-vnet-single-region.yaml][example_starter_module_complete_config_hub_spoke_single_region]
26
+
- Single region virtual WAN: [config-virtual-wan-single-region.yaml][example_starter_module_complete_config_vwan_single_region]
27
+
28
+
## Further details on the Complete Multi Region Starter Module and config file
29
29
30
-
> **Note:** We recommend that you use the `caf-enterprise-scale` module for management groups and policies, and the `hubnetworking` module for connectivity resources. However, connectivity resources can be deployed using the `caf-enterprise-scale` module if you desire.
30
+
The example config files have helpful templated variables such as `starter_location_##` and `root_parent_management_group_id` which get prompted for during the ALZ PowerShell Module run. Alternatively, you can opt to not use the templated variables and hard-code the values in your config file.
31
31
32
-
The schema for the `config.yaml` is documented here - [Configuration YAML Schema][wiki_yaml_schema_reference].
32
+
> **Note:** We use the `caf-enterprise-scale` module for management groups and policies, and the Azure Verified Modules for connectivity resources.
33
33
34
34
### High Level Design
35
35
@@ -64,9 +64,10 @@ The `avm-ptn-network-private-link-private-dns-zones` module is used to deploy Pr
0 commit comments