Развертывание BPMSoft через Docker на Linux

В BPMSoft, начиная с версии 1.7, есть возможность развернуть приложение с использованием Docker-образа.

Таблица 1 — Ограничения к веб-серверу и серверу базы данных

Подготовка к развертыванию BPMSoft

Перед развертыванием BPMSoft через Docker выполните следующие шаги:

1. Разархивируйте в любое удобное место архив с файлами для развертывания приложения в Docker.

2. Настройте источник образов. Авторизуйтесь на ресурсе repo.bpmsoft.ru, используя команду:

docker login repo.bpmsoft.ru

3. Запустите скрипт init.sh, который подготавливает конфигурацию BPMSoft и параметризует docker-compose.yml. Скрипт находится в папке с файлами для развертывания приложения.

#Перейдите в директорию deploy внутри проекта
cd deploy

#Установите права на исполнение для скрипта init.sh
chmod +x init.sh
 
#Запустите скрипт
./init.sh

Во время выполнения скрипта он запросит несколько параметров, необходимых для корректной конфигурации приложения. Подробнее: Конфигурирование BPMSoft.

Конечным итогом выполнения скрипта init.sh будет создание файла .env, который содержит значения переменных для docker-compose.yml. Также будут внесены необходимые изменения в конфигурационные файлы приложения (ConnectionStrings.config, appsettings.json) и сформирован самоподписанный сертификат.

После выполнения скрипта можно перейти к установке BPMSoft через Docker.

Конфигурирование BPMSoft

После запуска скрипта init.sh пользователю последовательно будут заданы вопросы, позволяющие сформировать конфигурацию приложения BPMSoft.

Выбор образа

Формулировка вопроса: «Введите название образа. Формат: [Image]:[Tag]».

Введите название образа и тег в формате [Image]:[Tag], где Image — тип сборки, Tag — версия.

Доступные образы можно посмотреть в реестре Docker-образов в ресурсе repo.bpmsoft.ru.

Ввод порта приложения

Формулировка вопроса: «Введите порт приложения».

Укажите порт хоста для доступа к приложению.

Настройка подключения по HTTP/HTTPS

Формулировка вопроса: «Использовать SSL? Да - (y)? Нет - (n)?».

Возможны два варианта ответа:

• y — доступ будет по HTTPS. Далее будет Настройка доступа по HTTPS;
• n — доступ будет по HTTP.

Настройка доступа по HTTPS

Формулировка вопроса: «Сгенерировать самоподписанный сертификат? Да - (y)? Нет - (n)?».

Возможны два варианта ответа:

• y — необходимо будет указать параметры для создания самоподписанного сертификата;

Сгенерировать самоподписанный сертификат? Да - (y)? Нет - (n)? (по умолчанию: y): y
Создаем самоподписанный сертификат...
Введите страну для сертификата (C) (по умолчанию: RU):
Введите регион для сертификата (ST) (по умолчанию: Moscow):
Введите город для сертификата (L) (по умолчанию: Moscow):
Введите организацию для сертификата (O) (по умолчанию: BPMSoft):
Введите отдел для сертификата (OU) (по умолчанию: Dev):
Введите общее имя для сертификата (CN) (по умолчанию: localhost):
Задайте пароль для сертификата (CN) (по умолчанию: PaSsWoRd):

• n — необходимо будет указать путь к файлу сертификата .pfx и его пароль.

Сгенерировать самоподписанный сертификат? Да - (y)? Нет - (n)? (по умолчанию: y): n
Введите пароль от вашего сертификата. Данный пароль будет установлен в appsettings.json (по умолчанию: PaSsWoRd):
Введите путь до вашего сертификата .pfx (по умолчанию: /app/Certificates/localhost.pfx):

Настройка параметров подключения к базе данных

Формулировка вопроса: «Создать контейнер с базой данных? Да - (y)? Нет - (n)?».

Возможны два варианта ответа:

• y — создастся контейнер с PostgreSQL;
• n — необходимо будет указать информацию для подключения к существующей базе данных PostgreSQL.

Создание новых компонентов

Если будет выбран ответ y, система автоматически создаст название базы данных, имя пользователя и пароль. Эти данные будут доступны в файле .env:

• Postgres_DB — название базы данных;
• Postgres_User — имя пользователя базы данных;
• Postgres_Password — пароль пользователя базы данных.

После ввода ответа y необходимо указать путь для хранения файлов базы данных и порт для развертывания базы данных.

Хранение файлов базы данных

Формулировка вопроса: «Введите путь для хранения файлов базы данных».

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

• Если указанная директория отсутствует, скрипт создаст ее автоматически;
• Если директория уже существует и содержит данные, скрипт выведет предупреждение:

Внимание! Директория ./db_data уже существует.
Возможно, ранее уже была выполнена инициализация базы данных по этому каталогу.
Убедитесь, что база данных с именем "bpm", а также пользователь "user" и его пароль "pass" существуют!
Также вы можете переопределить путь к каталогу с базой данных.
Вы действительно хотите оставить текущий каталог базы данных:./db_data - (y)? Или создать новый - (n)?  (по умолчанию: y)

Если необходимо изменить эти параметры, выполните одно из следующих действий:

• Укажите новую директорию для хранения данных базы;
• Удалите существующую директорию (обратите внимание, что для этого могут потребоваться права sudo, например: sudo rm -rf ./db_data).

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

Порт развертывания базы данных

Формулировка вопроса: «Введите порт на котором будет развернута база данных».

