Remove HOST_MOUNT concept and always mount host files

- Updated docker-compose.yml to simplify volume mounts by using the current directory for all services. - Removed HOST_MOUNT and HOST_MOUNT_SOURCE environment variables from settings and entrypoint scripts, streamlining the configuration for local and production environments. - Refactored setup.py to eliminate the get_olympia_mount function, replacing it with a more straightforward approach to determine the Docker target. - Adjusted GitHub Actions workflows to remove references to the obsolete mount input, ensuring cleaner CI/CD processes. - Enhanced test cases to reflect changes in Docker configuration and environment variable handling.
mozilla · Jan 7, 2025 · 8e76203 · 8e76203
1 parent f87560f
commit 8e76203
Show file tree

Hide file tree

Showing 11 changed files with 98 additions and 194 deletions.
diff --git a/.github/actions/run-docker/action.yml b/.github/actions/run-docker/action.yml
@@ -23,10 +23,6 @@ inputs:
     description: 'Docker target to run (development|production)'
     required: false
     default: 'production'
-  mount:
-    description: 'Mount host files at runtime? (development|production)'
-    required: false
-    default: 'production'
   deps:
     description: 'Which dependencies to install at runtime? (development|production)'
     required: false
@@ -44,7 +40,6 @@ runs:
           DOCKER_DIGEST="${{ inputs.digest }}" \
           DOCKER_TARGET="${{ inputs.target }}" \
           OLYMPIA_UID="$(id -u)" \
-          OLYMPIA_MOUNT="${{ inputs.mount }}" \
           OLYMPIA_DEPS="${{ inputs.deps }}" \
           DATA_BACKUP_SKIP="${{ inputs.data_backup_skip }}" \
           DOCKER_WAIT="true"

diff --git a/.github/workflows/_test_check.yml b/.github/workflows/_test_check.yml
@@ -46,7 +46,6 @@ jobs:
     name: |
       version: '${{ matrix.version }}' |
       target: '${{ matrix.target }}' |
-      mount: '${{ matrix.mount }}' |
       deps: '${{ matrix.deps }}'
     strategy:
       fail-fast: false
@@ -57,9 +56,6 @@ jobs:
         target:
           - development
           - production
-        mount:
-          - development
-          - production
         deps:
           - development
           - production
@@ -72,7 +68,6 @@ jobs:
             Values passed to the action:
             version: ${{ matrix.version }}
             target: ${{ matrix.target }}
-            mount: ${{ matrix.mount }}
             deps: ${{ matrix.deps }}
           EOF
       - name: ${{ matrix.version == 'local' && 'Uncached Build' || 'Pull' }} Check
@@ -84,7 +79,6 @@ jobs:
         with:
           version: ${{ matrix.version }}
           target: ${{ matrix.target }}
-          mount: ${{ matrix.mount }}
           deps: ${{ matrix.deps }}
           run: make check
       - name: Cached Build Check
@@ -93,7 +87,6 @@ jobs:
         with:
           version: ${{ matrix.version }}
           target: ${{ matrix.target }}
-          mount: ${{ matrix.mount }}
           deps: ${{ matrix.deps }}
           run: echo true
 

diff --git a/.github/workflows/_test_main.yml b/.github/workflows/_test_main.yml
@@ -88,7 +88,6 @@ jobs:
           services: ''
           digest: ${{ inputs.digest }}
           version: ${{ inputs.version }}
-          mount: development
           deps: development
           run: |
             split="--splits ${{ needs.test_config.outputs.splits }}"

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -87,7 +87,6 @@ jobs:
         with:
           digest: ${{ needs.build.outputs.digest }}
           version: ${{ needs.build.outputs.version }}
-          mount: development
           deps: development
           target: development
           run: |
@@ -140,7 +139,6 @@ jobs:
         with:
           digest: ${{ needs.build.outputs.digest }}
           version: ${{ needs.build.outputs.version }}
-          mount: development
           deps: development
           run: make extract_locales
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -45,10 +45,7 @@ services:
     command: ["sleep", "infinity"]
     volumes:
       # used by: web, worker, nginx
-      - ${HOST_MOUNT_SOURCE:?}:/data/olympia
-      - ${HOST_MOUNT_SOURCE:?}deps:/data/olympia/deps
-      - ./site-static:/data/olympia/site-static
-      - ./storage:/data/olympia/storage
+      - ./:/data/olympia
   worker:
     <<: *olympia
     command: [
@@ -63,9 +60,7 @@ services:
       "celery -A olympia.amo.celery:app worker -E -c 2 --loglevel=INFO",
     ]
     volumes:
-      - ${HOST_MOUNT_SOURCE:?}:/data/olympia
-      - ${HOST_MOUNT_SOURCE:?}deps:/data/olympia/deps
-      - ./storage:/data/olympia/storage
+      - ./:/data/olympia
     extra_hosts:
      - "olympia.test:127.0.0.1"
     restart: on-failure:5
@@ -93,17 +88,12 @@ services:
       interval: 30s
       retries: 3
       start_interval: 1s
-    volumes:
-      - ./static-build:/data/olympia/static-build
-      - ./site-static:/data/olympia/site-static
 
   nginx:
     image: nginx
     volumes:
       - data_nginx:/etc/nginx/conf.d
-      - ${HOST_MOUNT_SOURCE:?}:/srv
-      - ./site-static:/srv/site-static
-      - ./storage:/srv/storage
+      - ./:/srv
     ports:
       - "80:80"
     networks:
