From df23698d1741f73860d0286bc29f01bbc86b2a7a Mon Sep 17 00:00:00 2001 From: Jared Holgate Date: Fri, 20 Dec 2024 17:05:14 +0000 Subject: [PATCH] docs: fix options indentation (#18) * docs: fix options indentation --- .../options/ama.md | 16 ++++++------ .../options/bastion.md | 6 ++--- .../options/ddos.md | 10 +++---- .../options/dns.md | 14 +++++----- .../options/gateways.md | 26 +++++++++++++------ 5 files changed, 41 insertions(+), 31 deletions(-) diff --git a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ama.md b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ama.md index 95e7722..16ab0cf 100644 --- a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ama.md +++ b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ama.md @@ -7,15 +7,15 @@ weight: 11 The Azure Monitoring Agent (AMA) is enabled by default. If you want to turn it off, you can follow these steps: 1. To keep the code tidy remove the follow settings from `custom_replacements.names`: - 1. `ama_user_assigned_managed_identity_name` - 1. `dcr_change_tracking_name` - 1. `dcr_defender_sql_name` - 1. `dcr_vm_insights_name` + * `ama_user_assigned_managed_identity_name` + * `dcr_change_tracking_name` + * `dcr_defender_sql_name` + * `dcr_vm_insights_name` 1. To keep the code tidy remove the follow settings from `custom_replacements.resource_identifiers`: - 1. `ama_change_tracking_data_collection_rule_id` - 1. `ama_mdfc_sql_data_collection_rule_id` - 1. `ama_vm_insights_data_collection_rule_id` - 1. `ama_user_assigned_managed_identity_id` + * `ama_change_tracking_data_collection_rule_id` + * `ama_mdfc_sql_data_collection_rule_id` + * `ama_vm_insights_data_collection_rule_id` + * `ama_user_assigned_managed_identity_id` 1. Remove the whole `user_assigned_managed_identities` section from `management_resource_settings` 1. Remove the whole `data_collection_rules` section from `management_resource_settings` 1. Add the follow section to `management_group_settings.policy_assignments_to_modify`: diff --git a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/bastion.md b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/bastion.md index e7251cd..f40c2bd 100644 --- a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/bastion.md +++ b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/bastion.md @@ -9,7 +9,7 @@ You can choose to not deploy a Bastion Host. In order to do that, they need to r The steps to follow are: 1. To keep the code tidy remove the follow settings from `custom_replacements.names`: - 1. `_bastion_host_name` where `` is for each region - 1. `_bastion_public_ip_name` where `` is for each region - 1. `_bastion_subnet_address_prefix` where `` is for each region + * `_bastion_host_name` where `` is for each region + * `_bastion_public_ip_name` where `` is for each region + * `_bastion_subnet_address_prefix` where `` is for each region 1. Remove the whole `bastion` section from each `hub_and_spoke_vnet_virtual_networks` or `virtual_wan_virtual_hubs` region diff --git a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ddos.md b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ddos.md index 75afc7e..f03d8a4 100644 --- a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ddos.md +++ b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/ddos.md @@ -13,14 +13,14 @@ DDOS Protection plan is a critical security protection for public facing service The steps to follow are: 1. To keep the code tidy remove the following settings from `custom_replacements.names`: - 1. `ddos_resource_group_name` - 1. `ddos_protection_plan_name` + * `ddos_resource_group_name` + * `ddos_protection_plan_name` 1. To keep the code tidy remove the following settings from `custom_replacements.resource_group_identifiers`: - 1. `ddos_protection_plan_resource_group_id` + * `ddos_protection_plan_resource_group_id` 1. To keep the code tidy remove the following settings from `custom_replacements.resource_identifiers`: - 1. `ddos_protection_plan_id` + * `ddos_protection_plan_id` 1. Remove the following configuration settings from `management_group_settings.policy_default_values`: - 1. `ddos_protection_plan_id` + * `ddos_protection_plan_id` 1. Add the follow section to `management_group_settings.policy_assignments_to_modify`: {{< highlight terraform "linenos=table" >}} diff --git a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/dns.md b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/dns.md index 1c2e99d..2bb8792 100644 --- a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/dns.md +++ b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/dns.md @@ -9,14 +9,14 @@ You can choose to not deploy any DNS related resources. In order to do that, the The steps to follow are: 1. To keep the code tidy remove the follow settings from `custom_replacements.names`: - 1. `dns_resource_group_name` - 1. `_private_dns_resolver_name` where `` is for each region - 1. `_auto_registration_zone_name` where `` is for each region - 1. `_private_dns_resolver_subnet_address_prefix` where `` is for each region + * `dns_resource_group_name` + * `_private_dns_resolver_name` where `` is for each region + * `_auto_registration_zone_name` where `` is for each region + * `_private_dns_resolver_subnet_address_prefix` where `` is for each region 1. Remove the follow configuration settings from `management_group_settings.policy_default_values`: - 1. `private_dns_zone_subscription_id` - 1. `private_dns_zone_region` - 1. `private_dns_zone_resource_group_name` + * `private_dns_zone_subscription_id` + * `private_dns_zone_region` + * `private_dns_zone_resource_group_name` 1. Add the follow section to `management_group_settings.policy_assignments_to_modify`: ```terraform diff --git a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/gateways.md b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/gateways.md index dedda5d..c657b9d 100644 --- a/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/gateways.md +++ b/docs/content/accelerator/startermodules/terraform-platform-landing-zone/options/gateways.md @@ -6,22 +6,32 @@ weight: 6 You can choose to not deploy any Virtual Network Gateways. In order to do that, you need to remove the Virtual Network Gateway configuration. You can either comment out or remove the configuration entirely. +## For both Virtual Network Gateways + The steps to follow are: 1. To keep the code tidy remove the following settings from `custom_replacements.names`: - 1. `_virtual_network_gateway_express_route_name` where `` is for each region - 1. `_virtual_network_gateway_express_route_public_ip_name` where `` is for each region - 1. `_virtual_network_gateway_vpn_name` where `` is for each region - 1. `_virtual_network_gateway_vpn_public_ip_name` where `` is for each region - 1. `_gateway_subnet_address_prefix` where `` is for each region + * `_virtual_network_gateway_express_route_name` where `` is for each region + * `_virtual_network_gateway_express_route_public_ip_name` where `` is for each region + * `_virtual_network_gateway_vpn_name` where `` is for each region + * `_virtual_network_gateway_vpn_public_ip_name` where `` is for each region + * `_gateway_subnet_address_prefix` where `` is for each region 1. Remove the whole `virtual_network_gateways` section from each `hub_and_spoke_vnet_virtual_networks` or `virtual_wan_virtual_hubs` region -You can also just turn off the specific Virtual Network Gateway types you don't want to deploy. +## For ExpressRoute Virtual Network Gateways only -For ExpressRoute Virtual Network Gateways: +The steps to follow are: +1. To keep the code tidy remove the following settings from `custom_replacements.names`: + * `_virtual_network_gateway_express_route_name` where `` is for each region + * `_virtual_network_gateway_express_route_public_ip_name` where `` is for each region 1. Remove the whole `express_route` section from the `virtual_network_gateways` section in each `hub_and_spoke_vnet_virtual_networks` or `virtual_wan_virtual_hubs` region -For VPN Virtual Network Gateways: +## For VPN Virtual Network Gateways only +The steps to follow are: + +1. To keep the code tidy remove the following settings from `custom_replacements.names`: + * `_virtual_network_gateway_vpn_name` where `` is for each region + * `_virtual_network_gateway_vpn_public_ip_name` where `` is for each region 1. Remove the whole `vpn` section from the `virtual_network_gateways` section in each `hub_and_spoke_vnet_virtual_networks` or `virtual_wan_virtual_hubs` region