Руководство по установке#

В руководстве приведены инструкции по установке компонента Шлюз ActiveMQ Artemis, ASGT продукта Platform V Synapse Enterprise Integration (SEI).

Термины и определения#

Важно! Шлюз ActiveMQ Artemis, (ASGT) продукта Platform V Synapse Enterprise Integration (SEI) поставляется в виде дистрибутива для сборки Docker-образа. Собранный Docker-образ предназначается для использования в составе прикладных интеграционных решений, разрабатываемых продуктовыми командами.

Для этого команды, реализующие прикладную интеграцию, выпускают дистрибутив, содержащий набор конфигурационных артефактов Kubernetes, обеспечивающих развертывание и настройку отдельного экземпляра компонента Шлюз ActiveMQ Artemis под требования этой интеграции.

Самостоятельно, вне рамок прикладных интеграционных решений, компонент Шлюз ActiveMQ Artemis не эксплуатируется.

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

Настройки безопасности окружения и перечень платформенных (дополнительных внешних) продуктов, используемых для установки, настройки и контроля в конечной информационной системе (далее — ИС), выбираются клиентом при разработке конечной ИС, исходя из характера обрабатываемой в ней информации и иных требований информационной безопасности (далее — ИБ), предъявляемых к ней.

Системное программное обеспечение#

Ниже представлены категории системного программного обеспечения (далее — ПО), которые обязательны или опциональны для установки, настройки, контроля и функционирования компонента. В каждой категории перечислены все поддерживаемые продукты сторонних правообладателей. Отдельно обозначены варианты, которые рекомендует АО «СберТех» (маркировка «Рекомендовано» в столбце «Продукт, функциональная совместимость с которым подтверждена»). Клиенту необходимо выбрать один из продуктов в каждой категории, исходя из условий использования конечной ИС.

Примечание:

*

• Да — категория ПО обязательна для функционирования сервиса (это означает, что сервис не может выполнять свои основные функции без установки данной категории ПО).

• Нет — категория ПО необязательна для функционирования сервиса (это означает, что сервис может выполнять свои основные функции без установки данной категории ПО).

**

• Рекомендовано — рекомендованный правообладателем АО «СберТех» продукт.

• Опционально — альтернативный по отношению к рекомендованному правообладателем АО «СберТех» продукт.

Платформенные зависимости#

Для настройки, контроля и функционирования компонента реализована интеграция с программными продуктами, правообладателем которых является АО «СберТех»:

Примечание:

***

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

• Нет — необязательный для функционирования сервиса компонент или продукт (это означает, что сервис может выполнять свои основные функции без установки данного компонента).

**** Рекомендуется установка программного продукта, правообладателем которого является АО «СберТех», при этом не исключена возможность (допускается правообладателем) использования аналога других производителей. Аналоги, в отношении которых продукт успешно прошел испытания и подтвердил свою работоспособность, указаны в разделе «Системное программное обеспечение».

Аппаратные требования#

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

Для установки компонента требуется следующая конфигурация аппаратного обеспечения:

При использовании sidecars Сервисного прокси, Агента журналирования, Агент hashicorp vault минимальные ресурсы, необходимые для их запуска, следует уточнить в документации на эти компоненты.

Компонент Сервисный прокси (SVPX) Platform V Synapse Service Mesh должен быть развернут в соответствии с разделом Установка документа Руководство по установке своей документации.

Компонент Агент журналирования (LOGA) Platform V Monitor должен быть развернут в соответствии с разделом Установка документа Руководство по установке своей документации.

Компонент Валидатор запросов (REQV) Platform V Synapse Service Mesh должен быть развернут в соответствии с разделом Установка документа Руководство по установке своей документации.

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

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

На данный момент поддерживается только ручная установка.

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

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

1. Развернут и настроен кластер Kubernetes версии 1.25.3 или выше;

2. В кластере создан проект (namespace), в котором будет разворачиваться компонент Шлюз ActiveMQ Artemis;

3. Проект подключен к ControlPlane Service Mesh (Platform V Synapse Service Mesh)

4. Обеспечена возможность подключения Сервисного прокси (SVPX) к Pod компонента Шлюз ActiveMQ Artemis;

5. В проекте создана учетная запись с правами на загрузку артефактов;

6. Получена ссылка на целевой Docker-репозиторий;

7. Базовый образ для сборки Docker-образа загружен в целевой Docker-репозиторий;

8. В проект добавлен Secret для загрузки Docker-образов из целевого Docker-репозитория;

9. На рабочем месте должен быть установлен клиент Kubernetes (kubectl) версии 1.22.4 или выше;

10. Для создания Docker-образа на рабочем месте должен быть установлен Docker версии 1.13.1 или выше.

11. Развернуты, настроены и готовы к работе брокеры Artemis (версия 2.20.0 или выше), есть доступ к ним со стороны кластера Kubernetes (для целей тестирования брокеры могут быть развернуты непосредственно в проекте);

12. Сетевые соединения с брокерами Artemis должны быть защищены протоколом TLS версии не ниже 1.2, поэтому должны быть выпущены сертификаты для установки TLS подключения.

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

Установка#

Важно! Ручная корректировка конфигурационных файлов в процессе установке не требуется.

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

Настройка namespace#

Информация по настройке приведена в таблице ниже.

Настройка namespace

Примечания к таблице

1 Команда правки сервисного аккаунта по умолчанию:

