Deploy the solution

The solution is mainly deployed as an AWS CDK application. Customers can also use a CloudFormation template to deploy the solution based on some sample configurations.

Before you deploy, review the cost, architecture, and other considerations discussed earlier in this guide.

Terminology

Prerequisites for CDK Deployment

Manual Bootstrap (Single Deployment Source/Target Account)

export CDK_NEW_BOOTSTRAP=1
cdk bootstrap aws://<AWS Account Number>/<Target Region>...

For example:

export CDK_NEW_BOOTSTRAP=1
cdk bootstrap aws://123456789012/ca-central-1 aws://123456789012/us-east-1

Manual Bootstrap (Single Deployment Source Account and One or More Target Accounts)

This procedure should be executed for each target account. This procedure bootstraps the target account while establishing trust with the source account (where deployments will be triggered)

Obtain AWS credentials for the target account and place them into your credentials file or populate appropriate environment variables.

These credentials should have sufficient permissions to create the following resources in the target account: * IAM Roles * SSM Parameters * S3 Buckets

Run the CDK bootstrap command. Multiple regions can be specified simultaneously:

export CDK_NEW_BOOTSTRAP=1
cdk bootstrap --cloudformation-execution-policies <CDK Deployment IAM Policy Arns> --trust <Source Account Number> aws://<Target AWS Account Number>/<Target Region>...

Note that the permissions specified with cloudformation-execution-policies are granted to CloudFormation during deployment into the account. These permissions should be sufficient to deploy MDAA resources, but not overly permissive.

Deployment

Deployment Overview

The following are procedures which can be executed in order to manually deploy MDAA to target accounts. These procedures assume that the appropriate preparations have been made within the organizations accounts.

Deployment Patterns

MDAA may be deployed using a number of patterns:

Deployment Preparation

Node Installation

Install a version of Node.js using a method appropriate to your system. MDAA requires nodejs 22.x and npm/npx version 10.x or greater.

Environment Setup

Ensure your credentials are populated either in your environment or in your ~/.aws/credentials file. Also, ensure your AWS region is specified either in your environment or in your ~/.aws/config file:

[default]
region=ca-central-1

Deployment from Locally Cloned Source Code

As of MDAA 0.40, deployment from locally cloned MDAA source code is the preferred deployment mode, as it avoids requiring MDAA NPM packages to be published. As of 0.43, specification of the '-l' flag is no longer required to force local execution mode. Modules which are available in locally cloned MDAA source code will be used. Otherwise, the required packages will be installed via NPM.

Additional MDAA CLI commands:

Use the -h parameter to print a list of all MDAA CLI parameters

<path_to_cloned_repo>/bin/mdaa -h

Use the -c parameter to specify a config config file. Otherwise MDAA CLI will attempt to use mdaa.yaml from the local directory.

<path_to_cloned_repo>/bin/mdaa -c <optional-path-to-mdaa-config-file> <cdk action>

Specify a < cdk action >, which MDAA CLI will run against every configured module/CDK app:

<path_to_cloned_repo>/bin/mdaa <cdk action>

To list (Terraform validate) all stacks:

<path_to_cloned_repo>/bin/mdaa list

To synth (Terraform validate) all stacks:

<path_to_cloned_repo>/bin/mdaa synth

To diff (Terraform plan) all stacks:

<path_to_cloned_repo>/bin/mdaa diff

To deploy (Terraform deploy) all stacks:

<path_to_cloned_repo>/bin/mdaa deploy

To deploy only env=dev modules/stacks:

<path_to_cloned_repo>/bin/mdaa deploy -e dev

To deploy only domain1 and domain2 modules/stacks:

<path_to_cloned_repo>/bin/mdaa deploy -d domain1,domain2

To deploy only the test_roles_module and test_datalake_module modules/stacks:

<path_to_cloned_repo>/bin/mdaa deploy -m test_roles_module,test_datalake_module

Any CLI params not recognized by MDAA CLI will be pushed down to the CDK/Terraform CLI. In this example, --no-rollback will be pushed down to CDK:

<path_to_cloned_repo>/bin/mdaa deploy --no-rollback

Deployment from Published NPM Packages

MDAA can be installed from a private NPM package repo, and will also attempt to install MDAA modules from a private NPM repo. This is necessary if specific MDAA versions are specified in mdaa.yaml.

Ensure that your private NPM repo is accessible and contains the appropriate MDAA NPM artifacts. If using a localhost based NPM repo (such as Verdaccio), ensure it is running on localhost and updated with the latest MDAA packages from S3 (See PREDEPLOYMENT). When executed from its NPM package, MDAA will also attempt to NPM install each MDAA module from NPM repo.

Install MDAA from your private NPM repository using:

Global Installation:

npm install -g @aws-mdaa/cli

Then, MDAA can be executed globally:

mdaa -h

Optionally, both the MDAA CLI can be instead npm installed in a local directory:

npm install @aws-mdaa/cli

MDAA commands can then be run within the local directory using NPX.

npx mdaa -h

Deployment of MDAA Modules/CDK Apps using CDK CLI

MDAA Modules are developed as independant CDK apps which can be directly executed using the CDK CLI. This is generally useful for development and troubleshooting directly against the MDAA codebase, but is not recommended for normal use.

To execute MDAA Modules/CDK apps using the CDK CLI:

cdk synth -c org=<organization> -c env=<dev|test|prod> -c domain=<domain name> -c module_configs=<app_config_paths> -c tag_configs=<tag_config_paths> -c module_name=<module_name>

cdk synth -c org="sample-org" -c env="dev" -c domain="mdaa1" -c module_configs="warehouse.yaml" -c tag_configs="tags.yaml"  -c module_name="testing"

Required Context

The following context values are required for all modules. Note that additional context values may be required if context is referenced from within the module/app config.