3.1. С использованием docker-compose

3.1.1. Необходимая информация и параметры

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

3.1.1.1. Учетная запись клиента для подсоединения к репозиториям Разработчика

  • Перед началом установки ПО запросите у Разработчика данные учетной записи для проведения Экспертной проверки;

  • Запрос направьте по адресу: support@tantorlabs.ru или используйте контактный номер телефона: +7 495 787 51 78;

  • Необходимо передать адрес электронной почты, на который будут переданы имя пользователя и пароль для подсоединения к репозиториям Разработчика.

Примечание

Данные учетной записи Заказчика строго конфеденциальны.

3.1.1.2. Начальный пароль для входа в ПО

  • В дополнение к данным учетной записи Разработчик передаст пароль по умолчанию для подключения к ПО, используемый владельцем системы при первом подключении;

  • Пароль по умолчанию необходимо сменить при первом подключении владельца системы к ПО.

3.1.1.3. Данные владельца системы

  • Имя владельца ПО, например Administrator;

  • Адрес электронной почты владельца ПО, например dba@example.ru Будет использоваться владельцем при подключении к ПО.

3.1.1.4. Данные почтового сервера для пересылки сообщений

  • Адрес почтового сервера для пересылки сообщений, генерируемых ПО, например smtp.gmail.com;

  • Порт почтового сервера, например 587;

  • Адрес электронной почты пользователя почтового сервера для подключения ПО к почтовому серверу. Адрес электронной почты не должен совпадать с адресом электронной почты владельца ПО;

  • Пароль электронной почты пользователя почтового сервера для подключения ПО к почтовому серверу.

3.1.1.5. Создание DNS записей

Работа пользователей с ПО осуществляется по защищенному протоколу HTTP(S). Для этого необходимо создать или использовать существующее доменное имя, по которому будет осуществляться подключение.

3.1.1.6. Открытие портов

Для корректной работы платформы следующие порты должны быть открыты:

  • 80

  • 443

  • 4200

  • 4222

  • 5666

  • 7777

  • 8443

На машине, где будет установлен агент, требуется открыть порт 443 в сторону платформы.

3.1.2. Установка необходимых компонентов

Все команды следует выполнять из-под пользователя root или любого другого, имеющего права sudo.

Предупреждение

В случае установки на ОС Astra Linux версии «Смоленск» или «Воронеж» с включенным режимом мандатного контроля целостности потребуется выполнять команды из-под пользователя с высоким уровнем целостности. Проверить уровень целостности можно командой:

pdp-id
  1. Добавьте официальный репозиторий docker и установите необходимые пакеты:

  1. Запустите службу docker:

    systemctl start docker
    
  2. Гарантируйте автоматический запуск службы docker после перезагрузки сервера:

    systemctl enable docker
    
  3. Скачайте docker-compose из официального репозитория:

    curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    
  4. Измените права доступа файла /usr/local/bin/docker-compose:

    chmod +x /usr/local/bin/docker-compose
    
  5. В директории /opt создайте директории tantor/eco, а под директорией eco поддиректории для размещения требуемых для работы ПО артефактов:

    • nats-data - для расположения артефактов работы брокера сообщений;

    • nginx - для расположения артефактов работы веб сервера;

    • nginx/ssl - для расположения SSL сертификатов.

    mkdir -p /opt/tantor/eco/nats-data /opt/tantor/eco/nginx/ssl
    
  1. В директорию /opt/tantor/eco/nginx/ssl поместите SSL сертификаты. Сертификаты должны подходить доменному имени, созданному в пункте Создание DNS записей. Их названия будут необходимы далее в процедуре настройки и запуска ПО. Необходимые файлы:

    • Цепочка сертификатов (сертификат сервера, сертификат промежуточных звеньев, корневой сертификат);

    • Закрытый (приватный) ключ.

Примечание

Для удобства тестирования ПО Разработчик приготовил самоподписанный сертификат для доменного имени dummy.test.ru.

Предупреждение

  • Данные сертификаты предоставляются на основе принципа “как есть” и только для локального тестирования ПО;

  • Не используйте предоставленные сертификаты в производственной среде;

  • Разработчик не несет никакой ответственности за любые повреждения и убытки, включая потерю дохода, нанесенные прямым или непрямым, специальным или случайным использованием предоставленных сертификатов.

Используйте следующие команды для скачивания, размещения и использования тестовых сертификатов:

