Установка ТестОпс версии 5.x с помощью DEB-пакетов

Важно

В разделе описывается, как установить и запустить ТестОпс версии 5.х на Ubuntu Linux с помощью DEB-пакетов.

Инструкция для версии 4.x перенесена в архив. Чтобы установить и запустить ТестОпс, пожалуйста, используйте только актуальную инструкцию.

К сведению

В зависимости от настроек операционной системы вы можете столкнуться с проблемами при вставке многострочных команд в терминал. Чтобы исправить ситуацию, выполните эту команду перед началом работы:

bind 'set enable-bracketed-paste on'

Миграция с ТестОпс версии 4.x

Важно

ТестОпс версии 5.х нельзя развернуть поверх версии 4.х. Для обновления необходима миграция данных в одну базу данных, а также переход на новую конфигурацию.

Перейти на ТестОпс версии 5.х можно только с версии 4.26.5. Обновление с более старых версий приведет к сбоям в системе и потере данных.

Чтобы обновить ТестОпс версии 4.26.5 до версии 5.x:

Создайте новый файл testops.conf для обновленного DEB-пакета на основе вашей конфигурации.
Остановите инстанс ТестОпс версии 4.х.
Объедините базы данных сервисов UAA и report.

Целевая база данных при объединении — база данных сервиса report.
Запустите развертывание с помощью DEB-пакета.

Для получения более подробной информации, пожалуйста, обратитесь к руководству по миграции.

Подготовительные шаги для установки ТестОпс версии 5.x «с нуля»

Убедитесь, что вы используете Ubuntu версий 20.04 LTS, 22.04 LTS или 24.04 LTS. ТестОпс официально не поддерживается на не-LTS версиях.

Чтобы проверить версию вашей операционной системы, выполните команду в терминале:
```
lsb_release -a
```
Важно
Не устанавливайте ТестОпс на сервер, который используется для других целей. ТестОпс требует много ресурсов, поэтому совместное использование ресурсов с другими программами может привести к серьезным проблемам с производительностью.
Разверните дополнительные сервисы:
- PostgreSQL базу данных,
- MinIO или другой S3-совместимый сервер для хранения данных,
- RabbitMQ сервер сообщений,
- Redis сервер для хранения данных.
Рекомендуется запускать PostgreSQL и S3-совместимое хранилище на разных серверах.
Получите лицензию на ТестОпс.

Чтобы получить ключ для коммерческой лицензии, свяжитесь с нами по адресу [email protected]. В письме укажите, что планируете установить ТестОпс с помощью DEB-пакетов.

Вместе с лицензионным ключом вы получите имя пользователя и пароль для доступа к DEB-репозиторию ТестОпс.
Получите подробную информацию о настройке аутентификации внутри вашей организации.

Данные, необходимые для настройки, зависят от того, какой подход к аутентификации пользователя вы выберете. Возможные варианты:
- Стандартная аутентификация с помощью имени пользователя и пароля, реализованная в ТестОпс.
  
  Этот вариант использует SMTP-сервер для отправки приглашений новым пользователям и не требует использования дополнительных сервисов.
- Аутентификация через внешнего провайдера идентификационных данных (IdP).
  
  Детали, необходимые для этого, могут отличаться в зависимости от типа используемого провайдера идентификационных данных. Подробная информация о настройках находится в соответствующих разделах документации.

Установка зависимостей

Amazon Corretto

Amazon Corretto версии 21 используется в качестве реализации JDK для запуска ТестОпс. Чтобы установить его, выполните следующие команды в терминале:

wget -q -O- https://apt.corretto.aws/corretto.key | sudo gpg --dearmor --output /usr/share/keyrings/corretto.gpg
echo "deb [signed-by=/usr/share/keyrings/corretto.gpg] https://apt.corretto.aws stable main" | sudo tee /etc/apt/sources.list.d/corretto.list
sudo apt update
sudo apt install -y java-21-amazon-corretto-jdk

Более подробная информация доступна в инструкции по установке на сайте Amazon.

PostgreSQL

Хотя это не рекомендуется для высоконагруженных случаев, можно запустить PostgreSQL на той же машине, на которой будет работать ТестОпс. Чтобы установить его, выполните следующие команды в терминале:

wget -q -O- https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo gpg --dearmor --output /usr/share/keyrings/pgdg.gpg
echo "deb [signed-by=/usr/share/keyrings/pgdg.gpg] http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
sudo apt update
sudo apt install -y postgresql-15

Более подробная информация доступна в инструкции по установке на сайте PostgreSQL.

