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

В руководстве приведены инструкции по установке продукта Platform V Synapse Service Mesh.

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

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

Аппаратные требования, составы дистрибутивов, описание подготовки окружения (в том числе права и доступы) приведены в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих подразделах разделов «Системные требования» документов «Руководство по установке».

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

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

Информация ниже является обзором требований (подробнее актуальные требования представлены в документации к каждому компоненту).

Категория ПО

Обязательность установки

Наименование ПО

Версия

Продукт, функциональная совместимость с которым подтверждена

Назначение категории ПО

Операционная система

Да

Alt Linux SP8

10

Рекомендовано. Правообладателем АО «СберТех» также рекомендована Операционная система (INST) – Platform V SberLinux OS Server, см. раздел «Платформенные зависимости»

ОС контейнеров для запуска модулей компонента

Red Hat Enterprise Linux

8

Опционально

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

Да

Docker CE

4.6 и выше

Рекомендовано

Платформа контейнеризации с открытым исходным кодом

Среда оркестрации контейнеров

Да

Kubernetes

1.19 и выше

Рекомендовано. Правообладателем АО «СберТех» также рекомендована среда контейнеризации – Platform V DropApp, см. раздел «Платформенные зависимости»

Открытое программное обеспечение для оркестрации контейнеризированных приложений

Red Hat OpenShift

4.6 и выше

Опционально

Платформа контейнеризации для запуска компонентов сервиса

Система мониторинга (сбор и хранение метрик)

Нет

Prometheus

2.37 и выше

Рекомендовано. Правообладателем АО «СберТех» также рекомендован сервис для сбора прикладных и инфраструктурных метрик и отправки их в целевую систему хранения – Объединенный мониторинг Unimon Platform V Monitor, см. раздел «Платформенные зависимости»

Система для сбора и хранения численных метрик

Сервис для сбора метрик

Нет

Victoria metrics

1.5 и выше

Опционально

Инструмент для сбора метрик

Сервис централизованного хранения репозиториев артефактов (хранилище артефактов)

Да

Nexus-Public

3.42.0

Рекомендовано

Интегрированная платформа для проксирования, хранения и управления зависимостями Java (Maven), образами, а также распространения ПО

Nexus Repository Manager PRO

3.43.0

Опционально

Nexus Repository Manager OSS

3.43.0

Опционально

Сервис централизованного хранения репозиториев исходного кода

Да

GitLab Community Edition

15.7 и выше

Рекомендовано

Хранение конфигураций при автоматизированной установке

Bitbucket

7.6.7 и выше

Опционально

Сервис интеграции микросервисов в облаке

Сервис интеграции и оркестрации микросервисов в облаке

Нет

Istio

1.6 и выше

Опционально. Правообладателем АО «СберТех» также рекомендован сервис интеграции и оркестрации микросервисов в облаке, основанный на Istio – Platform V Synapse Service Mesh, см. раздел «Платформенные зависимости»

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

Менеджер пакетов

Нет

Helm

3 и выше

Опционально

Диспетчер пакетов для Kubernetes, упрощающий для разработчиков и операторов упаковку, настройку и развертывание приложений и служб в кластерах Kubernetes

Java-машина

Да

OpenJDK

17

Рекомендовано

Окружение для работы модулей компонента (в рамках базового образа необходимо использовать openjdk 17)

openjdk-17.0.8

1.0-8

Опционально

Система хранения и распространения secrets

Нет

HashiCorp Vault

1.10 и выше

Опционально

Система, обеспечивающая безопасный и надежный способ хранения и распространения secrets

Система для трассировки

Нет

Jaeger

1.2

Опционально

Система для трассировки

Внешняя система хранения и отображения данных трассировки совместимая с форматом Zipkin

Да

Zipkin хранилище

Любая

Рекомендовано

Иное

Нет

kubectl CLI

1.20.5 и выше

Опционально

Интерфейс командной строки для взаимодействия с кластером

Иное

Да

NODE.JS

14-buster

Рекомендовано

Кроссплатформенная среда исполнения с открытым исходным кодом

Иное

Нет

Golang

1.18 и выше

Рекомендовано

Иное

Нет

Grafana

9.0 и выше

Опционально

Примечание:

*

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

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

**

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

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

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

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

Наименование продукта

Код

Версия продукта

Код и наименование компонента

Обязательность установки (да/нет)***

Описание

Аналог других производителей****

Platform V Backend

#BD

4.3 и выше