@@ -202,16 +192,6 @@ networks:
     enable_ipv6: false
 
 volumes:
-  # Volumes for the production olympia mounts
-  # allowing to conditionally mount directories
-  # from the host or from the image to <path>
-  # in the running docker container.
-  # If OLYMPIA_MOUNT_SOURCE matches (data_olympia_)
-  # then we use the production volume mounts. Otherwise
-  # it will map to the current directory ./<name>
-  # (data_olympia_)<name>:/<path>
-  data_olympia_:
-  data_olympia_deps:
   # Volume for rabbitmq/redis to avoid anonymous volumes
   data_rabbitmq:
   data_redis:

diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
@@ -30,12 +30,6 @@ fi
 NEW_HOST_UID=$(get_olympia_uid)
 OLYMPIA_ID_STRING="${NEW_HOST_UID}:$(get_olympia_gid)"
 
-# If we are on production mode, update the ownership of /data/olympia to match the new id
-if [[ "${HOST_MOUNT}" == "production" ]]; then
-  echo "Updating ownership of /data/olympia to ${OLYMPIA_ID_STRING}"
-  chown -R ${OLYMPIA_ID_STRING} /data/olympia
-fi
-
 cat <<EOF | su -s /bin/bash $OLYMPIA_USER
   echo "Running command as ${OLYMPIA_USER} ${OLYMPIA_ID_STRING}"
   set -xue

diff --git a/scripts/setup.py b/scripts/setup.py
@@ -39,7 +39,7 @@ def get_value(key, default_value):
     return default_value
 
 
-def get_docker_tag():
+def get_docker_image_meta():
     image = 'mozilla/addons-server'
     version = 'local'
 
@@ -64,32 +64,20 @@ def get_docker_tag():
         tag = f'{image}:{version}'
         digest = None
 
+    # Docker target can be set on local images, but should be inferred from the image
+    # on remote images. Remote images are always built for production.
+    target = (
+        get_value('DOCKER_TARGET', 'development')
+        if version == 'local'
+        else 'production'
+    )
+
     print('tag: ', tag)
+    print('target: ', target)
     print('version: ', version)
     print('digest: ', digest)
 
-    return tag, version, digest
-
-
-def get_olympia_mount(docker_target):
-    """
-    When running on production targets, the user can specify the olympia mount
-    to one of the valid values: development or production. In development, we
-    hard code the values to ensure we have necessary files and permissions.
-    """
-    dev_source = './'
-    prod_source = 'data_olympia_'
-    olympia_mount = docker_target
-    olympia_mount_source = dev_source if docker_target == 'development' else prod_source
-
-    if (
-        docker_target == 'production'
-        and os.environ.get('OLYMPIA_MOUNT') == 'development'
-    ):
-        olympia_mount = 'development'
-        olympia_mount_source = dev_source
-
-    return olympia_mount, olympia_mount_source
+    return tag, target, version, digest
 
 
 # Env file should contain values that are referenced in docker-compose*.yml files
@@ -107,26 +95,14 @@ def get_olympia_mount(docker_target):
 
 
 def main():
-    docker_tag, docker_version, _ = get_docker_tag()
-
-    is_local = docker_version == 'local'
-
-    # The default target should be inferred from the version
-    # but can be freely overridden by the user.
-    # E.g running local image in production mode
-    docker_target = get_value(
-        'DOCKER_TARGET', ('development' if is_local else 'production')
-    )
-
-    is_production = docker_target == 'production'
+    docker_tag, docker_target, _, _ = get_docker_image_meta()
 
     olympia_uid = os.getuid()
-    olympia_mount, olympia_mount_source = get_olympia_mount(docker_target)
 
     # These variables are special, as we should allow the user to override them
     # but we should not set a default to the previously set value but instead
     # use a value derived from other stable values.
-    debug = os.environ.get('DEBUG', str(False if is_production else True))
+    debug = os.environ.get('DEBUG', str(docker_target != 'production'))
     olympia_deps = os.environ.get('OLYMPIA_DEPS', docker_target)
 
     set_env_file(
@@ -139,10 +115,6 @@ def main():
             # These values are mapped back to the olympia_* values in the environment
             # of the container so everywhere they can be referenced as the user expects.
             'HOST_UID': olympia_uid,
-            'HOST_MOUNT': olympia_mount,
-            # Save the docker compose volume name
-            # to use as the source of the /data/olympia volume
-            'HOST_MOUNT_SOURCE': olympia_mount_source,
             'DEBUG': debug,
             'OLYMPIA_DEPS': olympia_deps,
         }

diff --git a/settings.py b/settings.py
@@ -19,7 +19,6 @@
 DEV_MODE = DOCKER_TARGET != 'production'
 
 HOST_UID = os.environ.get('HOST_UID')
-HOST_MOUNT = os.environ.get('HOST_MOUNT')
 
 WSGI_APPLICATION = 'olympia.wsgi.application'
 

diff --git a/src/olympia/lib/settings_base.py b/src/olympia/lib/settings_base.py
@@ -73,7 +73,6 @@ def path(*folders):
 
 # Host info that is hard coded for production images.
 HOST_UID = None
-HOST_MOUNT = None
 
 # Used to determine if django should serve static files.
 # For local deployments we want nginx to proxy static file requests to the