Независимо от варианта развертывания сервера PostgreSQL, обязательно войдите на этот сервер и подготовьте базу данных для ТестОпс.

RabbitMQ

Чтобы установить RabbitMQ, выполните следующие команды в терминале:

wget -q -O- https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/setup.deb.sh | sudo bash
sudo apt install -y socat logrotate erlang
wget https://github.com/rabbitmq/rabbitmq-server/releases/download/v3.13.2/rabbitmq-server_3.13.2-1_all.deb -O rabbitmq-server.deb
sudo dpkg -i rabbitmq-server.deb
sudo systemctl enable rabbitmq-server
sudo systemctl start rabbitmq-server

Более подробная информация доступна в инструкции по установке на сайте RabbitMQ.

Redis

Чтобы установить Redis, выполните следующие команды в терминале:

wget -q -O- https://packages.redis.io/gpg | sudo gpg --dearmor --output /usr/share/keyrings/redis-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
sudo apt update
sudo apt install -y redis

Более подробная информация доступна в инструкции по установке на сайте Redis.

Установка ТестОпс

Пакеты ТестОпс распространяются через репозиторий, который требует аутентификации. Если у вас есть пробная или коммерческая лицензия на ТестОпс, вы должны были получить имя пользователя и пароль в том же письме, в котором вы получили лицензионный ключ. Если вы не можете найти их, свяжитесь с нами по адресу [email protected].

Получив логин и пароль, установите пакет ТестОпс:

Откройте терминал.
Если вы не root-пользователь, введите команду sudo su и пароль для получения прав администратора.

Импортируйте публичный ключ реестра qatools, выполнив команды:

curl -s https://pub.qatools.ru/qatools.gpg | gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/qatools.gpg --import
chmod 644 /etc/apt/trusted.gpg.d/qatools.gpg

Выполните команду (скопируйте все строки):

cat << EOF >> /etc/apt/sources.list.d/qatools.list
deb [trusted=yes] https://dl.qatools.ru/repository/debian stable main
EOF

Убедитесь, что нужный для установки файл был обновлен:
```
cat /etc/apt/sources.list.d/qatools.list
```
Замените параметры USERNAME и PASSWORD на учетные данные, которые вам прислали при покупке лицензии ТестОпс, и выполните команду (скопируйте все строки):
```
cat << EOF >> /etc/apt/auth.conf.d/qatools.conf
machine dl.qatools.ru login USERNAME password PASSWORD
EOF
```
Убедитесь, что нужный для установки файл был обновлен:
```
cat /etc/apt/auth.conf.d/qatools.conf
```
Перезапустите терминал для применения выполненных настроек.
Обновите индекс доступных пакетов:
```
sudo apt update
```
Выберите версию ТестОпс для установки. Список доступных версий указан в разделе Информация о релизах. Мы рекомендуем использовать только последнюю доступную версию, так как она содержит новые возможности и улучшения в ТестОпс, а также исправления ошибок.

Скопируйте и выполните эту команду целиком, а не ее строки по отдельности. Перед выполнением команды замените 5.7.0 на версию ТестОпс, которую вы хотите использовать.
```
cat <<EOF | sudo tee /etc/apt/preferences.d/qatools
Package: testops
Pin: version 5.7.0
Pin-Priority: 1000
EOF
```
Установите пакет ТестОпс.
```
sudo apt install -y testops
```
Если вы используете межсетевой экран, убедитесь, что входящий трафик на TCP-порт 8080 разрешен.

Если вы используете ufw, выполните команду:
```
sudo ufw allow 8080/tcp
```

Изменение файлов конфигурации

Параметры конфигурации задаются в файле конфигурации /opt/testops/conf/testops.conf.

Чтобы изменить параметры, откройте файл в текстовом редакторе, измените нужные значения и сохраните его. После этого перезапустите ТестОпс, чтобы применить изменения.

Важно

Для изменения файла конфигурации необходимо использовать права суперпользователя. Один из способов изменить его с такими правами - выполнить команду sudo nano в терминале:

sudo nano /opt/testops/conf/testops.conf

Для стандартной настройки выполните следующее:

настройте URL-адрес ТестОпс,
добавьте ключ шифрования для конфиденциальных данных,
добавьте адрес электронной почты первого администратора,
настройте аутентификацию,
настройте сервисы хранения данных.

Настройка URL-адреса ТестОпс

В параметре ALLURE_ENDPOINT укажите URL, который должен использоваться для доступа к веб-интерфейсу ТестОпс.

ALLURE_ENDPOINT=https://testops.example.com/

