Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 4.39 KB

update-instructions.md

File metadata and controls

45 lines (34 loc) · 4.39 KB
Raw

Updating the Landing Zone Accelerator version

To upgrade your LZA to the latest version you should follow the update instructions from the LZA implementation guide. The current page contains additional instructions specific to this reference configuration. You should always update the Landing Zone Accelerator version first and then update the configuration in a separate pipeline run, unless there is a mandatory change documented in the release notes.

Landing Zone Accelerator and reference configurations have their own release cycle and versioning scheme.

  • Versions of the configuration files (this repository) aligns with the Landing Zone Accelerator semantic version scheme
  • An alphabetic suffix is added to the configuration version when more than one release aligns with the same LZA version (i.e. 1.6.1-a, 1.6.1-b)
  • Git Tags are used to track the versions of the configuration files
  • Only the main branch is maintained and customers should always install the latest version of LZA and configurations
  • For example 1.6.0-a is the first release of the configuration after the LZA v1.6.0 release. It has been tested with LZA v1.6.0 and must be applied on a LZA environment with v1.6.0 as a minimum
  • Unless specified in the CHANGELOG this configuration is forward compatible with future LZA versions. You can update the LZA version even if a matching configuration has not been released.
  • Our goal is to align this configuration release schedule with LZA releases, but it is expected that not all LZA versions have a matching configuration release.

Update Preparation

Before proceeding with the update you should carefully review the release notes for every version and identify any configuration changes that are mandatory or recommended.

Tip To facilitate the identification of configuration changes between two releases of the configuration files, you can use the built-in comparison of GitHub. e.g. This link will show differences between the v1.6.0-a and v1.6.1-a tags: https://github.com/aws-samples/landing-zone-accelerator-on-aws-for-cccs-medium/compare/release/v1.6.0-a...release/v1.6.1-a

Information The global-config.yaml file contains an attribute configVersion to help you identify your current config version. This attribute is for information only and isn't used by the accelerator.

Example:

configVersion: 1.7.0-a

General update steps

LZA update

  1. Login to your Organization Management (root) AWS account with administrative privileges
  2. Either: a) Ensure a valid Github token is stored in secrets manager (per the installation guide), or b) Ensure the latest release is in a valid branch of CodeCommit in the Organization Management account
  3. Before updating: Run the pipeline with the current version and confirm a successful execution
  4. Sign in to the AWS CloudFormation console, select your existing Landing Zone Accelerator on AWS CloudFormation stack and Update the stack with the latest template available from the release page. (refer to the LZA implementation guide for detailed steps)
  5. When reviewing the Stack Parameters, make sure to update the RepositoryBranchName value to point to the branch of the latest release (i.e. release/v.X.Y.Z)
  6. Wait for successful execution of the Landing Zone Accelerator stack update and the AWSAccelerator-Installer and AWSAccelerator-Pipeline pipelines

Reference configuration update

  1. Review and implement any relevant tasks noted in the Update Preparation section above
  2. Update the configuration files in the aws-accelerator-config CodeCommit repository or configuration S3 bucket as outlined in the Update Preparation section above
  3. Manually release the AWSAccelerator-Pipeline pipeline.