1 of 3

Установка модулей Oz

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

Стационарный установщик

Инструкция по использованию стационарного установщика

Что это?

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

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

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

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

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

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

CPU: 16 ядер
RAM: 32 Гбайт
На диске: 80 Гбайт

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

CPU: 8 ядер
RAM: 16 Гбайт
На диске: 300 Гбайт

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

Рекомендованные версии ОС с соответствующими им контейнерами

Redhat 7: Docker
Redhat 8: Podman*

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

Версия: 1.27.

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

Prometheus (версия Helm-чартов (kube-prometheus-stack) – 45.7.1),
Nginx Ingress Controller (версия Helm-чартов – 4.7.1, репозиторий с чартами ),
ClusterIssuers.

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

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

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

Архитектура CPU: Intel
CPU/RAM: аналогично .

Еси вы хотите настроить переменные чарта самостоятельно, .

Подготовка

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

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

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

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

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

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

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

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

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

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

1 Гб ОЗУ, 1 CPU, 3 Гб на диске
Windows 10+ (рекомендовано)
Linux 64-bit (требуется Python 3.7)

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

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

Убедитесь, что системные характеристики серверов соответствуют рекомендуемым.
Убедитесь, что сервера доступны по локальной сети.
Убедитесь, что к серверам есть доступ по единой учетной записи по SSH c авторизацией по паролю или файлу-ключу и для данной записи доступен без интерактивного .

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

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

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

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

Настройки

Запуск

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

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

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

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

filename – имя файла с настройками (по умолчанию 'settings.yml')
private_key – путь к приватному ssh-ключу (переопределяет соответствующую опцию настроек)
key_password

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

Для Linux необходимо поместить приватный ssh-ключ в папку с установщиком и указать в конфигурации путь к нему: /installer/priv_key

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

В процессе установки вся информация записывается в файл process.log. При возникновении нештатных ситуаций при установке прикрепляйте этот файл к .

Если установка была прервана по нештатной ситуации, то после разрешения проблемы она, как правило, может быть продолжена. Если продолжение невозможно, будьте готовы к сбросу серверов в изначальное состояние. Вы можете определить неисправность самостоятельно, если добавите к команде запуска параметр: --debug. Вы также можете для уточнения информации.

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

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

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

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

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

Oz System Lite

Описание порядка установки биометрического процессора 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 System Lite

Описание порядка установки биометрического процессора 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

Где:

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

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

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

«multipart/form-data»;
«application/octet-stream»;
«image/jpeg» или «image/png»;

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

Стационарный установщик

Инструкция по использованию стационарного установщика

Что это?

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

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

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

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

CPU: 16 ядер
RAM: 32 Гбайт
На диске: 80 Гбайт

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

CPU: 8 ядер
RAM: 16 Гбайт
На диске: 300 Гбайт

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

Рекомендованные версии ОС с соответствующими им контейнерами

Redhat 7: Docker
Redhat 8: Podman*

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

Версия: 1.27.

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

Prometheus (версия Helm-чартов (kube-prometheus-stack) – 45.7.1),
Nginx Ingress Controller (версия Helm-чартов – 4.7.1, репозиторий с чартами ),
ClusterIssuers.

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

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

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

Архитектура CPU: Intel
CPU/RAM: аналогично .

Еси вы хотите настроить переменные чарта самостоятельно, .

Подготовка

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

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

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

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

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

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

1 Гб ОЗУ, 1 CPU, 3 Гб на диске
Windows 10+ (рекомендовано)
Linux 64-bit (требуется Python 3.7)

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

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

Убедитесь, что системные характеристики серверов соответствуют рекомендуемым.
Убедитесь, что сервера доступны по локальной сети.
Убедитесь, что к серверам есть доступ по единой учетной записи по SSH c авторизацией по паролю или файлу-ключу и для данной записи доступен без интерактивного .

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

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

Настройки

Запуск

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

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

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

filename – имя файла с настройками (по умолчанию 'settings.yml')
private_key – путь к приватному ssh-ключу (переопределяет соответствующую опцию настроек)
key_password

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

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

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

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

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

settings.yml

# блок авторизации
auth:
  ssh_user: # логин пользователя
  use_sudo: yes # использовать ли sudo
  # полный путь к приватному ssh-ключу. опционально
  ssh_private_key: C:\\cygwin64\\home\\user\\.ssh\\id_rsa 

