/ecs-ghcr-cdk-example

Primary LanguageTypeScript

ECS ghcr CDK Example

This is a example project for ECS Fargate with ghcr (i.e private registry).

How to deploy

Warning
This solution will create a secret in a CloudFormation template. For production use, consider referencing the secret from the SecretsManager.

  1. Generate your GitHub PAT for image push.
    1. Access https://github.com/settings/tokens/new
    2. Check the write:packages
    3. Click generate token button.
  2. Run following the command for prepush a image.
    1. docker login ghcr.io -u <Your GitHub Name> --password <Your GitHub PAT for image push>
    2. docker tag nginx:latest ghcr.io/<Your GitHub name>/nginx:latest
    3. docker push ghcr.io/<Your GitHub name>/nginx:latest
  3. Generate your GitHub PAT for image pull.
    1. Access https://github.com/settings/tokens/new
    2. Check the read:packages
    3. Click generate token button.
  4. Edit bin/ecs-ghcr-cdk-example.ts with your GitHub information.
  5. Run yarn cdk deploy command.
  6. Access the outputed URL by CDK

Useful commands

  • npm run build compile typescript to js
  • npm run watch watch for changes and compile
  • npm run test perform the jest unit tests
  • cdk deploy deploy this stack to your default AWS account/region
  • cdk diff compare deployed stack with current state
  • cdk synth emits the synthesized CloudFormation template