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 4 commits into main from 718-mm-ee-dockerhub

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ dist @@
     .nyc_output
     .basement
     .idea
+    .src
     config.local.js
     basement_dist
     merginmaps.pdf
@@ Expand Down @@

scripts/wordlist.txt

-Original file line number
+Diff line change
@@ Expand Up / @@ -80,6 +80,7 @@ LGPL @@
     LGPLv
     LTR
     Lutra
+    Lutra's
     MAN
     Mapbox
     MBTiles
@@ Expand All / @@ -104,6 +105,7 @@ OGR @@
     Ok
     OpenMapTiles
     OpenStreetMap
+    onboarding
     PDOP
     PNG
     PR
@@ Expand Down Expand Up / @@ -184,6 +186,7 @@ checkboxes @@
     cloudmergin
     conf
     config
+    conformant
     crosshairs
     cybersecurity
     dataset
@@ Expand Down @@

src/server/install/ee/assign_permission_2.jpg

Binary file not shown.

src/server/install/ee/assign_permission_2.xcf

Binary file not shown.

src/server/install/ee/assign_permissions.jpg

Binary file not shown.

src/server/install/ee/assign_permissions.xcf

Binary file not shown.

src/server/install/ee/create_IAM_user.jpg

Binary file not shown.

src/server/install/ee/create_IAM_user.xcf

Binary file not shown.

src/server/install/ee/create_access_key.jpg

Binary file not shown.

src/server/install/ee/create_access_key.xcf

Binary file not shown.

src/server/install/ee/create_aws_account.jpg

Binary file not shown.

src/server/install/ee/create_aws_account.xcf

Binary file not shown.

src/server/install/ee/docker_pull.jpg

Binary file not shown.

src/server/install/ee/docker_pull.xcf

Binary file not shown.

src/server/install/ee/find_name_and_id.jpg

Binary file not shown.

src/server/install/ee/find_name_and_id.xcf

Binary file not shown.

src/server/install/ee/index.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,103 +1,62 @@
  
    ---

    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

    ![Create AWS account](./create_aws_account.jpg "Create AWS 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

    ```bash

        docker login -u [email protected]

        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.

    ![Login as root to AWS](./root_login.jpg "Login as root to AWS")

    Alternatively, you can pass the token via `--password-stdin`, although it's not safe to keep your token on a plain text file.

    - Create an IAM user by searching in the console “IAM” and creating a new user. 

    ![Create IAM user](./create_IAM_user.jpg "Create IAM user") 

    ```bash

      cat ~/my_token.txt | docker login -u [email protected] --password-stdin

    ```

    - Assign the IAM user administrator account permissions. Look for <NoSpellcheck id="AdministratorAccess" /> permission.

    ![Assign AWS permissions](./assign_permissions.jpg "Assign AWS permissions") 

    ## Credential stores

    - Review and add it to your new IAM user account

    Please follow official Docker documentation on how to use [credential stores](https://docs.docker.com/reference/cli/docker/login/#credential-stores)

    ![Finish assigning AWS permissions](./assign_permission_2.jpg "Finish assigning AWS permissions") 

    ## Docker Pull

    - Logout from root AWS account

    ### Identify Account ID and IAM user name

    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 <GitHubRepo id="MerginMaps/server/releases" desc="releases" />

    Account ID and IAM user names are needed for assigning the permissions to docker images by <LutraConsultingName /> operations team. 

    ## AWS ECR Images

    ::: warning 

    <LutraConsultingName /> will never ask you to share an IAM or root login password or other access details to your accounts.

    During this transition phase, the AWS ECR repository will still be maintained giving our costumers the ability to update and time to adapt.

    Therefore, if you still have the AWS ECR repository configuration implemented, you can still perform:

    :::

    - Login to your IAM account

    ![Login as IAM user to AWS](./login_IAM.jpg "Login as IAM user to AWS")

    - Now create CLI access key

    ![Create access keys](./create_access_key.jpg "Create access keys")

    - Note down ACCESS_ID and SECRET for AWS command line client

    ![Console login details](./find_name_and_id.jpg "Console login details")

    - 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 />

    :::

     - 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.

    ```

    aws ecr get-login-password --region eu-west-1 | docker login --username AWS --password-stdin 433835555346.dkr.ecr.eu-west-1.amazonaws.com

    ```

     - Now list docker images that are shared with you (`mergin-ee-front` is frontend application, `mergin-ee-back` is backend application)

    ```bash

      docker pull 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-back:2025.7.3

      docker pull 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-frontend:2025.7.3  

    ```

    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

    ```

     - Select the tag you want to use and download image, e.g. `2023.6.1-ee` or any other from the list of images

    ```

    docker pull 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-back:2023.6.1-ee

    ``` 

    ::: note 

    Please note that you need to tag the image after this step in order to be conformant with the main deployment workflow.

    :::

    ![Docker pull of Mergin Maps EE image](./docker_pull.jpg "Docker pull of Mergin Maps EE image")

    ```bash

      docker image tag 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-back:2025.7.3 lutraconsulting/merginmaps-backend-ee:2025.7.3

      docker image tag 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-front:2025.7.3 lutraconsulting/merginmaps-frontend-ee:2025.7.3

    ```

src/server/install/ee/login_IAM.jpg

Binary file not shown.

src/server/install/ee/login_IAM.xcf

Binary file not shown.

src/server/install/ee/root_login.jpg

Binary file not shown.

src/server/install/ee/root_login.xcf

Binary file not shown.

src/server/install/index.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -52,7 +52,7 @@ Follow the deployment guidelines to install and configure it. @@
     <ServerType type="EE" />
-    The <EnterprisePlatformName /> enhanced features are only available on specific Docker images stored on Lutra Consulting's private AWS repository. To get access, you need your contract and licence from our <MerginMapsEmail id="sales" desc="sales team" />.
+    The <EnterprisePlatformName /> enhanced features are only available on specific Docker images stored on Lutra Consulting's private Docker Hub repository. To get access, you need your contract and licence from our <MerginMapsEmail id="sales" desc="sales team" />.
     Afterwards, you can follow [this guide](./ee/) to retrieve your <EnterprisePlatformName /> images.
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace AWS ECR with Docker Hub MM EE image pulling #720

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Replace AWS ECR with Docker Hub MM EE image pulling #720

Are you sure you want to change the base?

Uh oh!

Replace AWS ECR with Docker Hub MM EE image pulling #720

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!