Skip to content

feat: add instructions for setting up ECR repository #1780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jkuester wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add instructions for setting up ECR repository #1780

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d20bad4
feat: config for setting up ECR repository
jkuester Feb 24, 2025
a768b34
Update content/en/contribute/code/releasing/publish-docker-image.md
jkuester Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions content/en/contribute/code/releasing/publish-docker-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,48 @@ relatedContent: >
core/releases
---

Docker images for CHT projects can be published to the [medicmobile](https://hub.docker.com/u/medicmobile) Docker Hub organization, so they are easily accessible to the community. This process can be automated using GitHub actions.
## Setup Image Repository

Docker images can be published to Docker Hub or Amazon ECR. (You should only publish to one of these repositories. There is no need to store the same image in both places.)

## Create repository on Docker Hub
### Configure repository on Docker Hub

Docker images for CHT projects can be published to the [medicmobile](https://hub.docker.com/u/medicmobile) Docker Hub organization, so they are easily accessible to the community. This process can be automated using GitHub actions.

First, create a repository for your new image on Docker Hub.

1. Use the admin Docker account to [create a new repository](https://hub.docker.com/u/medicmobile) in the `medicmobile` organization.
2. For your new repository, update the permissions to give the `developers` team the ability to `Read & Write`. This will allow the GitHub action to push to the repository.

### Configure repository on ECR

There are two Amazon ERC repositories that can be used for publishing CHT images. `public.ecr.aws/medic` contains the released versions of the images, while `720541322708.dkr.ecr.eu-west-2.amazonaws.com/medic` is used to store branch builds (useful for CI testing, etc).

Use an AWS admin account to add a new _public_ repository configuration for the new Docker image. For example, for the `cht-couchdb-nouveau` image, it would look like:

```json
{
"repository": {
"repositoryArn": "arn:aws:ecr:eu-west-2:720541322708:repository/medic/cht-couchdb-nouveau",
"registryId": "720541322708",
"repositoryName": "medic/cht-couchdb-nouveau",
"repositoryUri": "720541322708.dkr.ecr.eu-west-2.amazonaws.com/medic/cht-couchdb-nouveau",
"createdAt": "2024-12-03T13:05:44.979000+03:00",
"imageTagMutability": "MUTABLE",
"imageScanningConfiguration": {
"scanOnPush": false
},
"encryptionConfiguration": {
"encryptionType": "AES256"
}
}
}
```

Update the `ecr-publishers` IAM Group policy (associated with the IAM user: `ci-user`) in include the resource url for your new Docker image in the `Statement[*].Resource` array.

_See this issue thread for more details: [#9685](https://github.com/medic/cht-core/issues/9685)._

## Add GitHub Action Workflow configuration

Now that the Docker Hub repository is created, you can add the GitHub Action workflow configuration to your project. This configuration should build the Docker image based on the code in the repository and then publish it to the Docker Hub repository.
Expand Down