Введите порт хоста, по которому будет осуществляться доступ к PostgreSQL

Подключение к существующей базе данных

Если будет выбран ответ n, скрипт задаст вопросы, связанные с настройками базы данных.

Выполнить восстановление резервной копии базы данных? Да - (y)? Нет - (n)? 
Введите адрес хоста с базой данных
Введите название базы данных
Введите имя пользователя базы данных
Введите пароль пользователя базы данных

Восстановление резервной копии базы данных

Формулировка вопроса: «Выполнить восстановление базы данных из резервной копии? Да - (y)? Нет - (n)?».

Возможны два варианта ответа:

• y — будет создан контейнер, который запустит восстановление резервной копии базы данных;
• n — восстановление резервной копии базы данных не будет запущено.

Если база данных пуста, нужно восстановить ее.

Если база данных заполнена и восстановление не требуется, введите значение n.

Заполнение адреса хоста с сервером базы данных

Формулировка вопроса: «Введите адрес на котором развернута база данных».

Укажите адрес хоста, где работает сервер базы данных.

Если сервер базы данных находится на том же хосте, что и Docker, используйте значение host.docker.internal.

Заполнение названия базы данных

Формулировка вопроса: «Введите название базы данных».

Укажите название имеющейся базы данных.

Заполнение имени пользователя базы данных

Формулировка вопроса: «Введите имя пользователя базы данных».

Укажите имя пользователя, имеющего доступ к базе данных из пункта Заполнение названия базы данных.

Заполнение пароля пользователя базы данных

Формулировка вопроса: «Введите пароль пользователя базы данных».

Укажите пароль пользователя из пункта Заполнение имени пользователя базы данных.

Заполнение порта базы данных

Формулировка вопроса: «Введите порт на котором развернута база данных».

Укажите порт хоста, где работает сервер базы данных.

Настройка параметров подключения к серверу кэширования

Формулировка вопроса: «Создать контейнер с сервисом для кэширования?».

Возможны два варианта ответа:

• y — создастся контейнер с Redis, который будет доступен только внутри сети развернутых контейнеров;
• n — необходимо указать информацию для подключения к существующему серверу кэширования Redis.

Подключение к существующему серверу кэширования

Если будет выбран ответ n, скрипт задаст вопросы, связанные с настройками сервера кэширования.

Введите адрес, на котором развернут сервис для кэширования
Введите порт, на котором развернут сервис для кэширования

Заполнение адреса хоста с сервером кэширования

Формулировка вопроса: «Введите адрес, на котором развернут сервис для кэширования».

Укажите адрес хоста, где работает сервер кэширования.

Если сервер кэширования находится на том же хосте, что и Docker, используйте значение host.docker.internal.

Заполнение порта сервера кэширования

Формулировка вопроса: «Введите порт, на котором развернут сервис для кэширования».

Укажите порт хоста, где работает сервер кэширования.

Установка BPMSoft через Docker

Если возникла ошибка при автоматическом запуске контейнеров из init.sh файла можно запустить вручную командой, которая представлена ниже, заменив [Deployment_Files] значением переменной Deployment_Files из файла .env:

docker compose [Deployment_Files] up -d

В зависимости от перечисления docker-compose файлов в переменной Deployment_Files могут быть запущены контейнеры:

• postgres — база данных приложения;
• db-init — временный контейнер, предназначенный для инициализации и восстановления базы данных PostgreSQL;
• redis — сервер кэширования;
• app-init – временный контейнер, предназначенный для копирования конфигурационных файлов BPMSoft на хост;
• bpmsoft — контейнер с приложением BPMSoft.

Контейнеры запускаются в определенном порядке:

• Первыми запускаются контейнеры app-init, postgres и redis;
• Далее, после запуска postgres, запускается контейнер db-init;
• После запуска postgres и redis, и успешного завершения работы app-init и db-init, запускается контейнер bpmsoft.

После успешного копирования конфигурационных файлов BPMSoft на хост и инициализации базы данных контейнеры app-init и db-init завершат работу и останутся три контейнера:

• postgres — база данных приложения;
• redis — сервер кэширования;
• bpmsoft – приложение BPMSoft.

Подождите пока все контейнеры запустятся и успешно пройдут проверку работоспособности (health check).

Рисунок 1 — Запущенные контейнеры

Логирование

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

docker logs [название контейнера]

Логи приложения BPMSoft находятся в папке Logs основного приложения. Подробнее: Логирование NLog

Изменение портов приложения внутри контейнера

При изменении портов приложения внутри контейнера в appsettings.json нужно обновить переменные среды в файле .env в папке deploy:

1. Изменить BPMSoft_Container_Port — указать порт внутри контейнера, через который можно получить доступ к приложению.
2. Добавить или изменить переменные, участвующие в формировании адреса, по котором проходит healthcheck контейнера:
• HealthCheck_BPMSoft_Container_Port — порт внутри контейнера, по которому есть доступ к приложению;
• HealthCheck_BPMSoft_Container_Protocol — протокол, использующий порт из переменной HealthCheck_BPMSoft_Container_Port.

После редактирования файла .env перезапустите контейнер с приложением. Для этого выполните команду в папке deploy, заменив [Deployment_Files] значением переменной Deployment_Files из файла .env:

docker compose [Deployment_Files] up bpm-app -d

Обновление BPMSoft

Описание процесса обновления BPMSoft, развернутого через Docker, представлено в статье Обновление BPMSoft, развернутого через Docker.

Рекомендуем изучить

Системные требования BPMSoft