Table Of Contents

• Repo Contents & Structure
• Local Development
• Deploying To AWS
• Troubleshooting
• AWS CLI

Repo Contents & Structure

Coming Soon™

Local Development

Important

Ensure your local version of docker-compose is at least v2.27.2

Just Get Me Going, Quick & Dirty

From the root directory of your local ecs-shuttle repo, run:

docker compose up

I Fear No Documentation, Drown Me In Details

Details of setting up and utilizing the local development configuration(s) in the repo can be found in docs/DEVELOPING.md

Deploying Control and Proxy To AWS

Deployment of the Control or Proxy service is done using GitHub Actions.

• Automatic deployments to the dev environment only happen from pull requests that are explicitly labelled dev. Unlabelled PRs will be built but not deployed anywhere.
• Removing the label from a PR will stop automatic deployments but will not revert any deployments that have already happened.
• Deployment to the production environment only happens from the main branch on merge, and is gated by approval.
• The dev environment is never automatically deployed on merging to the main branch (otherwise they would mess up whatever people are doing in the dev environments).

Alternatively, the Control or Proxy services can be deployed from your local machine, but this should only be done for dev environment.

just deploy dev control <tag>

or

just deploy dev proxy <tag>

Troubleshooting

Common (or just particularly annoying to solve) problems encountered by the Devs Who Came Before, and the solutions they found or created are detailed in docs/TROUBLESHOOTING.md

AWS CLI

For how to set up AWS CLI against the three environments, check docs/AWS_CLI.md