Phase 2 - Bootstrap

Info

If you prefer more control over the configuration process, see the Advanced Usage guide for manual configuration.

Follow these instructions to bootstrap your Version Control System and Azure ready to deploy your Platform landing zone.

The simplest way to get started is to use the interactive wizard which guides you through all the required inputs.

1. Run the following command to install or update the ALZ PowerShell module:

   $alzModule = Get-InstalledPSResource -Name ALZ 2>$null
   if (-not $alzModule) {
       Install-PSResource -Name ALZ
   } else {
       Update-PSResource -Name ALZ
   }
   

2. Run the accelerator with no parameters to start the interactive wizard:

   Deploy-Accelerator
   

3. The wizard will guide you through a series of prompts to collect the necessary information for your bootstrap configuration. Provide the required inputs based on your preferences for infrastructure as code, version control system, and other settings.

   Info

   The interactive mode wizard only completes the bootstrap configuration file (inputs.yaml) for you. You will still need to review and update your platform landing zone configuration file with the required region values before proceeding with the deployment. The wizard will prompt you to do this after it completes the bootstrap configuration.

4. After configuration, the wizard offers to open VS Code for final review of your configuration files. You MUST update your platform landing zone configuration file at this stage before proceeding.

   1. Open your bootstrap configuration file in VS Code. The file is located at ./config/inputs.yaml in your target directory.
   2. Review the bootstrap configuration settings and ensure they are correct.
   3. Save any changes to the configuration file.
   4. Open the relevant section below for the platform landing zone configuration file:
   Terraform Platform Landing Zone Configuration File ...

   1. Open your platform landing zone configuration file in VS Code. The file is located at ./config/platform-landing-zone.tfvars in your target directory.
   2. Update the following settings in the platform landing zone configuration file:
      • starter_locations: you must update all the <region-#> placeholders with valid Azure regions for your Platform landing zone.
      • defender_email_security_contact: (Terraform only) this must be updated to include an email address for your security contact for Microsoft Defender for Cloud alerts.
   3. Save any changes to the configuration file.
   4. Now head over to the Options documentation to review any additional settings you may want to configure for your deployment.
   Bicep Platform Landing Zone Configuration File ...

   1. Open your platform landing zone configuration file in VS Code. The file is located at ./config/platform-landing-zone.yaml in your target directory.
   2. Update the following settings in the platform landing zone configuration file:
      • starter_locations: you must update all the <region-#> placeholders with valid Azure regions for your Platform landing zone.
   3. Save any changes to the configuration file.

   Warning

   Do not continue until you have updated your platform landing zone configuration file with the required values. You must supply the regions for your platform landing zone deployment in this file before the bootstrap can proceed.

5. Type yes when prompted to continue with deployment, or no to exit and configure later.

6. Once it generates the plan, hit enter to deploy the bootstrap.

   Tip

   You can now update your Azure Landing Zone Terraform Accelerator Runner Registration GitHub PAT (token-2) to restrict it to the main repository created by the bootstrap.

7. For Bicep only, clone your newly created repository to your local machine and make any changes required to the parameter files. See the Bicep getting started guide for more information on customizing the parameter files. Commit and push any changes to your repository. For the local file system option, you can make changes directly in the output folder.

Now head to Phase 3.