OTTS One-Time Password (OTP)/OTT

Нет

Сервис для аутентификации и авторизации межсервисных взаимодействий

Platform V Monitor

OPM

4.1 и выше

LOGA/Журналирование

Нет

Сервис предназначен для сохранения логов и предоставляет возможности для их просмотра и анализа конечными пользователями (сотрудниками поддержки)

Любой сервис сбора записей о событиях, совместимый с fluent-bit, например: Elasticsearch, InfluxDB

4.1 и выше

MONA/Объединенный мониторинг Unimon

Нет

Продукт предназначен для сбора данных о производительности, доступности и работоспособности прикладных приложений и инфраструктуры

Prometheus 2.21.0

Platform V DropApp

K8S

1.1 и выше

K8SC K8S Core

Нет

Дистрибутив Kubernetes со встроенными механизмами мультитенантности и бессерверным исполнением

Kubernetes, Red Hat OpenShift Container Platform

Platform V SberLinux OS Server

SLO

8.7 и выше

INST Операционная система

Нет

OС контейнеров для запуска модулей компонента

ОС Альт 8 СП

Platform V Synapse Enterprise Integration

SEI

3.7 и выше

KFGT kafka gateway

Нет

Шлюз для взаимодействия с kafka

Platform V Audit SE

AUD

2.3

AUDT

Нет

Сервис для хранения передаваемых событиях аудита

Примечание:

***

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

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

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

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

Описание настроек окружения приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

Установка#

Компонентный состав для релиза моносолюшена приведен в разделе Примечания к релизу программного продукта Platform V Synapse Service Mesh.

Описание процессов установки приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

Последовательность установки компонентов не принципиальна, можно устанавливать в любом порядке.

Для разворота и установки релизов моносолюшена рекомендуется использовать компонент SMDL.

Базовые образы, на которых тестировались компоненты:

Код компонента

Название компонента

Базовый образ

AMON

Расширенный мониторинг

Не требуется

POLM

Управление политиками

istio_se/sberlinux:1.17.3

IGEG

Граничный прокси

istio_se/sberlinux:1.17.3

SVPX

Сервисный прокси

istio_se/sberlinux:1.17.3

TRAS

Сервис трассировки

clean:v0.5.12 или container-8-ubi-sbt:8.8-172

VISL

Visual SSM

clean:v0.5.12 или container-8-ubi-sbt:8.8-172

SMDL

DevOps инструменты Service Mesh

Не требуется

REQV

Request Validator

alt-sp8-clean-libxml:1.1 или container-8-ubi-sbt:8.8-172

KBLT

KubeLatte

alt-sp8-golang:1.18 (Manager) и alt-sp8-golang:1.18 (Injector); или container-8-ubi-sbt:8.8-172 (Manager и Injector)

KBME

Kubelatte Migration Edition

alt-sp8-golang:1.18 (Manager) и alt-sp8-golang:1.18 (Injector); или container-8-ubi-sbt:8.8-172 (Manager и Injector)

FSSM

Federation Mesh

container-8-ubi-sbt или openjdk-11:8.8-172

LTST

Инструмент нагрузочного тестирования Service Mesh

ecl-tem:17.0.1_12-jre (istiotester) и nginx:1.19.0 (istiotester-front); или openjdk-17-runtime:8.8-172 (ltst_backend) и nginx:1.19.0 (ltst_frontend)

VALD

Валидатор конфигураций Service Mesh

alt-sp8-golang:1.18 или container-8-ubi:8.8-172

GATM

Сбор и анализ метрик

alt-sp8-golang:1.18 или container-8-ubi-sbt:8.8-172

Заказчик самостоятельно решает, какие базовые образы использовать.

Обновление#

Описание процессов обновления приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

Удаление#

Описание процессов удаления приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

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

Описание проверок работоспособности приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

Откат#

Описание процессов отката приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

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

Описание часто встречающихся проблем и путей их устранения приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

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

Описание чек-листов валидации установки приведено в документации к компонентам продукта Platform V Synapse Service Mesh, в соответствующих разделах документов «Руководство по установке».

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

Проверка корректности установки:

а) В меню выберите пункт Workload/Deployments и убедитесь что присутствует деплоймент соответствующей компоненты.

б) На вкладке Pods найдите Pods с именем установленного сервиса, убедитесь что количество реплик соответствует указанному в переменных и статус Pods имеет значение "Running". По умолчанию должен подняться 1 Pod.