В этом разделе вы найдете инструкции по установке решений Oz Forensics: как полной версии, так и версии Lite.

Порядок установки

• Связаться с нами и скачать архив Docker-образа по ссылке, которую мы вам пришлем

• Загрузить образ в Dockerdocker load -i <path to image tar file>

• Запустить docker run -p {port}:80 ozforensics/oz-api-lite:{tag}

Описание основных параметров

Параметры задаются переменными окружения при старте Docker-контейнера.

Допустимы следующие параметры:

• NUM_WORKERS – максимальное количество одновременно выполняемых анализов, определяется индивидуально. По умолчанию: 16.

• TF_ENABLE_ONEDNN_OPTS – ускорение. По умолчанию: 1, для процессоров AMD необходимо выставить 0.

Применение

Взаимодействие с биометрическим процессором реализовано на основе REST API по протоколу HTTPS.

Точка доступа к API

Базовый URL доступа к API: https://{hostname}/v1/face/pattern или https://{hostname}/v1/face/liveness в зависимости от используемого метода (см. примеры).

Где:

• {hostname} – имя хоста и порт сервера развернутого биометрического процессора.

Пример: localhost/v1/face/pattern

API поддерживает следующие типы контента запроса (HTTP-заголовок «Content-Type»):

• «multipart/form-data»;

• «application/octet-stream»;

• «image/jpeg» или «image/png»;

Используемые коды ответов HTTP

Что это?

Стационарный установщик – это программа для установки модулей системы Oz Forensics на сервера заказчика с автоматическим внесением всех необходимых настроек с учётом индивидуальной топологии и требований заказчика.

Данный установщик предназначен для развёртывания ПО на сервера напрямую, под учетной записью администратора. Сервера, на которых будет работать ПО, могут иметь или не иметь (с некоторыми оговорками) прямого доступа к Интернету, на них должен быть установлен Linux и к ним должен иметься полный доступ по ssh.

Для установки в OpenShift и других оркестраторах, пожалуйста, .

Необходимые условия

Требования к серверам

Сервер для Oz Biometry / Liveness

• CPU: 16 ядер

• RAM: 24 Гб

• На диске: 80 Гб

Сервер для Oz API / WebUI / Web SDK

• CPU: 8 ядер

• RAM: 16 Гб

• На диске: 300 Гб

Пожалуйста, обсудите версию ОС с нашими инженерами.

Требования к Kubernetes (K8s)

Версия: 1.27.

Обязательные компоненты:

• Prometheus (версия Helm-чартов (kube-prometheus-stack) – 45.7.1),

• ClusterIssuers.

Опциональные компоненты:

• Любой Storage Class с поддержкой режима ReadWriteMany (RWX).

Требования к ресурсам узлов:

• Архитектура CPU: Intel

Подготовка

1. Запросите список клиентских URL с соответствующими им сертификатами SSL.

2. Проверьте, что все сервера доступны по локальной сети.

3. Проверьте наличие доступа либо по SSH с авторизацией по паролю, либо с файлом-ключом и sudo без пароля.

4. Для установки мы рекомендуем использовать Docker или Podman. Если есть доступ в интернет, можно скачать и установить Docker или Podman автоматически.

   или
6. Проверьте, что сервера имеют доступ к сервису лицензий https://api.cryptlex.com. Брандмауэр клиента не должен блокировать этот адрес.

7. Процессор сервера BIO должен поддерживать AVX флаги. Для проверки используйте команду lscpu | grep -E 'avx256|avx512' | wc -l. Ответ должен быть “1”.

8. Брандмауэр клиента не должен блокировать:

   • любые запускаемые скрипты или бинарные образы;

   • любые локальные порты для взаимодействия процессов (сети docker: 192.168.0.1/24, 192.168.10.0/24, 192.168.11.0/24, 192.168.12.0/24, 192.168.13.0/24);

   • порты 80, 8000, 8080, 8090 на сервере API server и порт 8091 на сервере BIO;

   • порт 5432 для установки Postgres.

Перед отправкой трафика на сервер API может потребоваться завершить соединение HTTPS и дешифровать трафик. Обычно это делается с помощью брандмауэра или других инструментов безопасности.

Важно: предупредите нас о любых нетипичных и/или неофициальных программах или сервисах, установленных на серверах.

Как получить установщик?

Комплект для быстрого ознакомления

Для тестовой развертки предусмотрен типовой комплект установщика с ограничениями по использованию.

Вам достаточно подготовить два сервера, отвечающие изложенным выше требованиям, и скачать комплект установки.

Как запустить установщик?

Для запуска вам потребуется компьютер с Windows или Linux. Системные требования:

• 1 Гб ОЗУ, 1 CPU, 3 Гб на диске

• Windows 10+ (рекомендовано)

• Linux 64-bit (требуется Python 3.7)

Подробную информацию по запуску смотрите ниже (на английском языке):

Подготовка серверов

1. Убедитесь, что системные характеристики серверов соответствуют рекомендуемым.

2. Убедитесь, что сервера доступны по локальной сети.

Подготовка установщика

Скачайте и разархивируйте вашу копию установщика.

Внесите необходимые настройки в файл settings.yml. Ниже приведено описание некоторых важных настроек. В общем случае при установке требуется только заполнить блок авторизации и переменные.

Пожалуйста, обратите внимание: файл с настройками является вашей персональной копией и не подлежит передаче третьим лицам.

Настройки

Запуск

Вызовите командную строку с правами администратора. Перейдите в папку, куда вы до этого поместили разархивированный установщик (команда cd). Запустите процесс установки.

Для запуска на Windows:

Для запуска на Linux:

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

• filename – имя файла с настройками (по умолчанию 'settings.yml')

• private_key – путь к приватному ssh-ключу (переопределяет соответствующую опцию настроек)

• key_password – пароль к ssh-ключу, если не указан, система попросит ввести его в консоли

• ssh_password – пароль ssh-пользователя

• --debug – выводит и логирует подробную информацию выполнения

Пример использования:

Устранение неисправностей

Как использовать putty ppk файл для подключения

Для этого необходимо сначала извлечь private-часть ключа, а затем указать путь к этому файлу в разделе auth -> ssh_private_key

Что делать при docker-compose: команда не найдена

Такая ошибка может происходить в том случае, когда программа docker-compose была установлена самостоятельно для запуска установщика и при этом был выбран путь по умолчанию: /usr/local/bin

Для корректной работы создайте символическую ссылку: