View a markdown version of this page

Update the solution - Innovation Sandbox on AWS
OverviewUpdate via CloudFormation templatesUpdate via source code (Git)

Update the solution

Important

Always review the solution release notes before updating to understand any changes, new features, or configuration requirements that may affect your deployment.

Overview

The Innovation Sandbox on AWS solution can be updated to newer versions via two methods:

  • Via CloudFormation templates, update your existing stacks through the AWS CloudFormation console

  • Via source code (Git), pull the latest changes from the Git repository and redeploy

Note

During the update process, you should enable maintenance mode through AWS AppConfig to prevent users and managers from making api requests while the update is in progress.

Update via CloudFormation templates

If you originally deployed the solution using CloudFormation templates, follow these steps to update to a newer version:

  1. Download the latest CloudFormation templates:

  2. Navigate to the AWS CloudFormation console

  3. The stacks should be updated in the following order: AccountPool, IDC, Data, then Compute

  4. Choose Update stack from the stack actions

  5. Select Replace current template and specify the new template URL or upload the downloaded template

  6. On the Specify stack detail page, under Parameters review the parameters and modify them as necessary

  7. On the Configure stack options page, under Stack failure options section, ensure Rollback all stack resources is selected to automatically revert changes if the update fails

  8. Complete the stack update process

  9. Repeat for each stack that needs to be updated

Note

If you enabled maintenance mode during the update process, remember to disable it once all updates are complete to restore normal user access.

Update via source code (Git)

If you originally deployed the solution from the Git repository source code, follow these steps to update to a newer version:

Note

Before updating from source code, ensure your development environment is properly configured by referring to the README for setup instructions.

  1. Navigate to your local copy of the Innovation Sandbox on AWS repository

  2. Pull the latest changes from the remote repository:

    git pull origin main

  3. Review the updated code and configuration files for any changes that may affect your deployment

  4. If you made custom modifications, resolve any merge conflicts that may arise

  5. Redeploy the solution using npm commands:

    • To deploy all stacks:

      npm run deploy:all

    • Alternatively, stacks can be deployed individually in the following order:

      npm run deploy:account-pool
npm run deploy:idc
npm run deploy:data
npm run deploy:compute

  6. Verify that the product’s user workflow works as expected after the update