From 2da7f4f6248904d0b17f7d746900419d941f4b19 Mon Sep 17 00:00:00 2001 From: Jared Holgate Date: Wed, 20 Mar 2024 21:00:38 +0000 Subject: [PATCH] chore: update docs for refactor (#747) * Update accelerator docs * Tidy upgrade guide --- docs/wiki/Accelerator.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/wiki/Accelerator.md b/docs/wiki/Accelerator.md index 43d3a514c..770cbb10f 100644 --- a/docs/wiki/Accelerator.md +++ b/docs/wiki/Accelerator.md @@ -68,7 +68,7 @@ In order to setup the Accelerator framework with the production GitHub Action Wo 1. Create your ALZ Bicep Accelerator framework with the following ALZ PowerShell Module cmdlet: ```powershell - New-ALZEnvironment -o -IaC "bicep" -cicd "github + Deploy-Accelerator -o -i "bicep" -b "alz_github ``` > **Note:** @@ -138,7 +138,7 @@ In order to setup the Accelerator framework with the production ready Azure DevO 1. Create your ALZ Bicep Accelerator framework with the following ALZ PowerShell Module cmdlet: ```powershell - New-ALZEnvironment -o -IaC "bicep" -cicd "azuredevops" + Deploy-Accelerator -o -i "bicep" -b "alz_azuredevops" ``` > **Note:** @@ -220,23 +220,28 @@ With the ALZ Accelerator framework, we have designed the pipelines and directory 1. Prior to upgrading, read the release notes for the version you are upgrading to. The release notes will provide you with information on any breaking changes that may impact your deployment. This is especially important if you have created any custom modules or have [modified any of the ALZ Bicep modules](#incorporating-modified-alz-modules) that may have dependencies on the modules that are being upgraded. -1. Using the ALZ PowerShell Module, there is a cmdlet called `Get-ALZBicepRelease`. This will download a specified release version from the remote ALZ-Bicep repository and pull down to the local directory where your Accelerator framework was initially deployed. +1. Using the ALZ PowerShell Module, you can update to the latest or a specified version. You must specifiy the same IaC, Bootstrap and Output directory that you used when you initially deployed the ALZ Bicep Accelerator. - Here is an example of using the cmdlet to pull down the latest version: + Here is an example of using the cmdlet to upgrade to the latest version: ```powershell - Get-ALZGithubRelease -i "bicep" -o "C:\Repos\ALZ\accelerator" + Deploy-Accelerator -i "bicep" -b "alz_github" -o "C:\Repos\ALZ\accelerator" ``` - Here is an example of using the cmdlet to pull down version v0.17.0: + Here is an example of using the to upgrade to version v0.17.2: ```powershell - Get-ALZGithubRelease -i "bicep" -v "v0.17.0" -o "C:\Repos\ALZ\accelerator" + Deploy-Accelerator -i "bicep" -b "alz_github" -v "v0.17.2" -o "C:\Repos\ALZ\accelerator" ``` + + You will be prompted for inputs again and the upgrade will be run for you. + Verify that the cmdlet has updated the environment variables file (.env): + ```bash - UPSTREAM_RELEASE_VERSION="v0.17.0" + UPSTREAM_RELEASE_VERSION="v0.17.2" ``` + 1. You can now deploy the updated modules. > **Note:** > The current pipelines trigger What-If deployment in PRs for changes in the Bicep parameter files. If you also want to include the What-If deployment process in the module upgrade process, consider the following options: