-
Notifications
You must be signed in to change notification settings - Fork 20
Replace AWS ECR with Docker Hub MM EE image pulling #720
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.
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
fernandinand
wants to merge
1
commit into
main
Choose a base branch
from
718-mm-ee-dockerhub
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,103 +1,41 @@ | ||
| --- | ||
| description: Mergin Maps Enterprise Edition enhanced features are only available on specific Docker images on our private AWS repository. Here is how to retrieve them. | ||
| description: Mergin Maps Enterprise Edition enhanced features are only available on specific Docker images on our private Docker Hub repository. Here is how to retrieve them. | ||
| --- | ||
|
|
||
| # Download your Mergin Maps EE images | ||
| <ServerType type="EE" /> | ||
|
|
||
| To get access to your docker images, you need your contract and licence from our <MerginMapsEmail id="sales" desc="sales team" />. If you do not have them, please contact our team. The repository is private and our team needs to secure you the access to them so you are able to follow these steps. | ||
| During your <EnterprisePlatformName /> onboarding you'll be provided a personal token (PAT) to access Lutra's private Docker Hub were we host Docker images. | ||
|
|
||
| [[toc]] | ||
| Once you receive it you can perform Docker login in two ways. | ||
|
|
||
| ## Amazon Web Services (AWS) | ||
| ## Docker login from CLI | ||
|
|
||
| ### Create (root) AWS account | ||
|
|
||
| ::: warning | ||
| If your organisation already uses AWS cloud services and has a root user, skip this step. | ||
|
|
||
| Maintenance of cloud accounts and security requires deep knowledge. <LutraConsultingName /> does not take responsibility for incorrectly set up accounts. The AWS account and its maintenance is the responsibility of your user. | ||
| ::: | ||
|
|
||
| - Go to [aws.amazon.com](https://aws.amazon.com/) and create new root account | ||
|
|
||
|  | ||
|
|
||
| - Continue with all steps and verify your account | ||
|
|
||
| ### Create IAM user | ||
|
|
||
| ::: warning | ||
| If your organisation already uses AWS cloud services and has a root user, skip this step. | ||
|
|
||
| Maintenance of cloud accounts and security requires deep knowledge. <LutraConsultingName /> does not take responsibility for incorrectly set up accounts. The AWS account and its maintenance is the responsibility of your user. | ||
| ::: | ||
|
|
||
|
|
||
| - Login as the root user | ||
|
|
||
|  | ||
|
|
||
| - Create an IAM user by searching in the console “IAM” and creating a new user. | ||
|
|
||
|  | ||
|
|
||
| - Assign the IAM user administrator account permissions. Look for <NoSpellcheck id="AdministratorAccess" /> permission. | ||
|
|
||
|  | ||
|
|
||
| - Review and add it to your new IAM user account | ||
|
|
||
|  | ||
|
|
||
| - Logout from root AWS account | ||
|
|
||
| ### Identify Account ID and IAM user name | ||
|
|
||
| Account ID and IAM user names are needed for assigning the permissions to docker images by <LutraConsultingName /> operations team. | ||
|
|
||
| ::: warning | ||
| <LutraConsultingName /> will never ask you to share an IAM or root login password or other access details to your accounts. | ||
| ::: | ||
|
|
||
| - Login to your IAM account | ||
|
|
||
|  | ||
|
|
||
| - Now create CLI access key | ||
|
|
||
|  | ||
|
|
||
| - Note down ACCESS_ID and SECRET for AWS command line client | ||
|
|
||
|  | ||
|
|
||
| - Send Account ID and IAM user name to <MerginMapsEmail id="sales" desc="sales team" /> | ||
| - Wait for confirmation that we have shared the ECR repository with you. This can take up to 5 working days. | ||
|
|
||
| ## Download Docker Images | ||
|
|
||
| ::: warning | ||
| To be able to download the images, you need to have permission to do so for your IAM user that is granted by <LutraConsultingName /> | ||
| ::: | ||
| ```bash | ||
| docker login -u ee-support@merginmaps.com | ||
|
|
||
| i Info → A Personal Access Token (PAT) can be used instead. | ||
| To create a PAT, visit https://app.docker.com/settings | ||
|
|
||
|
|
||
| Password: | ||
| ``` | ||
| Once you are prompted to fill in the password, you can type the provided token during onboarding. | ||
|
|
||
| - Open command line and write (you may need to change to your IAM account region). You will be asked for your id and secret to be used. | ||
| Alternatively, you can pass the token via `--password-stdin`, although it's not safe to keep your token on a plain text file. | ||
|
|
||
| ``` | ||
| aws ecr get-login-password --region eu-west-1 | docker login --username AWS --password-stdin 433835555346.dkr.ecr.eu-west-1.amazonaws.com | ||
| ```bash | ||
| cat ~/my_token.txt | docker login -u ee-support@merginmaps.com --password-stdin | ||
| ``` | ||
|
|
||
| - Now list docker images that are shared with you (`mergin-ee-front` is frontend application, `mergin-ee-back` is backend application) | ||
|
|
||
| ``` | ||
| aws ecr describe-images --repository-name mergin/mergin-ee-front --registry-id 433835555346 --region eu-west-1 | ||
| aws ecr describe-images --repository-name mergin/mergin-ee-back --registry-id 433835555346 --region eu-west-1 | ||
| ``` | ||
| ## Credential stores | ||
|
|
||
| - Select the tag you want to use and download image, e.g. `2023.6.1-ee` or any other from the list of images | ||
| Please follow official Docker documentation on how to use [credential stores](https://docs.docker.com/reference/cli/docker/login/#credential-stores) | ||
|
|
||
| ``` | ||
| docker pull 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-back:2023.6.1-ee | ||
| ``` | ||
| ## Docker Pull | ||
|
|
||
|  | ||
| After login, please confirm you can pull the images. | ||
| ```bash | ||
| docker pull lutraconsulting/merginmaps-backend-ee:2025.7.3 | ||
| docker pull lutraconsulting/merginmaps-frontend-ee:2025.7.3 | ||
| ``` | ||
| *Please note the correct/latest version you want to pull from the available [releases](https://github.com/MerginMaps/server/releases)* | ||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we add some note that older images are still available from AWS ECR and also some note that admins should double check images in their compose files?