Установка#

Состав дистрибутива#

Подготовка окружения#

Настройка окружения хостов#

1. Установите на node 3 PostgreSQL server или используйте внешний с известными параметрами подключения.

2. Модифицируйте файл /etc/hosts на всех машинах развертывания: укажите HOST_1 под псевдонимом ssd-cloud и добавьте доменные имена серверов Kafka.

3. Создайте keystore (JKS) с сертификатами для взаимодействия с Kafka. В случае, если для соединения с Kafka не требуются сертификаты, сгенерируйте пустой keystore.

4. Создайте пользователя и группу для запуска сервисов (в дальнейшем они будут помещены в переменные SSD_LAUNCH_USER/SSD_LAUNCH_GROUP).

5. Сконфигурируйте переменные среды для развертывания и запуска сервисов (см. раздел Настройка переменных среды развертывания).

6. Сконфигурируйте системные ограничения ресурсов. Если для среды развертывания нет точного представления об ожидаемом уровне нагрузки, то во избежание возможных блокировок рекомендуется снять эти лимиты и удалить файл /etc/security/limits.d/50-defaults.conf со значениями по умолчанию.

7. Проинициализируйте БД.

   За инициализацию БД отвечает ssd-transaction-manager, который запускается первым среди core-компонентов SSD.
   С помощью Liquibase имеющаяся структура БД проверяется на соответствие требуемой схеме данных.

   В случае необходимости предварительной настройки схемы данных можно использовать SQL-скрипты в формате Liquibase, расположенные в архиве в дистрибутиве по пути: package/db/init/*-dbinit-<version>-distrib.zip.

Настройка компонента ssd-cloud-config#

Компонент ssd-cloud-config, который построен на базе Spring Cloud Config, является единой точкой входа для конфигурирования компонентов OneWork.

В качестве источников конфигураций компонентов, обращающихся к ssd-cloud-config могут выступать:

• Git-репозиторий (профиль git)

  Данный профиль настраивается с помощью параметров группы SSD_CLOUD_CONFIG_GIT_*. В этом режиме поиск осуществляется в ветке репозитория. При поиске ожидается конфигурационный файл, именованный по шаблону <имя_компонента>-<профиль>.yml.

• Файловая система хостовой машины, на которой развернут ssd-cloud-config (профиль native)

  С помощью параметра SSD_CLOUD_CONFIG_NATIVE_SEARCH_PATH настраивается корень для поиска конфигурационных файлов. Соглашение об именовании аналогично профилю git.

Профиль git имеет более высокий приоритет. Используя переменную SSD_CLOUD_CONFIG_PROFILES, можно выборочно активировать профили.

Подготовка параметров конфигурации среды развертывания#

Конфигурационные файлы Spring с расширением .yml позволяют определять значения с использованием переменных среды. В OneWork в качестве источника значений переменных используется единый файл ssd_deployment_env.

Все параметры делятся на 2 группы: параметры скриптов развертывания и конфигурации сервисов.

Параметры скриптов развертывания#

Переопределить можно только значения переменных с неподходящими значениями по-умолчанию.

Параметры конфигурации сервисов#

Выбор способа установки#

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

Ручная установка сервиса#

1. Настройте среду для развертывания OneWork согласно разделу Подготовка окружения.

2. Скачайте и распакуйте дистрибутив целевой версии OneWork на все хосты.

3. Настройте переменные среды развертывания. Значения, определенные при подготовке окружения (см. раздел Подготовка параметров конфигурации среды развертывания), необходимо перенести в файл package/conf/deployment/ssd_deployment_env. Значения из этого файла передаются в среду исполнения скриптов развертывания и скрипта-обертки запуска сервисов start.sh с помощью команды source.

4. На каждом из хостов запустите сервисы с помощью скрипта автоматизации развертывания. В качестве аргументов скрипт принимает:

   • имя среды (назначение) конкретного хоста:

     • INFRA - на сервере core-компонентов;

     • SERVICE - на сервере адаптеров;

     • ALL (по умолчанию, если значение не указано) - все сервисы запустятся на единственной машине.

   • абсолютный путь до keystore с сертификатами для взаимодействия с Kafka.

   Обратите внимание
   Запуск скрипта необходимо производить от имени пользователя, который обладает root-правами.

   bash /\<unpack-dir\>/package/bh/shell/deploy-standalone.sh INFRA  # нода 1
   

   bash /\<unpack-dir\>/package/bh/shell/deploy-standalone.sh SERVICE /tmp/kafka.jks # нода 2
   

   Скрипт автоматизирует следующие действия:

   • создание корневой директории развертывания;

   • создание папок для логирования активности сервисов;

   • перенос в корень развертывания:

     • конфигураций сервисов

     • исполняемых JAR-файлов

     • shell-скриптов: обертки запуска сервисов start.sh и скрипта удаления развертывания delete-deployment.sh

   • перенос конфигурации и распаковку статического контента UI в директорию nginx (/etc/nginx).

   • перенос Kafka кейстора в сконфигурированное местоположение

   • создание символьных ссылок на systemd юниты в /etc/systemd/system и запуск сервисов через systemctl

   При возникновении критических ошибок в процессе развертывания соответствующее сообщение будет выведено на экран, и процесс прервется.

5. Для корректного функционирования UI заполните следующие свойства, воспользовавшись сервисом ssd-ui-admin.

   Имя параметра	Описание	Пример
   app.host.url	URL UI SSD с протоколом	http://${HOST_1}:3000
   app.core-data.version	версия серверной части SSD	2
   app.core-data-v2.url	URL сервиса ssd-core-data с протоколом	http://${\HOST_1}:28888

   Выполните POST запрос к endpoint ${HOST_1}:28886/v2/properties/{key}, в теле запроса текстом передайте значение параметра. Можно воспользоваться Swagger UI сервиса: ${HOST_1}:28886/swagger-ui/index.html.

6. После окончания установки можно переходить к проверке работоспособности OneWork.