Инструкция по установке
Загрузка образов и создание Kubernetes-кластера
Подготовка
Скачайте и распакуйте дистрибутив OMNI Platform на машину, где планируется выполнить установку. Для этого можно воспользоваться командой:
curl --output platform.zip ссылка на дистрибутив
В curl-запросе необходимо указать ссылку на дистрибутив OMNI Platform (zip-файл). Ссылка на папку, в которой размещен дистрибутив и сопроводительная документация в формате pdf, будет указана в электронном письме.
Далее переместите файл лицензии face_sdk.lic (файл прикреплен к электронному письму) в папку setup.
Комплект установки OMNI Platform:
- ./cli.sh — точка входа для запуска команд.
- ./cfg — папка с файлами конфигурации OMNI Platform.
Дальнейшие команды выполняются в системной консоли из директории setup.
Загрузка образов
Загрузите в локальный registry продуктовые образы из архива:
./cli.sh generic load-images
Загрузите в локальный registry инфраструктурные образы из архива:
./cli.sh smc load-images
Загрузка образов может занять около пяти минут.
Конфигурация
Ввод переменных окружения
Откройте следующие файлы конфигурации, используя текстовый редактор, установите значения переменных и сохраните изменения.
Значения, указываемые через точку в yaml файлах, отражают вложенность.
Файл конфигурации | Переменные |
./cfg/smc.settings.cfg |
|
./cfg/license-server.settings.cfg |
|
./cfg/platform.secrets.json |
|
./cfg/platform.values.yaml |
|
Настройка Docker для использования GPU (опционально)
Конфигурация Docker
Для установки nvidia-container-runtime в качестве низкоуровневой среды выполнения по умолчанию, добавьте следующие строки в файл конфигурации, который находится по адресу /etc/docker/daemon.json:
"default-runtime": "nvidia",
"runtimes": {
"nvidia": {
"path": "/usr/bin/nvidia-container-runtime",
"runtimeArgs": []
}
}
Применение конфигурации
Перезапустите docker-service:
sudo systemctl restart docker
Установка и настройка кластера
Если у вас уже есть развернутый кластер, перейдите к пункту Запуск развертывания.
Запустите команды для создания и настройки кластера:
./cli.sh platform db-create-mountpoint
./cli.sh smc install
./cli.sh platform install-secrets
Эти команды создают точки монтирования базы данных, инициализируют кластер и устанавливают секреты.
Для использования GPU в кластере установите NVIDIA device plugin:
./cli.sh smc nvidia install
Проверка работоспособности кластера
После инициализации главной ноды проверьте, что все ноды готовы к работе и имеют статус Ready:
kubectl get nodes
В результате в терминале будет отображен следующий вывод:
NAME STATUS ROLES AGE VERSION
master-node Ready control-plane,master 11d v1.23.8
Для проверки всех элементов кластера запустите команду:
kubectl get all --all-namespaces
Настройка лицензирования
Активация пробного периода
Пробный период активируется при первом запуске OMNI Platform.
- Требуется подключение к сети Интернет;
- Не допускается запуск OMNI Platform на виртуальной машине.
Установка сервера лицензий
Перед установкой откройте файл ./cfg/license-server.settings.cfg и задайте IP-адрес машины, на которой будет установлен сервер лицензий, в переменной license_server_address
. Запустите команду для установки и запуска сервера лицензий. Если license_server_address
не равен адресу хоста машины, где происходит развертывание, он будет установлен через sshpass.
./cli.sh license-server install
Запустите сервер лицензий:
./cli.sh license-server start
Проверьте, что сервер лицензий находится в статусе Running:
./cli.sh license-server status
Пример вывода в консоль:
floatingserver.service - Floating License Server
Loaded: loaded (/etc/systemd/system/floatingserver.service; enabled; vendor preset: enabled)
Active: active (running) since Tue 2022-12-20 12:25:54 +05; 1min 48s ago
Убедитесь, что сервер лицензий доступен. Для этого перейдите по адресу http://<license_server_address>:8090
в вашем браузере, на странице должна отобразиться форма входа.
Онлайн активация лицензии
Перед активацией убедитесь, что в key
(файл ./cfg/license-server.settings.cfg) записан лицензионный ключ.
Запустите команду активации лицензии:
./cli.sh license-server activate
Пример вывода в консоль при успешной активации лицензии:
[2022-12-20 12:25:53+05:00] INF Activating license key...
[2022-12-20 12:25:54+05:00] INF License activated successfully!
Офлайн активация лицензии
Перед активацией убедитесь, что в поле license_key
(в файле ./cfg/license-server.settings.cfg) записан лицензионный ключ.
Для офлайн активации установите «1» в поле enable_offline_activation
в файле license-server.settings.cfg.
Запустите команду для генерации офлайн запроса на лицензию:
./cli.sh license-server generate-offline
В результате выполнения команды в директории setup должен появиться файл request-offline.dat.
Отправьте сгенерированный файл запроса request-offline.dat на почту support-platform@3divi.com
. В ответном письме будет отправлен файл лицензии.
Поместите полученный лицензионный файл в папку setup.
Откройте файл конфигурации license-server.settings.cfg и заполните значение переменной license_offline_activation_file
именем файла лицензии и его расширением, если присутствует, через точку.
Активируйте полученную лицензию:
./cli.sh license-server activate
Пример вывода в консоль при успешной активации лицензии:
[2022-09-08 01:30:36+05:00] INF Offline activating license key...
[2022-09-08 01:30:36+05:00] INF License activated successfully!
Проверка статуса лицензии после активации
Выполните команду для получения статуса лицензии:
./cli.sh license-server status-license
Пример вывода в консоль:
Activation Status: OK
License key: YOUR-LICENSE-KEY
Days Left To Expiration: 100
Сравните результат вывода команды с данными вашей лицензии. Days Left To Expiration=14 означает, что автоматически активировалась триальная лицензия. В этом случае повторите шаги по активации.
Развертывание
Запуск развертывания
Для распознавания лиц OMNI Platform использует сервисы Image API, которые необходимо установить перед установкой платформы с помощью команды:
./cli.sh image-api install
Запустите установку OMNI Platform:
./cli.sh platform install
Для отслеживания процесса развертывания откройте ещё одну вкладку терминала и введите команду:
watch 'kubectl get pods'
Наличие у всех под (pods) статуса Running означает, что платформа запущена.
После запуска проверьте статус лицензии. Если полученные данные не соответствуют действительности, вставьте ключ лицензии в поля license_key
(в файле ./cfg/license-server.settings.cfg) и license-secret.key
(в файле ./cfg/platform.secrets.json) и выполните все действия из пункта Обновление лицензии.
Настройка DNS
Для доступа к платформе DNS-сервер вашей сети должен содержать запись о том, что домен доступен по адресу <external_ip_address>
.
Для тестирования можно указать IP-адрес и домен в файле /etc/hosts на Linux или C:\Windows\System32\drivers\etc\hosts на Windows. Просто добавьте в конец файла новую строку вида <external_ip_address> <ingress.rules.gateway.host>
и сохраните файл. Значения переменных указаны в файлах ./cfg/smc.settings.cfg и ./cfg/platform.values.yaml.
Обратите внимание, что для редактирования файла hosts необходимо обладать правами администратора.
Для использования OMNI Platform с той же машины, где выполнено развертывание, можно воспользоваться скриптом. Он добавит необходимую запись в файл /etc/hosts
.
./cli.sh generic add-dns - <external_ip_address> <domain>
Описание сервисов
Для получения статуса сервисов OMNI Platform выполните команду:
kubectl get pods
В консоль будет выведен список сервисов, их статус, количество перезапусков и время с момента создания сервиса.
Пример вывода:
NAME READY STATUS RESTARTS AGE
image-api-age-estimator-dep-c66c8f575-zb84s 1/1 Running 0 24h
image-api-body-detector-dep-5588d96ddc-lnrrx 1/1 Running 0 24h
image-api-emotion-estimator-dep-b6c947ff-mz7cw 1/1 Running 0 24h
image-api-face-detector-face-fitter-dep- 1/1 Running 0 24h
image-api-face-detector-liveness-estimator-dep- 2/2 Running 0 24h
image-api-face-detector-template-extractor-dep- 1/1 Running 0 24h
image-api-gender-estimator-dep-7948d8cf85-4hk2q 1/1 Running 0 24h
image-api-mask-estimator-dep-5ccfcc8cb9-sjnqz 1/1 Running 0 24h
image-api-quality-assessment-estimator-dep- 1/1 Running 0 24h
image-api-verify-matcher-dep-6b8f5b4d6f-jjqr4 1/1 Running 0 24h
platform-activity-matcher-dep-8697574c9b-xvh5z 2/2 Running 0 24h
platform-agent-sync-dep-899c9ddc8-7qcvj 1/1 Running 0 24h
platform-backend-dep-685675d648-ngcrj 1/1 Running 0 24h
platform-event-service-dep-5fcd66f999-24jjg 1/1 Running 0 24h
platform-gateway-dep-f4cd7db78-h86jz 1/1 Running 0 24h
platform-licensing-dep-84d78745d6-2flk2 1/1 Running 0 24h
platform-matcher-dep-6495447f45-5hdsp 1/1 Running 0 24h
platform-memcached-dep-64d9d7f6f7-b5bpd 1/1 Running 0 24h
platform-minio-dep-58fc7db749-l457d 1/1 Running 0 24h
platform-postgres-dep-67c5b75b84-fm8wr 1/1 Running 0 23h
platform-processing-dep-7fdf8699b5-682sn 1/1 Running 0 24h
platform-rabbit-dep-69cd659f8c-sbnk2 1/1 Running 0 24h
platform-redis-dep-694df659f-9vhrh 1/1 Running 0 24h
Краткое описание сервисов:
- platform-activity-matcher-dep: сервис используется для поиска людей по активностям.
- image-api-age-estimator-dep: сервис используется для оценки возраста человека по изображению лица.
- platform-agent-sync-dep: сервис отвечает за синхронизацию данных о профилях с OMNI Agent.
- platform-backend-dep: основной контейнер платформы, отвечает за работу большей части API.
- image-api-body-detector-dep: сервис предназначен для детекции силуэтов на изображении.
- platform-rabbit-dep: сервис RabbitMQ, используется для работы асинхронной очереди задач.
- platform-cache-dep: сервис Memcached, используется для кэширования данных.
- platform-postgres-dep: Экземпляр СУБД PostgreSQL, хранит всю информацию платформы.
- image-api-emotion-estimator-dep: сервис используется для оценки эмоций человека по изображению лица.
- image-api-face-detector-face-fitter-dep: сервис используется для детекции лиц и определения антропометрических точек лица и углов поворота головы.
- image-api-face-detector-liveness-estimator-dep: сервис используется для детекции лиц и оценки принадлежности лица на изображении реальному человеку.
- image-api-face-detector-template-extractor-dep: сервис предназначен для детекции лиц и извлечения биометрического шаблона лица.
- platform-gateway-dep: сервис nginx, отвечает за доступ к платформе и за работу веб-интерфейса платформы.
- image-api-gender-estimator-dep: сервис используется для оценки пола человека по изображению лица.
- platform-licensing-dep: сервис, ограничивающий работу платформы согласно параметрам лицензии.
- image-api-mask-estimator-dep: сервис позволяет определить наличие или отсутствие медицинской маски на лице человека.
- platform-matcher-dep: сервис используется для поиска людей по профилям.
- platform-minio-dep: сервис MinIO, используется для хранения изображений.
- platform-processing-dep: сервис аккумулирует результаты работы сервисов-обработчиков (age-estimator-dep, emotion-estimator-dep, gender-estimator-dep,face-detector-face-fitter-dep, mask-estimator-dep).
- image-api-quality-assessment-estimator-dep: сервис предназначен для оценки качества изображения лица.
- platform-redis-dep: сервис Redis, используется для работы веб-сокетов.
- image-api-verify-matcher-dep: сервис отвечает за сравнение двух лиц с изображений.
- platform-event-service-dep: сервис используется для обработки событий, приходящих с OMNI Agent.