Docker Compose

Deployment of Allure TestOps using docker-compose

IMPORTANT UPDATE on 2021-01-21 for login procedure to docker hub. See prerequisites and login to docker hub sections!

This section covers following information:

With docker-compose you can easily configure, install, and upgrade your Docker based Allure TestOps installation.

For production deployments, we strongly recommend using the detailed installation instructions utilising external PostgreSQL, RabbitMQ, and object storage services.

Prerequisites

  1. You need to obtain security token to login to hub.docker.com. from our sales team .
  2. You need to obtain the license key. Please contact our sales team to get the license key.
  3. You need to have docker and docker-compose installed on your target machine.

Configuration

Configuration file .env contains required settings for the deployment with docker-compose:

VERSION=3.158.0                   # application version
SERVER_PORT=8080                  # application port
LICENSE=                          # license key you have received from our sales team
ADMIN_USERNAME=admin              # admin username
ADMIN_PASSWORD=admin              # admin password
REGISTRATION_AUTOAPPROVE=true     # allow user registration
JWT_SECRET=secret-text            # JWT secret text

Installation

Login to docker hub

Log in to the Docker registry: using username - qametaaccess.

$ docker login --username qametaaccess

then docker will request you to provide the password. Please use the security token you’ve received from our sales team - refer to the item 1 in prerequisites.

Download compose file

Download and unpack allure-ee.zip with following files:

+ allure-ee
  - .env             # configuration
  - docker-compose   # docker compose file

Start Allure TestOps

Once you have all of your configuration options collected, you can get any dependencies and run compose:

docker-compose pull
docker-compose up -d

This will output the list of resources installed once the deployment finishes, which may take 2-3 minutes to complete.

Update

Once your Allure TestOps started, configuration changes and images updates should be done using the following set of commands:

docker-compose pull
docker-compose down

Update version in the file .env and run Allure TestOps via compose:

docker-compose up -d

Accessing the system

Accessing Web interface

Allure is available at <http://<%your-hostname-here%>:8080>

Initial login

Log in to Allure TestOps using username and password from configuration file.

Default credentials are: admin/admin.

Troubleshooting

Showing all logs

docker-compose logs -f --tail=20

Logs of specific component

docker-compose logs -f --tail=20 uaa
docker-compose logs -f --tail=20 report
docker-compose logs -f --tail=20 gateway

Service status

Show service status in consul (replace 127.0.0.1 by your consul IP address):

curl  http://127.0.0.1:8500/v1/health/service/allure-ee-gateway?ns=default
curl  http://127.0.0.1:8500/v1/health/service/allure-ee-uaa?ns=default
curl  http://127.0.0.1:8500/v1/health/service/allure-ee-report?ns=default

Uninstall

To uninstall the Allure TestOps, run the following:

docker-compose down -v --rmi local

Integration with external storages

Generally, the integration with external storage is being performed using the environment variables. Here you will find the detailed description on how to integrate Allure TestOps with external storages.

Back to deployment