testops-legacy

Official template for Deployment using Docker Compose

This config is deprecated, do not use it

Disclaimer

Deployment via docker compose is not suitable for production deployment, so using it means you assume all risks and accept them.

IMPORTANT NOTICE

IMPORTANT: make sure you have docker-compose version > 2.x

Installing docker compose v.2

Please check official Docker's installation guide.

Basically you need to do the following (in the example below we use release 2.5.0 as an example, but the most recent one could differ from the one we used, so please refer to the official doc mentioned above):

apt update && apt install docker.io
export DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
mkdir -p $DOCKER_CONFIG/cli-plugins
curl -SL https://github.com/docker/compose/releases/download/v2.5.0/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose

To check you've done everything correctly execute the command:

docker compose version

IMPORTANT: docker compose should be used without dashes

Steps to get Allure TestOps Up and Running

Do not update the content of docker-compose.yml unless its is explicitly recommended by our support team.

1. Create .env file by copying our template (env-example)

cp env-example .env

2. Edit the values specific for your deployment

3. Define the list of profiles to be used for the deployment and the start (see description in Profiles section).

4. Add the list of profiles on top of .env

   export COMPOSE_PROFILES=default,postgres,redis,rabbit,minio-local

5. Run the docker compose deployment by executing the command

docker-compose up -d

Profiles

The deployment consists of several services needed to successfully run the business logic.

Profiles need to be included in the list of the used profiles only in case the required system is absent in your infrastructure or you cannot use existing service with Allure TestOps.

A profile defines a service which needs to be included in the configuration to start with Allure TestOps.

Some of profiles are incompatible with each other, so be careful with the configuration.

Available profiles

0. default
   • must be disabled if ldap profile is used
1. postgres
   • Enable this profile if you want to use Postgres database in a container started alongside with Allure TestOps.
   • Don't enable this profile it if you have dedicated PostgreSQL server.
2. redis
   • Enable this profile if you want to use Redis in a container started alongside with Allure TestOps. In vast majority of cases, you don't need to have dedicated Redis server as Redis is used to store sessions information only.
3. rabbit
   • Enable this profile if you want to use RabbitMQ in a container started alongside with Allure TestOps.
   • Don't enable, if there is a dedicated RabbitMQ server in the infrastructure and you are allowed to use it with Allure TestOps.
4. minio-local
   • Enable this profile if you want to use min.io (S3 solution to use tests' artifacts) in a container started alongside with Allure TestOps.
   • Don't enable if you have dedicated S3 in your network or you are buying S3 services from a cloud provider (AWS, GCS).
   • If you have dedicated services, then you need additional configuration for the S3 integration (.env).
5. minio-proxy
   • Enable this profile if you want to use min.io as caching proxy before storing files in your S3 solution. It allows you to save some traffic and avoid unnecessary operations with S3.
6. ldap
   • Enable if you are going to integrate Allure TestOps with your LDAP (AD) and use LDAP authentication.
   • This profile must not be enables simultaneously with the default profile.
7. metrics
   • Enable this profile is you are going to collect metrics from Allure TestOps.
   • This works with Prometheus, Grafana and exporters.
   • Make sure you have ./configs/prometheus/prometheus.yml tuned for minio scraping location.

Troubleshooting

1. To understand what's wrong with your services, you need to collect log form the running (even if it has failed).
2. To collect logs from a right service you need the name of a such service
   • names of all services in the docker compose deployment can be found by executing of command docker compose ps
   • check column SERVICE

Collecting logs

In vast majority of cases the technical support will need the logs for the following services:

• allure-report
• allure-uaa
• allure-gateway

Logs need to be saved as txt files.

Generally command to collect logs looks like follows:

docker compose logs service_name

Here is a command which will help you collect all the logs related to Allure TestOps services and save those to separate files:

docker compose logs allure-report > report-logs.txt && \
docker compose logs allure-uaa > uaa-logs.txt && \
docker compose logs allure-gateway > gateway-logs.txt

These files are to be sent to tech support for the analysis.