Инфо

Чтобы ТестОпс был доступен через HTTPS, необходимо настроить обратный прокси-сервер.

Чтобы интеграция ТестОпс с Jira работала корректно, необходимо использовать HTTPS и включить передачу безопасных файлов cookie:

ALLURE_SECURE=true

Настройка ключа шифрования для конфиденциальных данных

В качестве меры безопасности ТестОпс шифрует наиболее важные значения в своей базе данных с помощью алгоритма AES256. Таким образом, если злоумышленник получит доступ к базе данных PostgreSQL, но не к файлу конфигурации, это не повлияет на учетные данные других служб, используемых при развертывании.

Для AES256 требуется ключ шифрования. Чтобы установить ключ шифрования, измените значение параметра ALLURE_CRYPTO_PASSWORD:

ALLURE_CRYPTO_PASSWORD='encryption_key'

Храните ключ шифрования в надежном месте.

Важно

Если значение параметра ALLURE_CRYPTO_PASSWORD будет утеряно или изменено после первоначального развертывания, все ранее настроенные интеграции перестанут работать. В этом случае вам нужно будет зайти в настройки каждого проекта и заново ввести правильные учетные данные.

Настройка почты для первого администратора

Начиная с версии 5.4.0 необходимо настроить учетные данные SMTP во время установки. Начиная с версии 5.6.0, первый запуск ТестОпс невозможен без использования настроенного SMTP-сервера.

ТестОпс будет использовать учетные данные SMTP для отправки пригласительного письма первому администратору независимо от выбранного основного метода аутентификации. Адрес электронной почты администратора должен быть указан в параметре ALLURE_MAIL_ROOT.

Ниже приведен пример параметров для учетной записи Gmail. Обратите внимание, что Google требует генерировать специальные пароли приложений для SMTP при включенной двухфакторной аутентификации. Другие почтовые службы, например Яндекс Почта, могут предъявлять аналогичные требования.

SPRING_MAIL_HOST=smtp.gmail.com
SPRING_MAIL_PORT=465
SPRING_MAIL_USERNAME=[email protected]
SPRING_MAIL_PASSWORD=Ohku6Zo9gee5aetyun0
ALLURE_MAIL_FROM=[email protected]
SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_REQUIRED=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_ENABLE=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_TRUST=smtp.gmail.com

#...

ALLURE_MAIL_ROOT=[email protected]

Настройка аутентификации

Необходимый шаг при развертывании ТестОпс - настройка того, как пользователи (кроме первого администратора) будут регистрироваться и входить в систему.

Ниже приведены примеры конфигурации для различных провайдеров идентификационных данных.

Аутентификация с помощью имени пользователя и пароля
LDAP
OpenID

Этот вариант аутентификации требует включенного SMTP. Дополнительная настройка не требуется.

# Example of using LDAP
ALLURE_LOGIN_PRIMARY=ldap
ALLURE_LOGIN_LDAP_ENABLED='true'
ALLURE_LOGIN_LDAP_REFERRAL=follow
ALLURE_LOGIN_LDAP_URL=ldap://ldap.url.here:port
# ALLURE_LOGIN_LDAP_USERDNPATTERNS= do not use with ALLURE_LOGIN_LDAP_USERSEARCHFILTER
ALLURE_LOGIN_LDAP_USERSEARCHBASE="ou=People,dc=space"
ALLURE_LOGIN_LDAP_USERSEARCHFILTER="uid={0}"
ALLURE_LOGIN_LDAP_DEFAULTROLE=${LDAP_DEFAULT_ROLE}
ALLURE_LOGIN_LDAP_UIDATTRIBUTE=uid
ALLURE_LOGIN_LDAP_SYNCROLES='true'
# these are to be enabled if ALLURE_LOGIN_LDAP_SYNCROLES='true'
ALLURE_LOGIN_LDAP_GROUPSEARCHBASE="ou=group,dc=space"
ALLURE_LOGIN_LDAP_GROUPSEARCHFILTER="memberUid={1}"
ALLURE_LOGIN_LDAP_GROUPROLEATTRIBUTE=cn

ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEUSERGROUPS=group_with_ato_users,every_user_is_user
ALLURE_LOGIN_LDAP_GROUPAUTHORITIES_ROLEADMINGROUPS=group_with_ato_admins,every_user_is_admin
# service account data to log-in to LDAP
ALLURE_LOGIN_LDAP_USERDN="cn=admin,dc=space"
ALLURE_LOGIN_LDAP_PASSWORD='ServiceAccountPasswordHere'
# additional parameters, can be disabled by default
# ALLURE_LOGIN_LDAP_LOWERCASEUSERNAMES=true
# ALLURE_LOGIN_LDAP_PASSWORDATTRIBUTE=userPassword