curl -k https://public.tantorlabs.ru/certificate.pem -o /opt/tantor/eco/nginx/ssl/certificate.pem
curl -k https://public.tantorlabs.ru/key.pem -o /opt/tantor/eco/nginx/ssl/key.pem
  1. Скачайте docker-compose.yml из репозитория Разработчика в директорию /opt/tantor:

    curl -k https://public.tantorlabs.ru/docker-compose.yml.1.12.0  -o /opt/tantor/eco/docker-compose.yml
    

3.1.3. Конфигурация docker-compose.yml

Перед первым запуском ПО необходимо сконфигурировать файл docker-compose.yml. Замените местозаполнители в оригинальном файле docker-compose.yml их необходимыми значениями и сохраните файл. Ниже приведены местозаполнители в оригинальном файле и их необходимые значения.

Предупреждение

  • Все перечисленные параметры являются обязательными;

  • ПО не будет корректно установлено при неустановке или неправильном использовании значений перечисленных параметров.

3.1.3.1. <YOUR_DOMAIN>

Доменное имя для подключения пользователей к платформе (имя создается в пункте Создание DNS записей).

dummy.test.ru - при использовании сертификатов, приготовленных Разработчиком.

Может быть заменен следующей командой:

sed -i 's=<YOUR_DOMAIN>=dummy.test.ru=g' /opt/tantor/eco/docker-compose.yml

3.1.3.2. <YOUR_SSL_CERT>*

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

certificate.pem - при использовании сертификатов, приготовленных Разработчиком.

Может быть заменен следующей командой:

sed -i 's=<YOUR_SSL_CERT>=certificate.pem=g' /opt/tantor/eco/docker-compose.yml

3.1.3.3. <YOUR_SSL_CERT_KEY>

Имя файла (файл создается на шаге 7 в пункте Установка необходимых компонентов), содержащего закрытый (приватный) ключ сертификата.

key.pem - при использовании сертификатов, приготовленных Разработчиком.

Может быть заменен следующей командой:

sed -i 's=<YOUR_SSL_CERT_KEY>=key.pem=g' /opt/tantor/eco/docker-compose.yml

3.1.3.4. <YOUR_SECRET_TOKEN>

Случайный ключ, минимум 13 символов.

Может быть заменен следующей командой:

SECRET_TOKEN=$(date +%s | sha256sum | base64 | head -c 16 ; echo) && sed -i -e "s/<YOUR_SECRET_TOKEN>/$SECRET_TOKEN/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.5. <YOUR_DB_PASSWORD>

Пароль пользователя БД, используемый приложением для работы с БД.

Может быть заменен следующей командой:

PASSWORD=$(date +%s | sha256sum | base64 | head -c 16 ; echo) && sed -i -e "s/<YOUR_DB_PASSWORD>/$PASSWORD/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.6. <YOUR_EMAIL_HOST>

Адрес почтового сервера, для пересылки сообщений, генерируемых ПО, например smtp.gmail.com.

Может быть заменен следующей командой:

sed -i -e "s/<YOUR_EMAIL_HOST>/smtp.gmail.com/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.7. <YOUR_EMAIL_PORT>

Порт почтового сервера, например 587.

Может быть заменен следующей командой:

sed -i -e "s/<YOUR_EMAIL_PORT>/587/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.8. <YOUR_EMAIL_USERNAME>

Адрес электронной почты пользователя почтового сервера для подключения ПО к почтовому серверу. Замените your.email@gmail.com на свой вариант электронной почты:

sed -i -e "s/<YOUR_EMAIL_USERNAME>/[email protected]/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.9. <YOUR_EMAIL_PASSWORD>

Пароль электронной почты пользователя почтового сервера для подключения ПО к почтовому серверу. Замените *** на пароль от электронной почты, указанной в пункте <YOUR_EMAIL_USERNAME>:

sed -i -e "s/<YOUR_EMAIL_PASSWORD>/***/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.10. <OWNER_NAME>

Имя владельца ПО, например Administrator.

Может быть заменен следующей командой:

sed -i -e "s/<OWNER_NAME>/Administrator/" "/opt/tantor/eco/docker-compose.yml"

3.1.3.11. <OWNER_EMAIL>

Адрес электронной почты владельца ПО, например dba@example.ru.

Может быть заменен следующей командой:

sed -i -e "s/<OWNER_EMAIL>/[email protected]/" "/opt/tantor/eco/docker-compose.yml"

Команды для запуска ПО содержатся в разделе Запуск ПО.