Руководство по установке#
В руководстве приведены инструкции по установке продукта Synapse Enterprise Integration (SEI).
Термины и определения#
Термин/аббревиатура |
Определение |
|---|---|
SEI |
Synapse Enterprise Integration |
Управление политиками / POLM |
Компонент Управление политиками из состава продукта Platform V Synapse Service Mesh |
Platform V Synapse Service Mesh / SSM |
Программный продукт на базе Istio SE, обеспечивающий возможность создания сервисной сети поверх Платформенной в Kubernetes |
Граничный прокси / IGEG |
Компонент Граничный прокси Platform V Synapse Service Mesh |
Сервисный прокси / SVPX |
Компонент Сервисный прокси Platform V Synapse Service Mesh |
Платформа |
Платформа оркестрации приложений с средствами автоматизации и управления на основе политик, например Kubernetes |
ПО |
Программное обеспечение |
Системные требования#
Настройка окружения#
Настройки безопасности окружения и перечень платформенных (дополнительных внешних) продуктов, используемых для установки, настройки и контроля в конечной информационной системе (далее — ИС), выбираются клиентом при разработке конечной ИС, исходя из характера обрабатываемой в ней информации и иных требований информационной безопасности (далее — ИБ), предъявляемых к ней. Аппаратные требования, составы дистрибутивов, описание подготовки окружения (в том числе права и доступы) приведены в документации к компонентам продукта Synapse Enterprise Integration, в соответствующих подразделах разделов «Системные требования» документов «Руководство по установке».
Системное программное обеспечение#
Ниже представлены категории системного программного обеспечения (далее — ПО), которые обязательны или опциональны для установки, настройки, контроля и функционирования продукта. В каждой категории перечислены все поддерживаемые продукты сторонних правообладателей. Отдельно обозначены варианты, которые рекомендует АО «СберТех» (маркировка «Рекомендовано» в столбце «Продукт, функциональная совместимость с которым подтверждена»). Клиенту необходимо выбрать один из продуктов в каждой категории, исходя из условий использования конечной ИС.
Информация ниже является обзором требований (подробнее актуальные требования представлены в документации к каждому компоненту).
Категория ПО |
Обязательность установки |
Наименование ПО |
Версия |
Продукт, функциональная совместимость с которым подтверждена |
Назначение категории ПО |
|---|---|---|---|---|---|
Операционная система |
Да |
10 |
Рекомендовано. Правообладателем АО «СберТех» также рекомендована Операционная система (INST) – Platform V SberLinux OS Server, см. раздел «Платформенные зависимости» |
ОС контейнеров для запуска модулей компонента |
|
8 |
Опционально |
||||
Платформа для разработки, доставки и запуска контейнерных приложений |
Да |
4.6 и выше |
Рекомендовано |
Платформа контейнеризации с открытым исходным кодом |
|
Среда оркестрации контейнеров |
Да |
1.19 и выше |
Рекомендовано. Правообладателем АО «СберТех» также рекомендована среда контейнеризации – Platform V DropApp, см. раздел «Платформенные зависимости» |
Открытое программное обеспечение для оркестрации контейнеризированных приложений |
|
4.6 и выше |
Опционально |
Платформа контейнеризации для запуска компонентов сервиса |
|||
Система мониторинга (сбор и хранение метрик) |
Нет |
2.37 и выше |
Рекомендовано. Правообладателем АО «СберТех» также рекомендован сервис для сбора прикладных и инфраструктурных метрик и отправки их в целевую систему хранения – Объединенный мониторинг Unimon Platform V Monitor, см. раздел «Платформенные зависимости» |
Система для сбора и хранения численных метрик |
|
Сервис централизованного хранения репозиториев артефактов (хранилище артефактов) |
Да |
3.42.0 |
Рекомендовано |
Интегрированная платформа для проксирования, хранения и управления зависимостями Java (Maven), образами, а также распространения ПО |
|
Nexus Repository Manager PRO |
3.43.0 |
Опционально |
|||
Nexus Repository Manager OSS |
3.43.0 |
Опционально |
|||
Сервис централизованного хранения репозиториев исходного кода |
Да |
15.7 и выше |
Рекомендовано |
Хранение конфигураций при автоматизированной установке |
|
7.6.7 и выше |
Опционально |
Сервис интеграции микросервисов в облаке |
|||
Сервис интеграции и оркестрации микросервисов в облаке |
Нет |
1.6 и выше |
Опционально. Правообладателем АО «СберТех» также рекомендован сервис интеграции и оркестрации микросервисов в облаке, основанный на Istio – Platform V Synapse Service Mesh, см. раздел «Платформенные зависимости» |
Панель управления с открытым исходным кодом, служащая для обеспечения безопасности контейнеров в среде контейнеризации Kubernetes |
|
Менеджер пакетов |
Нет |
3 и выше |
Опционально |
Диспетчер пакетов для Kubernetes, упрощающий для разработчиков и операторов упаковку, настройку и развертывание приложений и служб в кластерах Kubernetes |
|
Java-машина |
Да |
17 |
Рекомендовано |
Окружение для работы модулей компонента (в рамках базового образа необходимо использовать openjdk 17) |
|
11.0.20 |
Опционально |
Окружение для работы модулей компонента (реализация на Java) |
|||
Система управления базами данных (СУБД) |
Да |
4.6.0 |
Рекомендовано. Правообладателем АО «СберТех» также рекомендована СУБД, основанная на PostgreSQL – Platform V Pangolin SE, см. раздел «Платформенные зависимости» |
ПО, взаимодействующее с конечными пользователями, приложениями и базой данных для сбора и анализа данных |
|
Oracle Database |
19с |
Опционально |
|||
Система хранения и распространения secrets |
Нет |
1.10 и выше |
Опционально |
Система, обеспечивающая безопасный и надежный способ хранения и распространения secrets |
|
Менеджер системы обмена сообщениями |
Да |
Apache ActiveMQ Artemis |
2.20.0 |
Рекомендовано. Правообладателем АО «СберТех» также рекомендована система обмена сообщениями – Platform V Synapse.Messaging, см. раздел «Платформенные зависимости» |
Обмен сообщениями |
Брокер сообщений |
Да |
2.5.0 |
Рекомендовано. Правообладателем АО «СберТех» также рекомендован брокер сообщений, основанный на Kafka – Platform V Corax, см. раздел «Платформенные зависимости» |
Событийный обмен сообщениями между модулями компонента |
|
Распространяемый клиент IBM MQ |
Да |
9.2.0.7-IBM-MQC-Redist-LinuxX64 |
9.2.0.7 |
Опционально |
Клиент для подключения к IBM MQ в базовом образе (реализация MQ Gateway на Golang) |
com.ibm.mq.allclient-9.2.0.6.jar |
9.2.0.6 |
Опционально |
|||
Менеджер системы обмена сообщениями |
Да |
9.1.0.8 |
Опционально |
Обмен сообщениями |
|
Хранилище данных |
Да |
6.2.7 и выше |
Рекомендовано. Образы, с которыми была проверена работоспособность компонента SRLS: docker.io/library/redis:6.0.9, docker.io/library/redis:6.2.11, docker.io/library/redis:7.0.10 |
Внешний распределенный кеш используется для корректного подсчета лимитов для сервиса, запущенного более чем в одном экземпляре |
Примечание:
*
Рекомендовано — рекомендованный правообладателем АО «СберТех» продукт.
Опционально — альтернативный по отношению к рекомендованному правообладателем АО «СберТех» продукт.
Платформенные зависимости#
Для настройки, контроля и функционирования продукта реализована интеграция с программными продуктами, правообладателем которых является АО «СберТех»:
Наименование продукта |
Код |
Версия продукта |
Код и наименование компонента |
Обязательность установки (да/нет) |
Описание |
Аналог других производителей |
|---|---|---|---|---|---|---|
Platform V Backend |
#BD |
4.3 и выше |
OTTS One-Time Password (OTP)/OTT |
Нет |
Сервис для аутентификации и авторизации межсервисных взаимодействий |
|
Platform V Monitor |
OPM |
4.1 и выше |
LOGA Журналирование |
Нет |
Сервис для хранения лог-файлов |
Любой сервис сбора записей о событиях, совместимый с fluent-bit, например: Elasticsearch, InfluxDB |
MONA Объединенный мониторинг Unimon |
Нет |
Сервис для сбора прикладных и инфраструктурных метрик и отправки их в целевую систему хранения |
Prometheus 2.21.0 |
|||
INDA Indicator |
Нет |
Сервис контроля качества работы сервисов платформы, обеспечивающий представление информации о состоянии сервисов посредством обработки значений метрик с последующей визуализацией метрик на различных типах панелей |
Grafana 7.5 |
|||
Platform V SberLinux OS Core |
SLC |
9.2 |
CORE Базовая ОС |
Да |
ОС предназначена для безопасного развертывания сред контейнеризации с поддержкой масштабирования |
ОС Альт 8 СП |
Platform V SberLinux OS Server |
SLO |
8.7 |
INST Операционная система |
Да |
ОС контейнеров для запуска модулей компонента |
ОС Альт 8 СП |
Platform V DropApp |
K8S |
1.1 и выше |
K8SC K8S Core |
Да |
Дистрибутив Kubernetes со встроенными механизмами мультитенантности и бессерверным исполнением |
Kubernetes |
Platform V Synapse Enterprise Integration |
SEI |
3.7 и выше |
KFGT kafka gateway |
Нет |
Шлюз для взаимодействия с kafka |
|
Platform V Audit SE |
AUD |
3.1 |
AUDT Аудит |
Да |
Сервис для хранения передаваемых событиях аудита |
|
Platform V Synapse Service Mesh |
SSM |
2.10 и выше |
POLM Управление политиками |
Да |
Панель управления с открытым исходным кодом, служащая для взаимодействия, мониторинга и обеспечения безопасности контейнеров в среде контейнеризации Kubernetes |
Istio control plane 1.12 |
SVPX Сервисный прокси |
Да |
Сервисный прокси используется для маршрутизации и обеспечения безопасности трафика между приложениями |
Istio proxy 1.12 |
|||
IGEG Граничный прокси |
Да |
Сервис для обеспечения управляемого вызова интеграционных сервисов прикладной части |
||||
REQV Валидатор запросов |
Нет |
Валидации входящих запросов. Функционирует как sidecar-контейнер |
||||
Platform V Pangolin SE |
PSQ |
5.1.0 |
PSQL Platform V Pangolin |
Да |
Система управления базами данных, основанная на PostgreSQL |
PostgreSQL 11 |
Platform V Synapse.Messaging |
SMB |
1.2.0 и выше |
SMBX Синапс.Брокер сообщений |
Да |
Сервис предоставляет возможность использования очередей сообщений (MQ) в интеграционной платформе на основе технологий Apache Artemis MQ |
Apache ActiveMQ Artemis |
Platform V Corax |
KFK |
5.1.7 |
KFKA Kafka Sber Edition |
Да |
Программный брокер сообщений, представляющий собой распределенную, отказоустойчивую, реплицированную и легко масштабируемую систему передачи сообщений, рассчитанную на высокую пропускную способность |
Kafka 2.7.0 |
Примечание:
***
Да — компонент или продукт необходим для функционирования сервиса (это означает, что сервис не может выполнять свои основные функции без установки данного компонента).
Нет — необязательный для функционирования сервиса компонент или продукт (это означает, что сервис может выполнять свои основные функции без установки данного компонента).
**** Рекомендуется установка программного продукта, правообладателем которого является АО «СберТех», при этом не исключена возможность (допускается правообладателем) использования аналога других производителей. Аналоги, в отношении которых продукт успешно прошел испытания и подтвердил свою работоспособность, указаны в разделе «Системное программное обеспечение».
Установка#
Компонентный состав для релиза моносолюшена приведен в документе Примечания к релизу программного продукта Platform V SEI.
Описание процессов установки приведено в документации к компонентам продукта Platform V Synapse Enterprise Integration, в соответствующих разделах документов «Руководство по установке».
Последовательность установки компонентов не принципиальна, можно устанавливать в любом порядке.
Базовые образы, на которых тестировались компоненты:
Код компонента |
Название компонента |
Базовый образ |
|---|---|---|
ASGT |
JMS Gateway |
/container-8-ubi-sbt:8.8-172 |
MQGT |
MQ Gateway |
/openjdk11-openj9 (mq_gateway) и /ubi-minimal (mqgt) |
KFGT |
Kafka Gateway |
/container-8-ubi-sbt/openjdk-11:8.8-172 |
JDBC |
JDBC Gateway |
/container-8-ubi-sbt/openjdk-11:8.8-172 |
Адаптер Exchange |
- |
|
SRLS |
Synapse Rate Limiter |
/sblnxos/container-8-ubi-sbt:8.8-172 |
SMCX |
Synapse Managment Console |
/container-8-ubi-sbt/nodejs-16:8.8-172 (ucc-front), /container-8-ubi-sbt/openjdk-11:8.8-172 (ucc-back, mq-slave, mq-master, artemis-active-mq) |
UNIM |
Unimapper |
- |
KPLM |
Kapellmeister |
- |
SIST |
Integration service template |
- |
SYTE |
SyTester |
/container-8-ubi-sbt/openjdk-11:8.8-172 |
Заказчик самостоятельно решает, какие базовые образы использовать.
Обновление#
Описание процессов обновления приведено в документации к компонентам продукта , Platform V Synapse Enterprise Integration в соответствующих разделах документов «Руководство по установке».
Удаление#
Описание процессов удаления приведено в документации к компонентам продукта Platform V Synapse Enterprise Integration, в соответствующих разделах документов «Руководство по установке».
Проверка работоспособности#
Описание проверок работоспособности приведено в документации к компонентам продукта Platform V Synapse Enterprise Integration, в соответствующих разделах документов «Руководство по установке».
Откат#
Описание процессов отката приведено в документации к компонентам продукта Platform V Synapse Enterprise Integration, в соответствующих разделах документов «Руководство по установке».
Часто встречающиеся проблемы и пути их устранения#
Описание часто встречающихся проблем и путей их устранения приведено в документации к компонентам продукта Platform V Synapse Enterprise Integration, в соответствующих разделах документов «Руководство по установке».
Чек-лист валидации установки#
Описание чек-листов валидации установки приведено в документации к компонентам продукта Platform V Synapse Enterprise Integration, в соответствующих разделах документов «Руководство по установке».