Чтобы использовать OpenID IdP, вам нужно добавить значения в строки, указанные ниже, в соответствии с настройками ТестОпс и провайдера идентификационных данных.

# OpenId settings
# The text ID for the SSO provider. Will be used in URLs and displayed on the login buttons.
# Don't use whitespaces and special characters
# You can use array of different providers using different oauth2:
# SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_<PROVIDER_NAME>_... + SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_<PROVIDER_NAME>_...
########################################################################################
ALLURE_LOGIN_PRIMARY=openid
ALLURE_LOGIN_OPENID_DEFAULTROLE=ROLE_GUEST
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTNAME=openid
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTID=<as defined in your IdP>
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTSECRET=<as defined in your IdP>
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_REDIRECTURI=http://<your-testops-domain>/login/oauth2/code/openid
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_SCOPE=openid,email,profile
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_AUTHORIZATIONGRANTTYPE=authorization_code
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_AUTHORIZATIONURI=http://<open_id_provider_url>/somepath/auth
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_USERNAMEATTRIBUTE=preferred_username
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_JWKSETURI=http://<open_id_provider_url>/somepath/keys
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_TOKENURI=http://<open_id_provider_url>/somepath/token

Настройка сервисов хранения данных

Чтобы подключиться к сервисам хранения данных, которые используются в ТестОпс, определите параметры для:

подключения к серверу хранения данных Redis:
- SPRING_DATA_REDIS_HOST — имя хоста сервера;
- SPRING_DATA_REDIS_PORT — порт сервера;
- SPRING_DATA_REDIS_PASSWORD — пароль для подключения к хранилищу.
подключения к базе данных PostgreSQL:
- SPRING_DATASOURCE_URL — локация базы данных в формате JDBC URL;
- SPRING_DATASOURCE_USERNAME — имя пользователя для подключения к базе данных;
- SPRING_DATASOURCE_PASSWORD — пароль для подключения к базе данных.
подключения к серверу RabbitMQ:
- SPRING_RABBITMQ_HOST — имя хоста сервера;
- SPRING_RABBITMQ_PORT — порт сервера;
- SPRING_RABBITMQ_USERNAME — имя пользователя для подключения к очереди сообщений;
- SPRING_RABBITMQ_PASSWORD — пароль для подключения к очереди сообщений.
подключения к серверу хранения данных, совместимому с S3:
- ALLURE_BLOBSTORAGE_S3_ENDPOINT — URL-адрес сервера;
- ALLURE_BLOBSTORAGE_S3_BUCKET — название бакета S3;
- ALLURE_BLOBSTORAGE_S3_REGION — название региона S3;
- ALLURE_BLOBSTORAGE_S3_ACCESSKEY — ключ доступа для подключения к бакету;
- ALLURE_BLOBSTORAGE_S3_SECRETKEY — секретный ключ для подключения к бакету.

Некоторые дополнительные параметры могут быть изменены для тонкой настройки производительности или поддержки нестандартных конфигураций сервисов хранения. Проверьте комментарии в файле testops.conf и при необходимости проконсультируйтесь со службой технической поддержки ТестОпс.

Первый запуск ТестОпс

При первом запуске ТестОпс необходимо ввести лицензионный ключ, который вы получили по электронной почте во время покупки лицензии. Для этого выполните действия:

Откройте терминал.
Перезапустите службы, чтобы применить изменения в файле конфигурации.
```
sudo systemctl restart testops
```
Перезапуск всех сервисов ТестОпс займет некоторое время. Дождитесь завершения перезапуска, прежде чем переходить к следующему шагу.
После запуска инстанса ТестОпс вам придет письмо с приглашением на адрес, который вы указали в ALLURE_MAIL_ROOT. В полученном письме нажмите Принять приглашение.

