Initial changes to support bicep-avm

Author: oZakari

README.md

@@ -10,9 +10,17 @@
 
 ## Introduction
 
-This repository contains the PowerShell module and documentation for the Azure landing zones Accelerators for Bicep and Terraform. The accelerators are an opinionated implementation of the Azure Landing Zones Terraform modules, with Azure DevOps or GitHub bootstrapping.
+This repository contains the PowerShell module and documentation for the Azure landing zones Accelerators for Bicep and Terraform. The accelerators are an opinionated implementation of the Azure Landing Zones modules, with Azure DevOps or GitHub bootstrapping.
 
-It is designed to be used as a template to enable you to get started quickly deploying ALZ with Bicep or Terraform.
+## Supported Infrastructure as Code (IaC) Types
+
+The accelerators support multiple Infrastructure as Code approaches:
+
+- **terraform**: Terraform-based Azure Landing Zones
+- **bicep**: Bicep-based Azure Landing Zones using the traditional [ALZ-Bicep](https://github.com/Azure/ALZ-Bicep) framework
+- **bicep-avm**: Bicep-based Azure Landing Zones using the new [alz-bicep-accelerator](https://github.com/Azure/alz-bicep-accelerator) framework built on Azure Verified Modules
+
+It is designed to be used as a template to enable you to get started quickly deploying ALZ with any of these approaches.
 
 Please refer to our [Docs](https://aka.ms/alz/acc) for detailed features and usage instructions.
 

src/ALZ/Private/Config-Helpers/Request-SpecialInput.ps1

@@ -19,7 +19,8 @@ function Request-SpecialInput {
         $typeDescription = ""
 
         if($type -eq "iac") {
-            $options += @{ key = "bicep"; name = "Bicep"; description = "Bicep" }
+            $options += @{ key = "bicep-avm"; name = "Bicep AVM"; description = "Bicep (New Framework)" }
+            $options += @{ key = "bicep"; name = "Bicep Classic"; description = "Bicep (Classic Framework)" }
             $options += @{ key = "terraform"; name = "Terraform"; description = "Terraform" }
             $typeDescription = "Infrastructure as Code (IaC) language"
         }

src/ALZ/Private/Deploy-Accelerator-Helpers/New-Bootstrap.ps1

@@ -82,8 +82,8 @@ function New-Bootstrap {
         $starterRootModuleFolderPath = ""
         $starterFoldersToRetain = @()
 
-        if($hasStarter) {
-            if($inputConfig.starter_module_name.Value -eq "") {
+        if ($hasStarter) {
+            if ($inputConfig.starter_module_name.Value -eq "") {
                 $inputConfig.starter_module_name = @{
                     Value  = Request-SpecialInput -type "starter" -starterConfig $starterConfig
                     Source = "user"
@@ -97,12 +97,12 @@ function New-Bootstrap {
             $starterRootModuleFolderPath = $starterModulePath
             Write-Verbose "Starter Module Path: $starterModulePath"
 
-            if($chosenStarterConfig.PSObject.Properties.Name -contains "additional_retained_folders") {
+            if ($chosenStarterConfig.PSObject.Properties.Name -contains "additional_retained_folders") {
                 $starterFoldersToRetain = $chosenStarterConfig.additional_retained_folders
                 Write-Verbose "Starter Additional folders to retain: $($starterFoldersToRetain -join ",")"
             }
 
-            if($chosenStarterConfig.PSObject.Properties.Name -contains "root_module_folder") {
+            if ($chosenStarterConfig.PSObject.Properties.Name -contains "root_module_folder") {
                 $starterRootModuleFolder = $chosenStarterConfig.root_module_folder
 
                 # Retain the root module folder
@@ -127,23 +127,23 @@ function New-Bootstrap {
 
         Write-Verbose "Getting the bootstrap configuration..."
         $terraformFiles = Get-ChildItem -Path $bootstrapModulePath -Filter "*.tf" -File
-        foreach($terraformFile in $terraformFiles) {
+        foreach ($terraformFile in $terraformFiles) {
             $bootstrapParameters = Convert-HCLVariablesToInputConfig -targetVariableFile $terraformFile.FullName -hclParserToolPath $hclParserToolPath -validators $validationConfig -appendToObject $bootstrapParameters
         }
 
         # Getting the configuration for the starter module user input
-        $starterParameters  = [PSCustomObject]@{}
+        $starterParameters = [PSCustomObject]@{}
 
-        if($hasStarter) {
+        if ($hasStarter) {
             Write-Verbose "Getting the starter configuration..."
-            if($iac -eq "terraform") {
+            if ($iac -eq "terraform") {
                 $terraformFiles = Get-ChildItem -Path $starterRootModuleFolderPath -Filter "*.tf" -File
-                foreach($terraformFile in $terraformFiles) {
+                foreach ($terraformFile in $terraformFiles) {
                     $starterParameters = Convert-HCLVariablesToInputConfig -targetVariableFile $terraformFile.FullName -hclParserToolPath $hclParserToolPath -validators $validationConfig -appendToObject $starterParameters
                 }
             }
 
-            if($iac -eq "bicep") {
+            if ($iac -in @("bicep", "bicep-avm")) {
                 $starterParameters = Convert-BicepConfigToInputConfig -bicepConfig $starterConfig.starter_modules.Value.$($inputConfig.starter_module_name.Value) -validators $validationConfig
             }
         }
@@ -158,17 +158,17 @@ function New-Bootstrap {
             Source = "calculated"
         }
 
-        if($inputConfig.PSObject.Properties.Name -contains "starter_location" -and $inputConfig.PSObject.Properties.Name -notcontains "starter_locations") {
+        if ($inputConfig.PSObject.Properties.Name -contains "starter_location" -and $inputConfig.PSObject.Properties.Name -notcontains "starter_locations") {
             Write-Verbose "Converting starter_location $($inputConfig.starter_location.Value) to starter_locations..."
             $inputConfig | Add-Member -NotePropertyName "starter_locations" -NotePropertyValue @{
                 Value  = @($inputConfig.starter_location.Value)
                 Source = "calculated"
             }
         }
 
-        if($inputConfig.PSObject.Properties.Name -contains "starter_locations") {
+        if ($inputConfig.PSObject.Properties.Name -contains "starter_locations") {
             $availabilityZonesStarter = @()
-            foreach($region in $inputConfig.starter_locations.Value) {
+            foreach ($region in $inputConfig.starter_locations.Value) {
                 $availabilityZonesStarter += , @(Get-AvailabilityZonesSupport -region $region -zonesSupport $zonesSupport)
             }
             $inputConfig | Add-Member -NotePropertyName "availability_zones_starter" -NotePropertyValue @{
@@ -203,12 +203,12 @@ function New-Bootstrap {
         # Write the tfvars file for the bootstrap and starter module
         Write-TfvarsJsonFile -tfvarsFilePath $bootstrapTfvarsPath -configuration $bootstrapConfiguration
 
-        if($iac -eq "terraform") {
-            if($starterFoldersToRetain.Length -gt 0) {
+        if ($iac -eq "terraform") {
+            if ($starterFoldersToRetain.Length -gt 0) {
                 Write-Verbose "Removing unwanted folders from the starter module..."
                 $folders = Get-ChildItem -Path $starterModulePath -Directory
-                foreach($folder in $folders) {
-                    if($starterFoldersToRetain -notcontains $folder.Name) {
+                foreach ($folder in $folders) {
+                    if ($starterFoldersToRetain -notcontains $folder.Name) {
                         Write-Verbose "Removing folder: $($folder.FullName)"
                         Remove-Item -Path $folder.FullName -Recurse -Force
                     } else {
@@ -218,12 +218,12 @@ function New-Bootstrap {
                 }
             }
             Remove-TerraformMetaFileSet -path $starterModulePath -writeVerboseLogs:$writeVerboseLogs.IsPresent
-            if($convertTfvarsToJson) {
+            if ($convertTfvarsToJson) {
                 Write-TfvarsJsonFile -tfvarsFilePath $starterTfvarsPath -configuration $starterConfiguration
             } else {
                 $inputsFromTfvars = $inputConfig.PSObject.Properties | Where-Object { $_.Value.Source -eq ".tfvars" } | Select-Object -ExpandProperty Name
                 Write-TfvarsJsonFile -tfvarsFilePath $starterTfvarsPath -configuration $starterConfiguration -skipItems $inputsFromTfvars
-                foreach($inputConfigFilePath in $inputConfigFilePaths | Where-Object { $_ -like "*.tfvars" }) {
+                foreach ($inputConfigFilePath in $inputConfigFilePaths | Where-Object { $_ -like "*.tfvars" }) {
                     $fileName = [System.IO.Path]::GetFileName($inputConfigFilePath)
                     $fileName = $fileName.Replace(".tfvars", ".auto.tfvars")
                     $destination = Join-Path -Path $starterRootModuleFolderPath -ChildPath $fileName
@@ -233,8 +233,8 @@ function New-Bootstrap {
             }
 
             # Copy additional files
-            foreach($additionalFile in $starterAdditionalFiles) {
-                if(Test-Path $additionalFile -PathType Container) {
+            foreach ($additionalFile in $starterAdditionalFiles) {
+                if (Test-Path $additionalFile -PathType Container) {
                     $folderName = ([System.IO.DirectoryInfo]::new($additionalFile)).Name
                     $destination = Join-Path -Path $starterRootModuleFolderPath -ChildPath $folderName
                     Write-Verbose "Copying folder $additionalFile to $destination"
@@ -248,31 +248,47 @@ function New-Bootstrap {
             }
         }
 
-        if($iac -eq "bicep") {
-            Copy-ParametersFileCollection -starterPath $starterModulePath -configFiles $starterConfig.starter_modules.Value.$($inputConfig.starter_module_name.Value).deployment_files
+        if ($iac -in @("bicep", "bicep-avm")) {
+            $starterModuleDefinition = $starterConfig.starter_modules.Value.$($inputConfig.starter_module_name.Value)
+            Copy-ParametersFileCollection -starterPath $starterModulePath -configFiles $starterModuleDefinition.deployment_files
             Set-ComputedConfiguration -configuration $starterConfiguration
             Edit-ALZConfigurationFilesInPlace -alzEnvironmentDestination $starterModulePath -configuration $starterConfiguration
-            Write-JsonFile -jsonFilePath $starterBicepVarsPath -configuration $starterConfiguration
+            if ($iac -eq "bicep-avm") {
+                $bicepAvmEnvConfiguration = Get-BicepAvmEnvironmentConfiguration -inputConfig $inputConfig
+                $combinedConfiguration = [PSCustomObject]@{}
+
+                foreach ($property in $starterConfiguration.PSObject.Properties) {
+                    $combinedConfiguration | Add-Member -NotePropertyName $property.Name -NotePropertyValue $property.Value
+                }
+
+                foreach ($property in $bicepAvmEnvConfiguration.PSObject.Properties) {
+                    $combinedConfiguration | Add-Member -NotePropertyName $property.Name -NotePropertyValue $property.Value -Force
+                }
+
+                Write-JsonFile -jsonFilePath $starterBicepVarsPath -configuration $combinedConfiguration
+            } else {
+                Write-JsonFile -jsonFilePath $starterBicepVarsPath -configuration $starterConfiguration
+            }
 
             # Remove unrequired files
-            $foldersOrFilesToRetain = $starterConfig.starter_modules.Value.$($inputConfig.starter_module_name.Value).folders_or_files_to_retain
+            $foldersOrFilesToRetain = $starterModuleDefinition.folders_or_files_to_retain
             $foldersOrFilesToRetain += "parameters.json"
             $foldersOrFilesToRetain += "config"
             $foldersOrFilesToRetain += "starter-cache.json"
 
-            foreach($deployment_file in $starterConfig.starter_modules.Value.$($inputConfig.starter_module_name.Value).deployment_files) {
+            foreach ($deployment_file in $starterModuleDefinition.deployment_files) {
                 $foldersOrFilesToRetain += $deployment_file.templateParametersSourceFilePath
             }
 
-            $subFoldersOrFilesToRemove = $starterConfig.starter_modules.Value.$($inputConfig.starter_module_name.Value).subfolders_or_files_to_remove
+            $subFoldersOrFilesToRemove = $starterModuleDefinition.subfolders_or_files_to_remove
 
             Remove-UnrequiredFileSet -path $starterModulePath -foldersOrFilesToRetain $foldersOrFilesToRetain -subFoldersOrFilesToRemove $subFoldersOrFilesToRemove -writeVerboseLogs:$writeVerboseLogs.IsPresent
         }
 
         # Running terraform init and apply
         Write-InformationColored "Thank you for providing those inputs, we are now initializing and applying Terraform to bootstrap your environment..." -ForegroundColor Green -NewLineBefore -InformationAction Continue
 
-        if($autoApprove) {
+        if ($autoApprove) {
             Invoke-Terraform -moduleFolderPath $bootstrapModulePath -autoApprove -destroy:$destroy.IsPresent
         } else {
             Write-InformationColored "Once the plan is complete you will be prompted to confirm the apply." -ForegroundColor Green -NewLineBefore -InformationAction Continue
@@ -281,4 +297,4 @@ function New-Bootstrap {
 
         Write-InformationColored "Bootstrap has completed successfully! Thanks for using our tool. Head over to Phase 3 in the documentation to continue..." -ForegroundColor Green -NewLineBefore -InformationAction Continue
     }
-}
+}

src/ALZ/Public/Deploy-Accelerator.ps1

@@ -22,7 +22,7 @@ function Deploy-Accelerator {
 
         [Parameter(
             Mandatory = $false,
-            HelpMessage = "[REQUIRED] The infrastructure as code type to target. Supported options are 'bicep', 'terrform' or 'local'. Environment variable: ALZ_iac_type. Config file input: iac_type.")]
+            HelpMessage = "[REQUIRED] The infrastructure as code type to target. Supported options are 'bicep', 'bicep-avm', 'terraform' or 'local'. Environment variable: ALZ_iac_type. Config file input: iac_type.")]
         [Alias("i")]
         [Alias("iac")]
         [string] $iac_type = "",
@@ -188,7 +188,7 @@ function Deploy-Accelerator {
 
     $ProgressPreference = "SilentlyContinue"
 
-    if($skip_requirements_check.IsPresent) {
+    if ($skip_requirements_check.IsPresent) {
         Write-InformationColored "WARNING: Skipping the software requirements check..." -ForegroundColor Yellow -InformationAction Continue
     } else {
         Write-InformationColored "Checking the software requirements for the Accelerator..." -ForegroundColor Green -InformationAction Continue
@@ -201,7 +201,7 @@ function Deploy-Accelerator {
 
         # Check and install tools needed
         $toolsPath = Join-Path -Path $output_folder_path -ChildPath ".tools"
-        if($skipInternetChecks) {
+        if ($skipInternetChecks) {
             Write-InformationColored "Skipping Terraform tool check as you used the skipInternetCheck parameter. Please ensure you have the most recent version of Terraform installed" -ForegroundColor Yellow -InformationAction Continue
         } else {
             Write-InformationColored "Checking you have the latest version of Terraform installed..." -ForegroundColor Green -NewLineBefore -InformationAction Continue
@@ -213,7 +213,7 @@ function Deploy-Accelerator {
         $inputConfig = $null
         if ($inputConfigFilePaths.Length -eq 0) {
             $envInputConfigPaths = $env:ALZ_input_config_path
-            if($null -ne $envInputConfigPaths -and $envInputConfigPaths -ne "") {
+            if ($null -ne $envInputConfigPaths -and $envInputConfigPaths -ne "") {
                 $inputConfigFilePaths = $envInputConfigPaths -split ","
             } else {
                 Write-InformationColored "No input configuration file path has been provided. Please provide the path(s) to your configuration file(s)..." -ForegroundColor Yellow -InformationAction Continue
@@ -222,7 +222,7 @@ function Deploy-Accelerator {
         }
 
         # Get the input config from yaml and json files
-        foreach($inputConfigFilePath in $inputConfigFilePaths) {
+        foreach ($inputConfigFilePath in $inputConfigFilePaths) {
             $inputConfig = Get-ALZConfig -configFilePath $inputConfigFilePath -inputConfig $inputConfig -hclParserToolPath $hclParserToolPath
         }
 
@@ -231,13 +231,13 @@ function Deploy-Accelerator {
         $parametersWithValues = @{}
         foreach ($parameterKey in $parameters.Keys) {
             $parameter = $parameters[$parameterKey]
-            if($parameter.IsDynamic) {
+            if ($parameter.IsDynamic) {
                 continue
             }
 
             $parameterValue = Get-Variable -Name $parameterKey -ValueOnly -ErrorAction SilentlyContinue
 
-            if($null -ne $parameterValue) {
+            if ($null -ne $parameterValue) {
                 $parametersWithValues[$parameterKey] = @{
                     type    = $parameters[$parameterKey].ParameterType.Name
                     value   = $parameterValue
@@ -255,7 +255,7 @@ function Deploy-Accelerator {
             }
         }
 
-        if ($inputConfig.iac_type.Value -eq "bicep") {
+        if ($inputConfig.iac_type.Value -eq "bicep" -or $inputConfig.iac_type.Value -eq "bicep-classic") {
             Write-InformationColored "Although you have selected Bicep, the Accelerator leverages the Terraform tool to bootstrap your Version Control System and Azure. This is will not impact your choice of Bicep post this initial bootstrap. Please refer to our documentation for further details..." -ForegroundColor Yellow -InformationAction Continue
         }