# блок переменных - может отличаться для вашей поставки
vars:
  # как правило, содержит IP адреса серверов по ролям
  api1: 130.193.58.196
  api2: 178.154.232.159
  bio1: 130.193.59.58
  bio2: 130.193.57.151
  text1: 178.154.232.69
  balancer: 84.201.145.209

  # а также логин и пароль пользователя API с ролью ADMIN
  common-login: [email protected]
  common-password: 123456

# список серверов, как правило, использует значения переменных
# из блока выше и в правке не нуждается
servers:
  oz-api:
    - $api1
    - $api2
  oz-api-balancer: $balancer
  oz-webui:
    - $api1
    - $api2
  oz-webui-balancer:
  oz-webadapter:
    - $api1
    - $api2
  oz-webadapter-balancer: $balancer
  oz-bio:
    - $bio1
    - $bio2
  oz-bio-balancer: $balancer
  oz-text: $text1
  # если в этой строке ничего не указано, при генерации конфигурации API
  # будет использоваться хост сервиса докера, где развернута база данных
  oz-db:

# блок настроек
settings:
  # персональный лицензионный ключ
  license-key: "123456-123456-123456-123456-123456-123456"
  # локальный путь для хранения настроек на каждом сервере
  working-directory: /opt/oz

  # настройки докера
  docker-daemon:
    # подсеть для запуска контейнеров через docker
    bip: 192.168.0.1/24
    # подсети для запуска контейнеров через docker-compose
    default-address-pools:
      - base: 192.168.1.0/24
        size: 24

  # блок настроек Oz API
  oz-api:
    install: yes  # устанавливать ли компоненту
    install-statistic: no # устанавливать ли модуль статистики
    balancer: yes # устанавливать ли балансировщик
    # доменное имя для внешнего доступа к компоненте 
    domain_name:
    # SSL сертификат и ключ для HTTPS-доступа (опционально)
    domain_cert:
    domain_key:
    # путь для сохранения персональных медиа файлов
    media_path:
    # логин/пароль админской учётки на Oz API
    admin:
      login: $common-login
      password: $common-password
    # описание конфигурации смотрите в разделе знаний Oz API
    config:
    # сетевой порт доступа к компоненте 
    # (используется, если не указан SSL-сертификат, иначе 443)
    port: 80

  # блок настроек Oz Liveness Web Adapter
  # описание настроек, подобных Oz API, см. выше
  oz-webadapter:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # адрес http ресурса для автоматической пересылки
    # при попытке зайти по /
    redirect_url:
    config:
    port: 88

  # блок настроек Oz WebUI
  # описание настроек, подобных Oz API, см. выше
  oz-webui:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # Логин/пароль технической учетной записи для настроек синхронизации
    admin:
      login: admin
      password: admin
    config:
    port: 80

  # Блок настроек базы данных для Oz API
  oz-db:
    # устанавливать ли Postgres вместе с установкой Oz API
    # если выбрано no, то используется внешняя служба Pоstgres
    # в обоих случаях адрес сервера берется из блока servers -> oz-db
    install: yes
    # master - пароль Postgres, если выбрана его установка
    psql_password: CHANGEME
    # имя создаваемой базы данных
    database: gateway
    # имя пользователя и пароль базы данных
    user_name: gateway_user
    user_password: CHANGEUSERPASS

  # Блок настроек компоненты Oz Bio (Liveness + Biometry)
  # описание настроек, подобных Oz API, см. выше
  oz-bio:
    install: yes
    balancer: yes
    # настройки и список моделей не предназначены для изменения
    # пользователем
    settings:
    models:

  # Блок настроек компоненты Oz Text
  oz-text:
    # устанавливать ли компоненту
    install: yes
    # прочие настройки менять не рекомендуется
    workers: 2
    group_check:
    auth:
      user_id:
      password:

settings.yml

# блок авторизации
auth:
  ssh_user: # логин пользователя
  use_sudo: yes # использовать ли sudo
  # полный путь к приватному ssh-ключу. опционально
  ssh_private_key: C:\\cygwin64\\home\\user\\.ssh\\id_rsa 

# блок переменных - может отличаться для вашей поставки
vars:
  # как правило, содержит IP адреса серверов по ролям
  api1: 130.193.58.196
  api2: 178.154.232.159
  bio1: 130.193.59.58
  bio2: 130.193.57.151
  text1: 178.154.232.69
  balancer: 84.201.145.209

  # а также логин и пароль пользователя API с ролью ADMIN
  common-login: [email protected]
  common-password: 123456

