Preamble

This section describes mandatory parameters the end users need to add to their configuration before upgrading to 3.185.0 release. Ideally, you need to update these parameters on 3.184.x release.

ALLURE_CRYPTO_PASSWORD (allure.crypto.password)

To satisfy our clients requirements for secure storage of the secrets in the database we've made a parameter called ALLURE_CRYPTO_PASSWORD (for packages it will be allure.crypto.password) a mandatory one.

Starting from the release 3.185.0 this parameter will be required to start Allure TestOps. This means the absence of this parameter in the configuration will lead to the application's process termination.

We're using AES-256-CBC to encrypt the data, and ALLURE_CRYPTO_PASSWORD is used to encrypt the data in the database.

There are two steps for implementing this parameter:

Configuration update
Triggering an API command to apply encryption to existing secrets.

Configuration update

ALLURE_CRYPTO_PASSWORD configuration parameter needs to be added to both - report and uaa services.

Deployment via docker-compose

  report:
    <snip>
    environment:
      # DB securty ALLURE_CRYPTO_PASSWORD value needs to be updated
      ALLURE_CRYPTO_PASSWORD: <place here any string to be used for encryption>
      <snip>

  uaa:
    <snip>
    environment:
      # DB securty ALLURE_CRYPTO_PASSWORD value needs to be updated
      ALLURE_CRYPTO_PASSWORD: <place here any string to be used for encryption>
      <snip>

Deployment via Kubernetes

values.yaml is to be updated as follows:

version: 3.184.3
uaa:
  <snip>
  env:
    open:
    <snip>
    secret:
      ALLURE_CRYPTO_PASSWORD: <place here any string to be used for encryption>
    <snip>
      
report:
  <snip>
  env:
    open:
    <snip>
    secret:
      ALLURE_CRYPTO_PASSWORD: <place here any string to be used for encryption>
    <snip>

Deployment via packages

Add the following to the content of /opt/allure-ee/report/conf/allure-report.properties file:

allure.crypto.password=<place here any string to be used for encryption>

Add the following to the content of /opt/allure-ee/uaa/conf/allure-uaa.properties file:

allure.crypto.password=<place here any string to be used for encryption>

Triggering API to encrypt existing secrets

After you've updated the configuration and successfully started Allure TestOps with the updated configuration, you need to proceed to the page with Allure TestOps' API description ALLURE_URL/swagger-ui.html:

Locate credentials-controller section
Locate /api/rs/credentials/encrypt command
Expand the command and click Try it out
Click Execute

ALLURE_ENDPOINT (allure.endpoint)

ALLURE_ENDPOINT is the parameter providing the information about URL of Allure TestOps. Its value is used by Allure TestOps to provide the references for integration purposes.

ALLURE_ENDPOINT should be the real IP address or URL of your Allure TestOps instance.

Updating the configuration

Deployment via docker-compose

  report:
    <snip>
    environment:
      # endpoint mandatory parameter
      ALLURE_ENDPOINT: https://<URL>:port
      <snip>

  uaa:
    <snip>
    environment:
      # endpoint mandatory parameter
      ALLURE_ENDPOINT: https://<URL>:port

Deployment via Kubernetes

values.yaml is to be updated as follows:

version: 3.184.3
uaa:
  <snip>
  env:
    open:
    ALLURE_ENDPOINT: https://<URL>:port
    <snip>
      
report:
  <snip>
  env:
    open:
    ALLURE_ENDPOINT: https://<URL>:port
    <snip>

Deployment via packages

Add the following to the content of /opt/allure-ee/report/conf/allure-report.properties file:

allure.endpoint=https://<URL>:port

Add the following to the content of /opt/allure-ee/uaa/conf/allure-uaa.properties file:

allure.endpoint=https://<URL>:port