Установка, настройка и запуск программы

Данная инструкция описывает, как развернуть и настроить Business Studio 7 в Docker–среде, а также установить десктопное приложение для задач администрирования и кастомизации при необходимости. Здесь приведены все необходимые шаги: подготовка сервера, настройка DNS и сертификатов, заполнение файла .env, конфигурация appsettings.json, запуск контейнеров и базовая проверка работы сервисов.

Данная инструкция предназначена для тех, кто устанавливает Business Studio 7 впервые или обслуживает уже работающий стенд. В инструкции содержатся примеры команд, разбор ключевых параметров и подсказки по диагностике Keycloak, OpenSearch, Kafka UI и других компонентов, что поможет облегчить запуск и решить типовые проблемы.

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

Для развертывания необходима квалификация в областях системного администрирования и/или DevOps.

В рамках установки Business Studio 7 предусмотрено два варианта развертывания:

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

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

1. Установка с помощью инсталлятора

Инсталлятор предназначен для автоматизированного развертывания Business Studio 7 в Docker Compose-окружении.

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

При выполнении данной команды автоматически:

будет создана папка в текущей директории;
внутрь неё из репозитория GitLab Business Studio будут загружены файлы bs_setup.sh (основной установочный скрипт), bs_menu.sh (меню администрирования) и eula.md (лицензионное соглашение);
файлам bs_setup.sh и bs_menu.sh будут назначены права на выполнение;
будет автоматически запущен bs_setup.sh — основной установочный сценарий.

Перед запуском инсталлятора необходимо выполнить подготовку окружения:

проверить соответствие окружения согласно разделу Настройка окружения;
подготовить DNS-имена и сертификаты согласно разделу Создание DNS-имен и сертификатов;
если планируется авторизация пользователей через LDAP / Active Directory, заранее подготовить параметры подключения:
- адрес сервера LDAP;
- порт (по умолчанию 389, для LDAPS обычно 636);
- использование SSL/TLS (LDAPS);
- логин служебной учётной записи (service account) для подключения;
- пароль служебной учётной записи.

Если LDAP не используется — этот шаг можно пропустить в процессе установки и настроить позже вручную через веб-интерфейс Keycloak и файл appsettings.json.

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

Docker;
Docker Compose;
curl;
openssl;
awk;
sed;
unzip;
python3.

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

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

Поддержка кластерного развертывания Business Studio 7 предусмотрена, однако такая конфигурация не является частью типового сценария установки и не настраивается автоматически инсталлятором.

2. Ручная установка и настройка

Для выполнения дополнительной ручной настройки ранее развернутого инсталлятором (см. Установка с помощью инсталлятора) стенда Business Studio 7 выполните следующие шаги:

Также рекомендуется ознакомиться с разделами:

Архитектурная реализация и кастомизация — описание возможностей изменения стандартной конфигурации и настройки системы под требования конкретного окружения.
Дополнительная техническая информация — дополнительные сведения о компонентах системы и особенностях эксплуатации.
Кластерное развертывание рекомендуется использовать для высоконагруженных систем, где требуется повышение производительности, масштабирование и обеспечение отказоустойчивости.

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

распределение сервисов между отдельными контейнерами или узлами;
настройка балансировки нагрузки;
ограничение ресурсов контейнеров (CPU, RAM);
настройка сетевого взаимодействия между компонентами;
дополнительные настройки инфраструктуры и хранения данных.

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

В случае возникновения ошибок обратитесь к разделу Возможные ошибки и их исправление.

Внимание! При выходе новой версии Business Studio требуется обновление установленных компонентов. Подробная инструкция по обновлению системы приведена в разделе Обновление программы.

В этом подразделе

¹⁾

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

²⁾

Выполняйте данные рекомендации только в случае, если указанное в статье ПО было установлено вручную, а не автоматически в рамках типового развертывания Business Studio (см. Программные требования).