Local File System with Terraform

Follow these instructions to bootstrap a local file system folder ready to deploy your platform landing zone with Terraform.

1. Create a new folder on you local drive called accelerator.

2. Inside the accelerator create two folders called config and output. You’ll store you input file inside config and the output folder will be the place that the accelerator stores files while it works.

3. Inside the config folder create a new files called inputs.yaml and platform-landing-zone.tfvars.

   New-Item -ItemType "file" "~/accelerator/config/inputs.yaml" -Force
   New-Item -ItemType "directory" "~/accelerator/output"
   New-Item -ItemType "file" "~/accelerator/config/platform-landing-zone.tfvars" -Force
   

4. Your folder structure should look like this:

   📂accelerator
   ┣ 📂config
   ┃ ┃ 📜inputs.yaml
   ┃ ┗ 📜platform-landing-zone.tfvars
   ┗ 📂output
   

5. If you are using the Terraform Azure Verified Modules for Platform Landing Zone (ALZ) starter module, you must create a lib folder inside the config folder to store any customizations to the management groups and policies.

   $tempFolderName = "~/accelerator/temp"
   New-Item -ItemType "directory" $tempFolderName
   $tempFolder = Resolve-Path -Path $tempFolderName
   git clone -n --depth=1 --filter=tree:0 "https://github.com/Azure/alz-terraform-accelerator" "$tempFolder"
   cd $tempFolder
   
   $libFolderPath = "templates/platform_landing_zone/lib"
   git sparse-checkout set --no-cone $libFolderPath
   git checkout
   
   cd ~
   Copy-Item -Path "$tempFolder/$libFolderPath" -Destination "~/accelerator/config" -Recurse -Force
   Remove-Item -Path $tempFolder -Recurse -Force
   

6. Open your inputs.yaml file in Visual Studio Code (or your preferred editor) and copy the content from the relevant input file for your chosen starter module:

   1. Azure Verified Modules for Platform Landing Zone (ALZ) - inputs-local.yaml

7. Check through the file and update each input as required. It is mandatory to update items with placeholders surrounded by angle brackets <>:

   The following inputs can also be supplied via environment variables. This may be useful for sensitive values you don’t wish to persist to a file. The Env Var Prefix denotes the prefix the environment variable should have. The environment variable is formatting is <PREFIX>_<variable_name>, e.g. $env:ALZ_iac_type = "terraform" or $env:TF_VAR_github_personal_access_token = "*****...".

   If you followed our phase 0 planning and decisions guidance, you should have these values already.

   Input	Env Var Prefix	Placeholder	Description
   iac_type	ALZ	terraform	This is the choice of bicep or terraform. Keep this as terraform for this example.
   bootstrap_module_name	ALZ	alz_local	This is the choice of Version Control System. Keep this as alz_local for this example.
   starter_module_name	ALZ	platform_landing_zone	This is the choice of Starter Modules, which is the baseline configuration you want for your Azure landing zone. Choose platform_landing_zone for this example.
   bootstrap_location	TF_VAR	<region>	Replace <region> with the Azure region where you would like to deploy the bootstrap resources in Azure. This field expects the name of the region, such as uksouth. You can find a full list of names by running az account list-locations -o table.
   starter_locations	TF_VAR	[<region-1>,<region-2>]	Replace <region-1> and <region-2> with the Azure regions where you would like to deploy the starter module resources in Azure. This field expects the name of the regions in and array, such as ["uksouth", "ukwest"]. You can find a full list of names by running az account list-locations -o table.
   root_parent_management_group_id	TF_VAR	""	This is the id of the management group that will be the parent of the management group structure created by the accelerator. If you are using the Tenant Root Group management group, you leave this as an empty string "" or supply the tenant id.
   subscription_ids	TF_VAR	<management-subscription-id>, <identity-subscription-id>, <connectivity-subscription-id>, <security-subscription-id>	Replace <xxxxxxxxxxx-subscription-id> with the ids of the platform subscriptions you created in the previous phase.
   target_directory	TF_VAR	""	This is the directory where the ALZ module code will be created. This defaults a directory called local-output in the root of the accelerator output directory if not supplied.
   create_bootstrap_resources_in_azure	TF_VAR	true	This determines whether the bootstrap will create the bootstrap resources in Azure. This defaults to true.
   bootstrap_subscription_id	TF_VAR	""	Enter the id of the subscription in which you would like to deploy the bootstrap resources in Azure. If left blank, the subscription you are connected to via az login will be used. In most cases this is the management subscription, but you can specifiy a separate subscription if you prefer.
   service_name	TF_VAR	alz	This is used to build up the names of your Azure and Azure DevOps resources, for example rg-<service_name>-mgmt-uksouth-001. We recommend using alz for this.
   environment_name	TF_VAR	mgmt	This is used to build up the names of your Azure and Azure DevOps resources, for example rg-alz-<environment_name>-uksouth-001. We recommend using mgmt for this.
   postfix_number	TF_VAR	1	This is used to build up the names of your Azure and Azure DevOps resources, for example rg-alz-mgmt-uksouth-<postfix_number>. We recommend using 1 for this.
   grant_permissions_to_current_user	TF_VAR	true	This determines whether the bootstrap will grant the current user permissions to the management group structure and stroage account created by the accelerator. This defaults to true so that the starter module can be immediately deployed from the local file system. Set this to false if you itend to wire up CI/CD with your own provider.

8. Open your platform-landing-zone.tfvars file in Visual Studio Code (or your preferred editor)

9. Now head over to your chosen starter module documentation to get the specific inputs for that module.

   • Terraform Azure Verified Modules for Platform Landing Zone (ALZ): Management groups, policies, Multi Region hub networking with fully custom configuration.

10. Verify that you are logged in to Azure CLI or have the Service Principal credentials set as env vars. You should have completed this in the Prerequisites phase.

11. Ensure you are running the latest version of the ALZ PowerShell module by running:

    Update-Module -Name ALZ
    

12. In your PowerShell Core (pwsh) terminal run the module:

    Inputs can be split into multiple files if desired.

    • Run Deploy-Accelerator for the Azure Verified Modules for Platform Landing Zone (ALZ) starter module:

      Deploy-Accelerator `
      -inputs "~/accelerator/config/inputs.yaml", "~/accelerator/config/platform-landing-zone.tfvars" `
      -starterAdditionalFiles "~/accelerator/config/lib" `
      -output "~/accelerator/output"
      

13. You will see a Terraform init and apply happen.

14. There will be a pause after the plan phase you allow you to validate what is going to be deployed.

15. If you are happy with the plan, then hit enter.

16. The Terraform will apply and your environment will be bootstrapped.

17. You will find the output in the ~/accelerator/output/local-output folder if you didn’t specify a different location for target_directory.

Now head to Phase 3