infra

Infrastructure as code

Overview

This CDK project deploys the API using AWS Elastic Container Service, backed by Fargate with an Application Load Balancer. It can optionally deploy the app to a custom subdomain if you have a domain setup with Route 53.

Development

This project was created with AWS CDK. The cdk.json file tells the CDK Toolkit how to execute the app.

A new virtual environment should be created for the infra deployment:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

# if this is the first time CDK has been used, your account should be bootstrapped
cdk bootstrap

❗ The environment variables should be setup by copying .env.example to .env and populating with required values.

❗ The Mapbox API key should be stored using the AWS Secrets Manager as follows:

aws secretsmanager create-secret \
    --name mapbox_api_key \
    --description "The API key for Mapbox" \
    --secret-string "pk.123456789qwertyuiop"

CDK can then be used to deploy:

# synth the cloud formation template to ensure there are no errors
cdk synth

# check what changes will be made first before deploying
cdk diff

# deploy the api
cdk deploy

# To remove
# Note that CDK cannot yet remove the images stored in ECR so this should
# be done manually
cdk destroy

Useful commands:

• cdk ls list all stacks in the app
• cdk synth emits the synthesized CloudFormation template
• cdk deploy deploy this stack to your default AWS account/region
• cdk diff compare deployed stack with current state
• cdk docs open CDK documentation

A note about AWS SSO

If you are using AWS Single Sign On (SSO), the you should first ensure you are signed in:

# if this is the first time using the AWS command line, configure SSO:
aws sso configure

# then login to generate access keys
aws sso login

However, CDK and AWS SSO are not yet connected. A helper npm package, cdk-sso-sync can be used to ensure CDK can read your access keys:

cdk-sso-sync <PROFILE_NAME>