if kubectl --insecure-skip-tls-verify get sa default -o yaml | grep imagePullSecrets; then if ! (kubectl --insecure-skip-tls-verify get sa default -o yaml | grep -e "name.*имя_secret$"); then kubectl --insecure-skip-tls-verify patch sa default -p '[{"op": "add", "path": "/imagePullSecrets/-", "value": {"name": "имя_secret"}}]' --type=json; fi else kubectl --insecure-skip-tls-verify patch sa default -p "{\"imagePullSecrets\": [{\"name\": \"имя_secret\"}]}"; fi

Ручная сборка Docker-образа из дистрибутива#

Необходимая информация приведена в таблице ниже.

Сборка Docker-образа

Установка общих компонентов#

Необходимая информация приведена в таблице ниже.

Общие компоненты

Установка брокеров Artemis#

Необходимая информация приведена в таблице ниже.

Брокеры Artemis (заглушка)

Установка компонента Шлюз ActiveMQ Artemis#

Параметры настройки компонента Шлюз ActiveMQ Artemis представлены в таблице.

Компонент Шлюз ActiveMQ Artemis

Установка заглушки JMS#

Необходимая информация приведена в таблице ниже.

JMS-заглушка

Примечание: для более удобного разворачивания можно запустить bash-скрипт, предварительно подключившись к namespece Kubernetes, в котором будет разворачиваться компонент Шлюз ActiveMQ Artemis для тестирования:

bash install.sh kubectl

архив с файлами: test-artemismq.rar

Обновление#

Перед обновлением версии компонента Шлюз ActiveMQ Artemis рекомендуется выполнить бэкап установленной версии командой:

kubectl --insecure-skip-tls-verify get \<тип ресурса\> \<имя ресурса\> \> \<имя ресурса\>.yml

Для обновления версии компонента Шлюз ActiveMQ Artemis необходимо:

1. произвести полное удаление артефактов установленной версии командой:

   kubectl --insecure-skip-tls-verify delete \<тип ресурса\> \<имя ресурса>
   

2. произвести развертывание артефактов новой версии командой:

   kubectl --insecure-skip-tls-verify apply -f \<имя файла\>
   

При этом:

Чтение сообщений из очередей брокеров Artemis Pods новой версии компонента Шлюз ActiveMQ Artemis начинается автоматически после их старта в Kubernetes.

Переключение gRPC трафика выполняется механизмами Istio Service Mesh при загрузке артефакта Service.

Остановка чтения из очередей брокеров Artemis и обработка gRPC трафика старой версией компонента Шлюз ActiveMQ Artemis прекращается после остановки Pods старой версии.

Параметр strategy в Deployment компонента Шлюз ActiveMQ Artemis устанавливается в значение:

  strategy:
    type: RollingUpdate
    rollingUpdate:
      maxUnavailable: 25%
      maxSurge: 25%

В этом случае развертывание Pods новой версии компонента Шлюз ActiveMQ Artemis будет производится Kubernetes с использованием этой стратегии.

Удаление#

Для удаления версии компонента Шлюз ActiveMQ Artemis необходимо произвести удаление артефактов установленной версии командой:

kubectl --insecure-skip-tls-verify delete \<тип артефакта\> \<имя артефакта\>.

Требуется удалить артефакты:

• Configmap, содержащий файл application.yml компонента Шлюз ActiveMQ Artemis

• Secret, содержащий файлы key.pem, cert.pem с сертификатами компонента Шлюз ActiveMQ Artemis

• Service компонента Шлюз ActiveMQ Artemis

• Deployment компонента Шлюз ActiveMQ Artemis

Проверка работоспособности#

Для быстрой проверки работоспособности запущенного приложения компонента Шлюз ActiveMQ Artemis:

В интерфейсе Kubernetes, в терминале в Pod компонента Шлюз ActiveMQ Artemis выполните команду curl localhost:<portnum>/actuator/health в выдаче команды должна быть строка: "ping":{"status":"UP"}, что подтверждает, что экземпляр компонента Шлюз ActiveMQ Artemis запустился и готов к работе.

Чтобы выполнить эту же проверку с использованием kubectl:

• В консоли выполните команду kubectl --insecure-skip-tls-verify port-forward pod/<имя Pod> <portnum>:<portnum>. Kubectl перенаправит порт Pod компонента Шлюз ActiveMQ Artemis на соответствующий порт рабочего места.

• Запустите еще одно окно консоли, в нем выполнить команду: curl localhost:<portnum>/actuator/health, в выдаче команды должна быть строка: "ping":{"status":"UP"}, что подтверждает, что экземпляр компонента Шлюз ActiveMQ Artemis запустился и готов к работе.

• Завершите форвардинг портов, для этого нажмите Ctrl+C. Перенаправление порта на рабочее место будет отменено.

Для проверки интеграций с АС Журналирование и АС Мониторинг необходимо в АРМ этих систем убедиться в наличии логов и метрик соответственно. Для проверки интеграции с ТС Аудит необходимо в АРМ Аудит убедиться в наличии записей регистрации событий аудита.

Для проверки интеграции с Агентом hashicorp vault, Валидатором необходимо убедиться в отсутствии ошибок в соответствующих данным АС sidecar-контейнерах Pod компонента Шлюз ActiveMQ Artemis.

Откат#

Для отката к предыдущей версии компонента Шлюз ActiveMQ Artemis необходимо:

1. Произвести удаление артефактов установленной версии командой:

   kubectl --insecure-skip-tls-verify delete \<тип артефакта\> \<имя артефакта\>.
   

2. Произвести установку с артефактов из бэкапа командой:

   kubectl --insecure-skip-tls-verify apply -f \<имя файла\>
   

Для отката к предыдущей конфигурации нужно выполнить установку из бэкапа только артефактов типа ConfigMap и Secret.

Часто встречающиеся проблемы и пути их устранения#

Чек-лист валидации установки#