We support packaged installation using deb and rpm packages.
Important updates - 2022-04-29
Starting from the 30th of April and release 3.193.1 we moved the packages repo to our own artifactory service — dl.qameta.io.
What does it mean for the packages users?
You need to update your settings for packages download.
If your old credentials aren't working, please feel free to contact our support and we'll provide the new ones.
Important notice 2023-07-12
Staring from the release 4.18.0 SMTP settings in UAA are mandatory, for these are used to invite new members to Allure Testops instance.
By default we send our clients the credentials for docker-compose / Kubernetes installation, i.e. for pulling the images.
To be able to download and install packages from our artifactory you need to have the credentials specific for packages installation.
Credentials are to be requested using our help desk. Please state the company name used to get the licence and include "credentials for packages installation" into the subject of your request.
Types of packages
There are 2 types of the packages available:
Minimal package contains only Allure TestOps binaries
Allure TestOps uaa service
Allure TestOps gateway service
Allure TestOps report service
Minimal package is your solution if you already have your own infrastructure in place with all needed additional services, or you are going to install other services needed for Allure TestOps to run separately:
Amazon Corretto JDK 17
S3 solution (e.g. min.io)
PostgreSQL database server version no lower than 14
nginx or any other reverse proxy if it's required
Box package includes all the additional applications/services required for Allure TestOps to start up and operate.
So, all the tools will be installed, set up and started with Allure TestOps.
Effective from March 2023. The Box package will require the manual installation of some components required for Allure TestOps
The following actions need to be performed to add Qameta Software's artifactory to your packages manager:
Copy all the lines from below:
cat << EOF >> /etc/apt/sources.list.d/qameta.list
deb [trusted=yes] https://dl.qameta.io/artifactory/debian stable main
deb [trusted=yes] https://dl.qameta.io/artifactory/debian focal main
deb [trusted=yes] https://dl.qameta.io/artifactory/debian focal-pgdg main
deb [trusted=yes] https://dl.qameta.io/artifactory/deb-local stable main
Start your terminal application
Type 'sudo su' if you are not a root user, then enter you password when prompted.
Paste the text in the terminal application and press Enter.
Do not use apt upgrade for the release upgrades as it could install a release candidate which stop your production environment and you won't be able to roll back changes due to database schema incompatibility.
Deb packages' configuration files
The configuration files and way to configure Allure TestOps' service has been changed comparing to the way it was done before the 30th of April 2022.
Configuration files paths
For Debian-like OSs the configuration files of Allure TestOps services reside in /opt/allure-testops
Configuration is now being done via set of environment variables stored in a allure-<service>.conf file specific for each of Allure TestOps services.
Initial installation of Allure TestOps contains the set of Environment variables sufficient to successfully bring Allure TestOps up.
All additional settings required for the integration is described in further sections of this very article.
Configuration of Allure TestOps
admin user log-in information
Allure TestOps requires admin (admin is the default user name for this user) account to be created and kept in the system. This name (admin) and password are defined in the configuration file (allure-uaa.conf) and it will be restored to the state described in the configuration file to ensure you won't lose the access to your Allure TestOps instance, this means if you disable user admin in the UI, remove admin's roles and change the password, during the next start of Allure TestOps, it will recreate the user again with all set of available rights, with the password defined in the configuration file.
Do not delete, disable or change the authorities set by the system to this user.
Please consider changing the admin's password in the configuration before the deployment or remove it to have a new password each time system restarts.
If you omit provisioning of initial admin's password, then default user admin will be created and admin's strong password will be generated by the system, and then the generated password will be sent to the logs of uaa service.
Each time Allure TestOps is restarted, the admin's account is restored to its initial state as per the configuration file (allure-uaa.conf).
UAA service's configuration file resides as follows:
Here are the recommended settings for the users registration.
SPRING_MAIL_ parameters are mandatory for the users management and passwords reset, so these lines must be enabled and properly configured.
ALLURE_REGISTRATION_ENABLED=false # it's a good idea to have this disabled in a production system
ALLURE_REGISTRATION_AUTOAPPROVE=false # it's a good idea to have this disabled in a production system
ALLURE_REGISTRATION_DEFAULT_ROLE=ROLE_AUDITOR # it's a good idea to have this like this in production
# Example uses Gmail for sending emails
[email protected] # don't forget to update this as well
The storage type used by the installation by default is the S3 storage with min.io service under hood, this type of setup is recommended comparing to the file system storage as it is allowing more stable files processing.
The settings below are used by the installation by default.
# set true for minio usage and false for S3 like AWS S3
For a production system it is recommended to use Amazon AWS or a local S3 solution with SSD disks storage.
Gateway service's configuration file resides as follows:
Allure Test UI by default is available on the port #8080.
So, you need to access it via URL
Log in to Allure TestOps using username and password from /opt/allure-testops/uaa/conf/allure-uaa.conf configuration.
The username is admin and the password is either the default one or the password you've defined in the said file.
Provide the license for your Allure TestOps instance
Next thing you see will be the modal window to which you will need to provide the license you acquired.
After the correct license is provided, you'll be able to start your work.
Upgrading the release of Allure TestOps
Please never use apt upgrade to upgrade the release of Allure TestOps. This command will install the latest binaries which could be a release candidate or an unstable version and this action could potentially lead your working processes to stop.
If you upgrade to an unstable release database changes will be applied and it won't be possible to roll back the changes.
Always explicitly use the release you want to upgrade to. You can check release notes page release notes pages for actual release.
If you have installed Allure TestOps Box package with the release 3.193.0, and you want to upgrade the release to the hot-fix 3.193.1 you need to do the upgrade as follows:
This behaviour will be changed in future but now you need to save the configuration files for each service and restore the configuration files after the upgrade.
For Google S3 you need to use fine-granted access control and settings for public access Subject to object ACLs, this is needed for interoperability with AWS SDK, otherwise files in S3 bucket won't be fully accessible by Allure TestOps and report service will fail to start.
The value Parameter allure.blob-storage.s3.endpoint for Google S3 should be https://storage.googleapis.com.