# список серверов, как правило, использует значения переменных
# из блока выше и в правке не нуждается
servers:
  oz-api:
    - $api1
    - $api2
  oz-api-balancer: $balancer
  oz-webui:
    - $api1
    - $api2
  oz-webui-balancer:
  oz-webadapter:
    - $api1
    - $api2
  oz-webadapter-balancer: $balancer
  oz-bio:
    - $bio1
    - $bio2
  oz-bio-balancer: $balancer
  oz-text: $text1
  # если в этой строке ничего не указано, при генерации конфигурации API
  # будет использоваться хост сервиса докера, где развернута база данных
  oz-db:

# блок настроек
settings:
  # персональный лицензионный ключ
  license-key: "123456-123456-123456-123456-123456-123456"
  # локальный путь для хранения настроек на каждом сервере
  working-directory: /opt/oz

  # настройки докера
  docker-daemon:
    # подсеть для запуска контейнеров через docker
    bip: 192.168.0.1/24
    # подсети для запуска контейнеров через docker-compose
    default-address-pools:
      - base: 192.168.1.0/24
        size: 24

  # блок настроек Oz API
  oz-api:
    install: yes  # устанавливать ли компоненту
    install-statistic: no # устанавливать ли модуль статистики
    balancer: yes # устанавливать ли балансировщик
    # доменное имя для внешнего доступа к компоненте 
    domain_name:
    # SSL сертификат и ключ для HTTPS-доступа (опционально)
    domain_cert:
    domain_key:
    # путь для сохранения персональных медиа файлов
    media_path:
    # логин/пароль админской учётки на Oz API
    admin:
      login: $common-login
      password: $common-password
    # описание конфигурации смотрите в разделе знаний Oz API
    config:
    # сетевой порт доступа к компоненте 
    # (используется, если не указан SSL-сертификат, иначе 443)
    port: 80

  # блок настроек Oz Liveness Web Adapter
  # описание настроек, подобных Oz API, см. выше
  oz-webadapter:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # адрес http ресурса для автоматической пересылки
    # при попытке зайти по /
    redirect_url:
    config:
    port: 88

  # блок настроек Oz WebUI
  # описание настроек, подобных Oz API, см. выше
  oz-webui:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # Логин/пароль технической учетной записи для настроек синхронизации
    admin:
      login: admin
      password: admin
    config:
    port: 80

  # Блок настроек базы данных для Oz API
  oz-db:
    # устанавливать ли Postgres вместе с установкой Oz API
    # если выбрано no, то используется внешняя служба Pоstgres
    # в обоих случаях адрес сервера берется из блока servers -> oz-db
    install: yes
    # master - пароль Postgres, если выбрана его установка
    psql_password: CHANGEME
    # имя создаваемой базы данных
    database: gateway
    # имя пользователя и пароль базы данных
    user_name: gateway_user
    user_password: CHANGEUSERPASS

  # Блок настроек компоненты Oz Bio (Liveness + Biometry)
  # описание настроек, подобных Oz API, см. выше
  oz-bio:
    install: yes
    balancer: yes
    # настройки и список моделей не предназначены для изменения
    # пользователем
    settings:
    models:

  # Блок настроек компоненты Oz Text
  oz-text:
    # устанавливать ли компоненту
    install: yes
    # прочие настройки менять не рекомендуется
    workers: 2
    group_check:
    auth:
      user_id:
      password:

Установка модулей Oz

Стационарный установщик

hashtagЧто это?

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

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

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

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

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

hashtagПодготовка

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

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

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

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

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

hashtagНастройки

hashtagЗапуск

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

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

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

Oz System Lite

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

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

hashtagПрименение

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

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

Oz System Lite

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

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

hashtagПрименение

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

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

Стационарный установщик

hashtagЧто это?

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

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

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

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

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

hashtagПодготовка

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

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

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

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

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

hashtagНастройки

hashtagЗапуск

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

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

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

Установка модулей Oz

Что это?

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

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

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

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

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

Подготовка

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

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

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

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

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

Настройки

Запуск

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

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

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

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

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

Применение

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

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

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

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

Применение

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

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

Что это?

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

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

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

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

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

Подготовка

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

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

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

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

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

Настройки

Запуск

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

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

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