К сведению
Если в браузере появляется ошибка «Невозможно подключиться» (“Unable to connect”) или «Сайт недоступен» (“This site can't be reached”), это может означать, что некоторые сервисы все еще инициализируются.
Если через пять минут браузер все еще не может открыть страницу, см. раздел Устранение неполадок.
В форме принятия приглашения введите полное имя администратора и учетные данные, которые будут использоваться для входа в систему: Имя пользователя и Пароль. Нажмите Продолжить.

Важно
Имя пользователя должно быть уникальным в рамках вашего инстанса ТестОпс.
В форму активации введите лицензионный ключ, который вы получили при покупке лицензии ТестОпс. Убедитесь, что лицензионный ключ скопирован и введен без лишних пробелов и других символов. Нажмите Активировать лицензию.

Управление сервисами ТестОпс

Запуск сервисов

Чтобы запустить ТестОпс, в терминале выполните команду:

sudo systemctl start testops

Остановка сервисов

Чтобы остановить ТестОпс, в терминале выполните команду:

sudo systemctl stop testops

Перезапуск сервисов services

Чтобы перезапустить ТестОпс, в терминале выполните команду:

sudo systemctl restart testops

Обновление ТестОпс

Важно

Ознакомьтесь с release notes для версии ТестОпс, на которую вы переходите. В примечаниях к релизу может содержаться важная информация о том, как адаптировать ваши существующие файлы конфигурации или перенести данные в новую версию ТестОпс. Если вы пропускаете одну или несколько версий, прочитайте также примечания к релизам для пропущенных версий.

Откройте терминал.
Обновите параметр, указывающий версию пакета для установки.

Перед выполнением команды замените 5.7.0 на версию, до которой вы обновляетесь. После этого скопируйте и выполните эту команду целиком, а не ее строки по отдельности:
```
cat <<EOF | sudo tee /etc/apt/preferences.d/qatools
Package: testops
Pin: version 5.7.0
Pin-Priority: 1000
EOF
```
Обновите индекс доступных пакетов.
```
sudo apt update
```
Переустановите пакет.
```
sudo apt install -y testops
```
При необходимости измените файлы конфигурации согласно информации из release notes.
Перезапустите ТестОпс.
```
sudo systemctl restart testops
```

Удаление ТестОпс

Чтобы удалить инстанс ТестОпс, выполните следующие действия:

Откройте терминал.
Удалите пакеты ТестОпс:
```
sudo apt autoremove testops-*
```
Удалите файлы конфигурации:
```
sudo rm -rf /opt/testops
```

Устранение неполадок

Если вы столкнулись с проблемой, не перезапускайте ТестОпс. Специалистам технической поддержки нужны лог-файлы каждого компонента, чтобы понять, что произошло.

Создайте образение в техподдержку, используя корпоративный адрес электронной почты. Для этого перейдите в хэлп-деск ТестОпс, нажмите Создать обращение и заполните форму:

Подробно опишите проблему, с которой вы столкнулись.
Укажите способ установки и версию ТестОпс, а также всех дополнительных компонентов, с которыми у вас возникли проблемы (allurectl, интеграционные плагины и т. д.).
Приложите логи из вашей системы в качестве вложений к обращению (см. подробности ниже). Пожалуйста, добавляйте только логи, описанные ниже, и только в виде вложения.

journalctl -f -n 100 -u testops

где:

f - следить за журналом, т.е. все новые строки будут показаны на экране
n 100 - количество записей в журнале для отображения
u name - название единицы измерения

Получение логов

По умолчанию все компоненты пишут логи в stdout. Получить логи можно с помощью journalctl:

journalctl --no-tail -u testops > testops.log

Миграция с ТестОпс версии 4.x​

Подготовительные шаги для установки ТестОпс версии 5.x «с нуля»​

Установка зависимостей​

Amazon Corretto​

PostgreSQL​

RabbitMQ​

Redis​

Установка ТестОпс​

Изменение файлов конфигурации​

Настройка URL-адреса ТестОпс​

Настройка ключа шифрования для конфиденциальных данных​

Настройка почты для первого администратора​

Настройка аутентификации​

Настройка сервисов хранения данных​

Первый запуск ТестОпс​

Управление сервисами ТестОпс​

Запуск сервисов​

Остановка сервисов​

Перезапуск сервисов services​

Обновление ТестОпс​

Удаление ТестОпс​

Устранение неполадок​

Получение логов​

Миграция с ТестОпс версии 4.x

Подготовительные шаги для установки ТестОпс версии 5.x «с нуля»

Установка зависимостей

Amazon Corretto

PostgreSQL

RabbitMQ

Redis

Установка ТестОпс

Изменение файлов конфигурации

Настройка URL-адреса ТестОпс

Настройка ключа шифрования для конфиденциальных данных

Настройка почты для первого администратора

Настройка аутентификации

Настройка сервисов хранения данных

Первый запуск ТестОпс

Управление сервисами ТестОпс

Запуск сервисов

Остановка сервисов

Перезапуск сервисов services

Обновление ТестОпс

Удаление ТестОпс

Устранение неполадок

Получение логов