Skip to content
This repository has been archived by the owner on Mar 31, 2022. It is now read-only.

Latest commit

 

History

History
32 lines (19 loc) · 2.52 KB

README.md

File metadata and controls

32 lines (19 loc) · 2.52 KB
Raw

This workaround is no longer required!

See https://docs.github.com/en/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-aws-elastic-container-registry

GitHub Codespaces using images from Amazon Elastic Container Registry

While GitHub Codespaces supports using secrets as a way to log into private container image registries, Amazon Elastic Container Registry only supports 12 hour access tokens when using the aws ecr get-password command. Adding this generated password to a Codespaces secret is therefore cumbersome and impractical. This sample works around this problem by using initializeCommand in devcontainer.json to fire the AWS CLI command whenever a codespace is created instead. This allows the custom dev containers to be created that rely on images private repositories in ECR.

To use the sample:

  1. Fork this repository

  2. Configure the following secrets with the appropriate values and be sure to give your forked repository access to them:

    • ECR_ACCOUNT_ID - The appropriate AWS account ID for the ECR instance (basically the start of the server URL).
    • ECR_REGION - AWS region that contains the ECR instance you want to log into.
    • AWS_ACCESS_KEY_ID - A generated AWS access key ID for a user with access to the ECR instance. Using a service account with minimal access to AWS is recommended.
    • AWS_SECRET_ACCESS_KEY - Secret for the access key.

  3. Update the image property in .devcontainer/devcontainer.json to an image in your ECR.

  4. Create a codespace. Note that if you already have a codespace and just want to rebuild instead, you may first need to stop the codespace (F1 or ctrl/cmd+shift+p and select Codespaces: Stop Current Codespace) and restart it before any new secrets will be picked up.

Since you may need to have different secret names for different AWS services you need to connect to, you can change the expected secret names by passing them into the initalizeCommand in devcontainer.json. For example:

"initializeCommand": "bash .devcontainer/ecr-login.sh ACCOUNT_ID_SECRET_NAME REGION_SECRET_NAME ACCESS_KEY_ID_SECRET_NAME SECRET_ACCESS_KEY_SECRET_NAME",

To adapt this to your own repository, just grab .devcontainer/ecr-login.sh, place it in your repository, and update your devcontainer.json file with the initializeCommand from this sample.