Руководство по установке#
В руководстве приведены инструкции по установке продукта Platform V SynAI (SAI).
Термины и определения#
Термин / Аббревиатура |
Определение |
|---|---|
SynAI / SAI |
Программный продукт Platform V SynAI |
CPU |
Central Processing Unit, центральный процессор |
Custom Resource Definition / CRD |
Схема пользовательского ресурса, которая добавляется в кластер k8s/OpenShift |
Dashboard |
Графический пользовательский интерфейс, доступный посредством браузера |
Kubernetes / k8s |
Платформа оркестрации приложений с средствами автоматизации и управления на основе политик |
Machine Learning / Машинное обучение / ML |
Обширный подраздел искусственного интеллекта, основанный на методах построения алгоритмов, способных обучаться. Включающий в себя множество математических, статистических и вычислительных методов для разработки алгоритмов, способных решить задачу не прямым способом, а на основе поиска закономерностей в разнообразных входных данных |
mTLS |
Mutual Transport Layer Security, криптографический протокол взаимной (двусторонней) аутентификацией клиента и брокера, который является преемником SSL и обеспечивает безопасность транспортного уровня |
Namespace / NS |
Абстракция, используемая в k8s для поддержки изоляции групп ресурсов в пределах одного кластера |
OpenShift |
Платформа для управления приложениями. Позволяет использовать Docker и Kubernetes |
Operator |
Программное обеспечение, которое использует пользовательские ресурсы для управления приложениями и их компонентами |
Pod |
Набор запущенных и взаимодействующих между собой контейнеров на одном сервере кластера |
Project / Проект |
Абстракция, используемая в OpenShift для поддержки изоляции групп ресурсов в пределах одного кластера |
SSL |
Secure Sockets Layer, криптографический протокол для безопасной связи |
SynAi Operator |
Реализация Operator'а, манипулирующая пользовательским ресурсом |
TLS |
Transport Layer Security, криптографический протокол аутентификацией, который является преемником SSL и обеспечивает безопасность транспортного уровня |
АС |
Автоматизированная система |
БД |
База данных |
ОС |
Операционная система |
ПО |
Программное обеспечение |
Сервис / Микросервис |
Программное обеспечение, реализующее некоторую бизнес логику. Фактически является конфигурационным файлом, создающим pod: Deployment, DeploymentConfig, Job, CronJob и прочие |
Системные требования#
В данном разделе обозначен общий вид на системные требования для программного продукта. Детальные системные требования перечислены в документации каждого компонента, входящего в состав программного продукта. Комплекс технических средств (далее — КТС) должен обеспечивать работу всех компонентов продукта.
Настройки безопасности окружения и перечень платформенных (дополнительных внешних) продуктов, используемых для установки, настройки и контроля в конечной информационной системе (далее — ИС), выбираются клиентом при разработке конечной ИС, исходя из характера обрабатываемой в ней информации и иных требований информационной безопасности (далее — ИБ), предъявляемых к ней.
Аппаратные требования, составы дистрибутивов, описание подготовки окружения (в том числе права и доступы) приведены в документации к компонентам продукта Platform V SynAI, в соответствующих подразделах разделов «Системные требования» документов «Руководство по установке».
Системное программное обеспечение#
Ниже представлены категории системного программного обеспечения (далее — ПО), которые обязательны или опциональны для установки, настройки, контроля и функционирования продукта. В каждой категории перечислены все поддерживаемые продукты сторонних правообладателей. Отдельно обозначены варианты, которые рекомендует АО «СберТех» (маркировка «Рекомендовано» в столбце «Продукт, функциональная совместимость с которым подтверждена»). Клиенту необходимо выбрать один из продуктов в каждой категории, исходя из условий использования конечной ИС.
Категория ПО |
Обязательность установки (да/нет) |
Наименование ПО |
Версия |
Продукт, функциональная совместимость с которым подтверждена |
Описание |
|---|---|---|---|---|---|
Cреда контейнеризации |
Да |
1.19 и выше |
Рекомендовано. Правообладателем АО «СберТех» также рекомендована среда контейнеризации – Platform V DropApp, см. раздел «Платформенные зависимости» |
Платформа контейнеризации для запуска компонентов сервиса |
|
Red Hat OpenShift |
4.6 и выше |
Опционально |
Платформа контейнеризации для запуска компонентов сервиса |
||
HTTP-Сервис |
Да |
Nginx |
1.24 и выше |
Рекомендовано |
Сервер для балансировки внешних и внутренних запросов между сервисами |
Сервис интеграции и оркестрации микросервисов в облаке |
Нет |
RedHat ServiceMesh |
2.x и выше |
Опционально. Правообладателем АО «СберТех» также рекомендован сервис интеграции и оркестрации микросервисов в облаке – Platform V Synapse Service Mesh, см. раздел «Платформенные зависимости» |
Service Mesh, базирующийся на Istio (istio.io) c расширенной функциональностью под вендорской лицензией RedHat |
1.12 и выше |
Опционально |
Сервис интеграции микросервисов в облаке |
|||
Система управления базами данных (СУБД) |
Да |
11 и выше |
Опционально. Правообладателем АО «СберТех» также рекомендована Система управления базами данных, основанная на PostgreSQL – Platform V Pangolin SE, см. раздел «Платформенные зависимости» |
ПО, взаимодействующее с конечными пользователями, приложениями и базой данных для сбора и анализа данных |
|
Система мониторинга (сбор и хранение метрик) |
Да |
2.0.0 и выше |
Рекомендовано. Правообладателем АО «СберТех» также рекомендован сервис для сбора прикладных и инфраструктурных метрик и отправки их в целевую систему хранения – Объединенный мониторинг Unimon Platform V Monitor, см. раздел «Платформенные зависимости» |
Система для сбора и хранения численных метрик |
|
Система хранения и распространения секретов |
Нет |
HashiCorp Vault |
1.5.0 и выше |
Рекомендовано |
Система, обеспечивающая безопасный и надежный способ хранения и распространения секретов |
Базовая ОС для контейнеров |
Да |
8 и выше |
Рекомендовано |
Операционная система |
|
Менеджер пакетов |
Да |
3.10 и выше |
Рекомендовано |
Инструмент для автоматизации создания, настройки и развертывания приложений и служб в k8s |
Примечание:
*
Да — категория ПО обязательна для функционирования сервиса (это означает, что сервис не может выполнять свои основные функции без установки данной категории ПО).
Нет — категория ПО необязательна для функционирования сервиса (это означает, что сервис может выполнять свои основные функции без установки данной категории ПО).
**
Рекомендовано — рекомендованный правообладателем АО «СберТех» продукт.
Опционально — альтернативный по отношению к рекомендованному правообладателем АО «СберТех» продукт.
Платформенные зависимости#
Для настройки, контроля и функционирования продукта реализована интеграция с программными продуктами, правообладателем которых является АО «СберТех»:
Наименование продукта |
Код |
Версия продукта |
Код и наименование компонента |
Обязательность установки (да/нет) |
Описание |
Аналог других производителей |
|---|---|---|---|---|---|---|
Platform V Pangolin SE |
PSQ |
5.1 и выше до потери обратной совместимости |
PSQL Platform V Pangolin |
Нет |
Система управления базами данных, основанная на PostgreSQL |
PostgreSQL 11 |
Platform V Synapse Service Mesh |
SSM |
3.2 и выше до потери обратной совместимости |
POLM Управление политиками |
Нет |
Панель управления с открытым исходным кодом, служащая для взаимодействия, мониторинга и обеспечения безопасности контейнеров в среде контейнеризации Kubernetes |
Istio control plane 1.12 и выше |
IGEG Граничный прокси |
Нет |
Сервис для обеспечения управляемого вызова интеграционных сервисов прикладной части |
Istio proxy 1.12 |
|||
SVPX Сервисный прокси |
Нет |
Сервис для предоставления базовых интеграционных операций прикладной части интеграционного сервиса |
Istio proxy 1.12 |
|||
VALD Валидатор конфигураций Service Mesh |
Нет |
Сервис для валидации новых конфигурационных файлов на соответствие актуальным требованиям |
— |
|||
Platform V Monitor |
OPM |
4.1 и выше до потери обратной совместимости |
LOGA Журналирование |
Нет |
Сервис для хранения лог-файлов |
Любой сервис сбора записей о событиях, совместимый с fluent-bit, например: Elasticsearch, InfluxDB |
MONA Объединенный мониторинг Unimon |
Нет |
Сервис для сбора прикладных и инфраструктурных метрик и отправки их в целевую систему хранения |
Prometheus 2.21.0 |
|||
LGDB Abyss |
Нет |
Сервис для передачи лог-файлов |
Любой сервис сбора записей о событиях, совместимый с fluent-bit, например: Elasticsearch, InfluxDB |
|||
Platform V DropApp |
K8S |
1.1-60 и выше |
K8SC K8S Core |
Нет |
Дистрибутив Kubernetes со встроенными механизмами мультитенантности и бессерверным исполнением |
Kubernetes, Red Hat OpenShift Container Platform |
Platform V SberLinux OS Server |
SLO |
8.7 и выше |
INST Операционная система |
Нет |
ОС контейнеров для запуска модулей компонента |
ОС Альт 8 СП |
Примечание:
***
Да — компонент или продукт необходим для функционирования сервиса (это означает, что сервис не может выполнять свои основные функции без установки данного компонента).
Нет — необязательный для функционирования сервиса компонент или продукт (это означает, что сервис может выполнять свои основные функции без установки данного компонента).
**** Рекомендуется установка программного продукта, правообладателем которого является АО «СберТех», при этом не исключена возможность (допускается правообладателем) использования аналога других производителей. Аналоги, в отношении которых продукт успешно прошел испытания и подтвердил свою работоспособность, указаны в разделе «Системное программное обеспечение».
Браузеры#
Установка того или иного браузера из таблицы ниже обязательна только в случае необходимости использования UI компонентов продукта SynAI. Отдельно обозначены варианты, которые рекомендует АО «СберТех» (маркировка «Рекомендовано» в столбце «Продукт, функциональная совместимость с которым подтверждена»).
Браузер |
Версия |
Продукт, функциональная совместимость с которым подтверждена |
|---|---|---|
Яндекс Браузер |
20.3 и новее (для любых ОС) |
Рекомендовано |
Google Chrome |
90 и новее (для любых ОС) |
Опционально |
MS Edge |
90 и новее (для любых ОС) |
Опционально |
Opera |
67 и новее (для любых ОС) |
Опционально |
Mozilla Firefox |
90 и новее (для любых ОС) |
Опционально |
Safari |
14.0.3 и новее (для IOS) |
Опционально |
Примечание:
*****
Минимальная версия, на которой гарантируется работоспособность.
******
Рекомендовано — рекомендованный правообладателем АО «СберТех» продукт.
Опционально — альтернативный по отношению к рекомендованному правообладателем АО «СберТех» продукт.
Установка#
Описание процессов установки приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».
Последовательность установки компонентов не принципиальна, можно устанавливать в любом порядке.
Обновление#
Описание процессов обновления приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».
Удаление#
Описание процессов удаления приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».
Проверка работоспособности#
Описание проверок работоспособности приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».
Откат#
Описание процессов отката приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».
Часто встречающиеся проблемы и пути их устранения#
Описание часто встречающихся проблем и путей их устранения приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».
Чек-лист валидации установки#
Описание чек-листов валидации установки приведено в документации к компонентам продукта Platform V SynAI, в соответствующих разделах документов «Руководство по установке».