Installation and Deployment

Note that this installation guide is only of interest to those who would like to contribute or host this service. Regular users of the EO-MQS do not need to familiarize themselves with the installation procedure and can skip this chapter.

Overview

The package contains the following docker-compose files to allow for a quick deployment on any server.

docker-compose.traefik.yml: sets up a Traefik instance and takes care about HTTPS certificates, reverse proxying and load balancing.
docker-compose.yml: installs and starts the EO-MQS app in a Docker container.

Note that the deployment setup is based on tiangolo’s guide on how to deploy fastapi apps with https.

Prerequesites

A working installation of Docker and Docker Compose is required.

Furthermore, the Docker network specified in the docker-compose files needs to be created before building the Docker containers. The exact command depends on your network infrastructure, but might be as simple as

docker network create mqs01

Additionally, the following environment variables need to be set:

# Traefik
USERNAME=                                          # Traefik Dashboard user name
PASSWORD=                                          # Traefik Dashboard password
HASHED_PASSWORD=$(openssl passwd -apr1 $PASSWORD)  # Hashed password created via openssl
EMAIL=                                             # Email to be registered with Let's Encrypt
DOCKER_IP_TRAEFIK=                                 # Docker IP assigned to the traefik service

# EO-MQS App
MQS_HOST=                                          # will be used like this: https://{MQS_HOST}/stac/v1
MQS_PORT=                                          # port inside the container.

Start the Stack

If all requirements are met, the Traefik and EO-MQS containers can be started via docker-compose up:

docker-compose -f docker-compose.traefik.yml up -d
docker-compose -f docker-compose.yml up -d

The MQS app should then be available at https://{EO-MQS_HOST}/stac/v1.

Local Installation

This package can also be installed locally into a conda environment using the provided environment file.

# To install manually make sure to have miniconda installed!
git clone git@github.com:c-scale-mqs/mqs.git
cd mqs
conda env create -f ./environment.yml

conda activate cscale-mqs
pip install .

Or it can be built via the provided Dockerfile.

docker build -t eodc/mqs .

Local Usage

The API can then be started via

python -m mqs.app

Or via Docker, e.g. by using the provided docker-compose setup file:

docker-compose up

By default, the EO-MQS exposes the API on port 8000.

Local Development

For local development, an override docker-compose file for the EO-MQS is provided. The package will be installed in development mode inside the container and all code changes will be reflected without the need to re-build the image.

To get started use

docker-compose up --build

without the -f option!

Testing

The tests inside the EO-MQS container started in development mode can be executed via

docker exec MQS_CONTAINER_NAME pytest

where EO-MQS_CONTAINER_NAME needs to be replaced with the actual name of the running container.

Contributing

Contributions are welcome!