Applying config updates for 4.12.0

Release 4.12.0 changes description

Starting from the release 4.12.0 from the 25th of November 2022, the following parameter must be present in each Allure TestOps service configuration:

ALLURE_JWT_SECRET

Before this change, parameter ALLURE_JWT_SECRET was used by the gateway service only.

How to update the configurations

Kubernetes deployment

All needed files of Kubernetes deployment are updated by Qameta Software.

Make sure, you are using correct Helm chart from this repo: https://github.com/qameta/allure-testops-deployment.

If you are using an older Helm chart, please migrate to the new one. The work with older versions of Helm chart is not supported.

On the deployment made with actual Helm chart please do the following:

helm repo update
helm upgrade --install allure-testops qameta/allure-testops -f values.yaml

Then in values.yaml set the release to 4.12.0

version: 4.12.0
<snip>

then deploy again

helm repo update
helm upgrade --install allure-testops qameta/allure-testops -f values.yaml

Helm will do all the work.

Docker compose deployment

Make sure, you are using actual configuration for docker compose deployment from this repo: https://github.com/qameta/allure-docker-compose

If you are using older versions of the docker compose deployment, please migrate to the new one referenced above, then upgrade to 4.12.0

Reminder.

The docker compose configuration consists of 2 files:

  • .env
    • this file is for the end user’s configuration
  • docker-compose.yml
    • this file must not be altered by an end user, for it contains common configs managed by Qameta Software

All docker compose configs (docker-compose.yml files) are updated by Qameta Software and contain all the parameters needed to successfully deploy and start Allure TestOps release 4.12.0

Select the folder where you used the configuration files from. Download updated docker-compose.yml.

Replace docker-compose.yml of your deployment with docker-compose.yml

Make the full restart of your deployment

docker compose down
docker compose up -d

Check the deployment started correctly.

Update .env file as follows:

ALLURE_VERSION=4.12.0

Make the full restart of your deployment

docker compose down
docker compose up -d

Option #2 (at your own risk)

Open docker-compose.yml of your current deployment (again it had to be downloaded from here ).

For make sure each Allure TestOps service (allure-gateway, allure-uaa, allure-gateway) has in its environment section the following string: ALLURE_JWT_SECRET: ${ALLURE_JWT_SECRET}

  allure-gateway:
  <snip>
    environment:
    <snip>
      ALLURE_JWT_SECRET: ${ALLURE_JWT_SECRET}
<snip>
  allure-report:
  <snip>
    environment:
    <snip>
      ALLURE_JWT_SECRET: ${ALLURE_JWT_SECRET}
<snip>
  allure-uaa:
  <snip>
    environment:
    <snip>
      ALLURE_JWT_SECRET: ${ALLURE_JWT_SECRET}
<snip>

If the parameter is missing, copy it from a service with the parameter. You need to have 3 instances of the string ALLURE_JWT_SECRET: ${ALLURE_JWT_SECRET} in your docker-compose.yml file.

Make the full restart of your deployment

docker compose down
docker compose up -d

Check the deployment started correctly.

Update .env file as follows:

ALLURE_VERSION=4.12.0

Make the full restart of your deployment

docker compose down
docker compose up -d

Packages deployment

Allure TestOps must be deployed as described here. If the deployment is made using old packages deployment, you need to switch to the actual one as the settings are incompatible.

Update config files

  1. Locate and open gateway configuration file /opt/allure-testops/gateway/conf/allure-gateway.conf
  2. Locate the string ALLURE_JWT_SECRET=<YOUR-JWT-SECRET-STRING>
    • <YOUR-JWT-SECRET-STRING> here is a placeholder for the real string you had to add to the config.
  3. Copy full line ALLURE_JWT_SECRET=<YOUR-JWT-SECRET-STRING>
  4. Locate and open /opt/allure-testops/report/conf/allure-report.conf
  5. Check if there is line with ALLURE_JWT_SECRET=
  • Overwrite full line ALLURE_JWT_SECRET= with the content copied from gateway parameters.
  • If the parameter is absent, then add it to the config.
  1. Locate and open /opt/allure-testops/uaa/conf/allure-uaa.conf
  2. Check if there is line with ALLURE_JWT_SECRET=
  • Overwrite full line ALLURE_JWT_SECRET= with the content copied from gateway parameters.
  • If the parameter is absent, then add it to the config.
  1. Restart the deployment as follows
systemctl stop allure-uaa
systemctl stop allure-report
systemctl stop allure-gateway

then

systemctl start allure-uaa
systemctl start allure-report
systemctl start allure-gateway

Check the deployment started and works as expected.

Upgrade the deployment to 4.12.0

deb


apt update && apt install allure-testops-min=4.12.0
or 
apt update && apt install allure-testops-box=4.12.0

rpm

yum install allure-testops-min-0:4.12.0-1
or
yum install allure-testops-box-0:4.12.0-1

Check if everything is working as expected.