Термин | Значение термина |
---|---|
Батч | Группа данных, обрабатываемых одновременно. |
Биометрический образец | Изображения, содержащие лицо или тело и соответствующие стандарту VisionLabs. Используется при работе с LUNA PLATFORM. |
Биометрический шаблон | Набор уникальных свойств, получаемых в LUNA PLATFORM из биометрического образца. |
Детекция | Сущность FaceStream, содержащая координаты лица или тела и оценочное значение объекта, по которому определяется лучший кадр. |
Лучший кадр | Кадр видеопотока, на котором лицо/тело зафиксировано в оптимальном ракурсе для дальнейшей обработки. |
Портрет | Изображение лица или тела, трансформированное под определенный формат. Портрет имеет два типа - “warp” (изображение трансформируется в формат биометрического образца), “gost” (из исходного кадра вырезается детекция с учетом отступов). |
Ракурс | Степень поворота головы (в градусах) по каждой из трех осей вращения (наклон вверх/вниз относительно горизонтальной оси; наклон влево/вправо относительно вертикальной оси; поворот относительно вертикальной оси). |
Событие | Сущность LUNA PLATFORM, которая содержит информацию (город, пользовательские данные, номер трека и т.д.) об одном лице и/или теле. Данная информация передается в LUNA PLATFORM приложением FaceStream. Полный перечень передаваемой информации см. в документации OpenAPI LUNA PLATFORM. |
Трек | Информация о положении объекта (лица) одного человека на последовательности кадров. Если объект покидает зону кадра, то трек прерывается не сразу. Некоторое время он ожидает возвращения объекта в кадр. Если объект вернулся, то трек продолжается. |
Трекинг | Функция отслеживания объекта (лица) на последовательности кадров. |
LUNA Streams | Сервис для создания и управления потоками, которые содержат политики обработки видеопотока/видеофайла/набора изображений. |
Аббревиатура | Расшифровка |
---|---|
БД, DB | База данных |
LP | LUNA PLATFORM |
FaceStream поставляется в Docker-контейнерах и может запускаться на CPU и GPU. Для установки необходимы образы Docker-контейнеров. Для загрузки образов Docker на сервере требуется подключение к сети Интернет, либо образы следует загрузить на любое другое устройство и перенести на сервер. Требуется вручную указать логин и пароль для загрузки образов Docker.
FaceStream можно запустить с помощью скрипта Docker Compose.
Рекомендуется использовать следующие версии Docker и Docker Compose для запуска FaceStream:
Запуск контейнеров FaceStream и LUNA Streams был протестирован на:
В контейнере FaceStream используется следующая ОС:
Для работы FaceStream требуются компоненты LUNA PLATFORM, дополнительные базы данных и сервис LUNA Streams. Основная информация об этом ПО содержится в данном документе.
LUNA Streams не является компонентом LUNA PLATFORM.
Следующие компоненты LUNA PLATFORM используются по умолчанию с FaceStream:
LUNA Licenses используется для лицензирования сервиса LUNA Streams.
LUNA Configurator используется быстрого доступа к основным настройкам FaceStream и настройкам сервисов LUNA PLATFORM.
PostgreSQL используется в качестве базы данных по умолчанию для сервиса LUNA Streams. Также возможно использование базы данных Oracle вместо PostgreSQL.
InfluxDB используется для мониторинга сервисов LUNA PLATFORM. При необходимости мониторинг можно отключить.
Следующие версии баз данных рекомендованы к использованию с LUNA Streams:
Для загрузки настроек в сервис LUNA Configurator требуется наличие Python версии 2.x или 3.x.
Установка и конфигурация Oracle не описывается в данном руководстве. Далее в документе будут приводиться примеры запуска с использованием PostgreSQL.
Балансировщики нагрузки (например, Nginx) и другие программы могут использоваться при масштабировании системы для обеспечения отказоустойчивости. Их конфигурация не описывается в данном руководстве.
Ниже приведены требования для запуска FaceStream в минимальной конфигурации. Требования для использования системы в продуктивном контуре рассчитываются в зависимости от предполагаемой нагрузки.
Дальнейшие минимальные требования приведены для использования одного экземпляра FaceStream.
Для корректной работы приложения аппаратное обеспечение должно отвечать следующим минимальным требованиям:
CPU с частотой 2 ГГц и выше;
4 Гб оперативной памяти и выше;
10 Гб свободного места на жестком диске.
Доступ к Интернету (для контейнеров и дополнительных загрузок ПО).
На аппаратные требования влияют несколько факторов:
Количество обрабатываемых потоков;
Частота и разрешение кадров потоков;
Параметры настройки FaceStream. Настройки по умолчанию являются наиболее универсальными. В зависимости от условий эксплуатации приложения с помощью их значений можно повлиять на качество или производительность.
Следует подбирать аппаратное обеспечение на основе вышеперечисленных факторов.
FaceStream также может работать в режиме ускорения вычислений за счет использования ресурсов видеокарты (см. ниже) и использования AVX2 инструкций. Требуется CPU с поддержкой AVX2. Система автоматически определяет наличие инструкций и запускается в оптимальном режиме.
Вычисления с использованием видеокарты поддерживаются только для детектора FaceDetV3. См. параметр “defaultDetectorType” в настройках FaceEngine (“faceengine.conf”).
Требуется минимум 6Гб оперативной или выделенной видеопамяти. Рекомендуется 8 Гб VRAM или более.
Поддерживаются архитектуры Pascal, Volta, Turing. Требуются Compute Capability 6.1 или выше и CUDA версии 11.4.
Рекомендуемый драйвер NVIDIA - r470.
В данный момент для одного экземпляра FaceStream поддерживается только одна видеокарта.
Для запуска FaceStream с помощью данной документации необходимо наличие запущенной LUNA PLATFORM в соответствии с документацией по установке LUNA PLATFORM. При необходимости можно запустить FaceStream с помощью предварительного запуска минимально необходимых сервисов LUNA Configurator, LUNA Licenses, PostgreSQL и InfluxDB (см. документ “Руководство по установке без запущенной LP”).
Данный документ описывает:
ручной процесс запуска приложения FaceStream и LUNA Streams с помощью Docker.
автоматическое развертывание приложения FaceStream вместе с сервисом LUNA Streams с помощью Docker Compose.
Перед запуском необходимо ознакомиться с общей информацией и последовательностью действий.
Лицензирование FaceStream регулируется особенным параметром лицензионного ключа LUNA PLATFORM 5, определяющим количество потоков для работы LUNA Streams. Таким образом, для работы FaceStream необходима лицензия LUNA PLATFORM 5. Лицензия должна быть активирована перед запуском FaceStream.
Скрипт Docker Compose из данного дистрибутива используется для развертывания LUNA Streams и FaceStream на одном сервере.
Считается, что запуск выполняется на сервере с операционной системой CentOS, где FaceStream не был установлен.
Администратор должен вручную настроить Firewall и SELinux на сервере. В данном документе не описывается их настройка.
Данный документ не включает руководство по использованию Docker. Пожалуйста, обратитесь к документации Docker для более подробной информации:
В данном документе приведены примеры разворачивания FaceStream в минимальной рабочей конфигурации для использования в демонстрационных целях. Данная конфигурация не является достаточной для реальной эксплуатации системы в продуктивном контуре.
Все описываемые команды необходимо исполнять в оболочке Bash (когда команды запускаются напрямую на сервере) или в программе для работы с сетевыми протоколами (в случае удаленного подключения к серверу), например, Putty.
Подробную информацию по общей работе и настройках приложения см. в руководстве администратора FaceStream.
Убедитесь в том, что вы являетесь root-пользователем перед тем, как начать запуск!
Перед запуском FaceStream необходимо выполнить следующие действия:
После выполненных действий можно приступить к ручному или автоматическому запуску LUNA Streams и FaceStream.
Рекомендуется переместить архив в предварительно созданную директорию для FaceStream и распаковать архив в этой директории.
Указанные команды следует выполнять под пользователем root.
Создайте директорию для FaceStream.
mkdir -p /var/lib/fs
Переместите архив в созданную директорию. Предполагается, что архив сохранён на сервере в директории “/root”.
mv /root/facestream_docker_v.5.1.41.zip /var/lib/fs/
Перейдите в директорию.
cd /var/lib/fs/
Установите утилиту unzip, если она ещё не установлена.
yum install unzip
Распакуйте архив.
unzip facestream_docker_v.5.1.41.zip
Создайте символическую ссылку. Символическая ссылка указывает на директорию, в которой хранятся файлы для запуска нужной версии программного продукта.
ln -s facestream_docker_v.5.1.41 fs-current
Docker требуется для запуска контейнера FaceStream.
Установка Docker описана в официальной документации:
https://docs.docker.com/engine/install/centos/.
Если на сервере уже установлен Docker версии 20.10.8, то выполнять повторную установку не требуется. Не гарантируется работа с более высокими версиями Docker.
Ниже перечислены команды для быстрой установки:
При возникновении проблем с установкой обратитесь к официальной документации Docker.
Установите зависимости.
yum install -y yum-utils device-mapper-persistent-data lvm2
Добавьте репозиторий.
yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
Установите Docker.
yum -y install docker-ce docker-ce-cli containerd.io
Запустите Docker.
systemctl start docker
systemctl enable docker
Проверьте, статус запуска Docker.
systemctl status docker
Примечание. Выполняйте установку Docker Compose только если собираетесь использовать скрипт автоматического запуска FaceStream.
Установите Docker Compose.
curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
Для получения более подробной информации обратитесь к официальной документации:
https://docs.docker.com/compose/install/
Существует два способа вывода логов:
Настройки вывода логов сервисов LUNA PLATFORM и сервиса LUNA Streams задаются в секции <SERVICE_NAME>_LOGGER
сервиса Configurator.
Настройки вывода логов FaceStream задаются в настройках logging
секции FACE_STREAM_CONFIG
сервиса Configurator.
При необходимости можно использовать оба способа вывода логов.
Данный способ используется по умолчанию и для него не требуется выполнять дополнительных действий.
Рекомендуется настроить ротацию логов Docker для ограничения их размеров (см. раздел “Настройка ротации логов Docker”).
Примечание. При включении сохранения логов в файле необходимо помнить о том, что логи занимают определенное место в хранилище, а процесс логирования в файл негативно влияет на производительность системы.
Для использования данного способа необходимо выполнить следующие дополнительные действия:
volume
при старте каждого контейнера.В скрипте Docker Compose не настроена синхронизация директорий с папками. Необходимо вручную добавить монтирование папок в файл
docker-compose.yml
.
См. инструкцию по включению записи логов в файлы в разделе “Запись логов на сервер”.
Пропустите данный раздел если не собираетесь использовать FaceStream с GPU.
Для использования GPU с Docker контейнерами необходимо установить NVIDIA Container Toolkit.
Пример установки приведен ниже.
distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.repo | tee /etc/yum.repos.d/nvidia-docker.repo
yum install -y nvidia-container-toolkit
systemctl restart docker
Проверьте работу NVIDIA Container toolkit, запустив базовый контейнер CUDA (он не входит в дистрибутив FaceStream, его необходимо загрузить из Интернета):
Для дополнительной информации см. следующую документацию:
https://github.com/NVIDIA/nvidia-docker#centos-7x8x-docker-ce-rhel-7x8x-docker-ce-amazon-linux-12.
Извлечение атрибутов на GPU разработано для максимальной пропускной способности. Выполняется пакетная обработка входящих изображений. Это снижает затраты на вычисления для изображения, но не обеспечивает минимальную задержку для каждого изображения.
GPU-ускорение разработано для приложений с высокой нагрузкой, где количество запросов в секунду достигает тысяч. Нецелесообразно использовать ускорение GPU в сценариях с небольшой нагрузкой, когда задержка начала обработки имеет значение.
Для запуска FaceStream с GPU через Docker Compose необходимо, кроме вышеописанных действий, добавить секцию deploy
в поле facestream
в файл docker-compose.yml
.
Перед запуском контейнера FaceStream с GPU требуется включить использование GPU для вычислений в настройках FaceStream с помощью параметра “enable_gpu_processing” (см. раздел “Настройки FaceStream” в руководстве администратора).
vi /var/lib/fs/fs-current/example-docker/docker-compose.yml
facestream:
image: ${REGISTRY_ADDRESS}:${DOCKER_REGISTRY_PORT}/facestream:${FS_VER}
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: all
capabilities: [gpu]
restart: always
environment:
CONFIGURATOR_HOST: ${HOST_CONFIGURATOR}
CONFIGURATOR_PORT: 5070
driver
- в данном поле указывается драйвер для зарезервированного устройства(устройств);
count
- в данном поле задается количество графических процессоров, которые должны быть зарезервированы (при условии, что хост содержит такое количество графических процессоров);
capabilities
- данное поле выражает как общие, так и специфические возможности драйвера. Его необходимо задать, иначе будет возвращена ошибка при развертывании сервиса.
Для дополнительной информации см. следующую документацию:
https://docs.docker.com/compose/gpu-support/#enabling-gpu-access-to-service-containers.
При запуске контейнеров необходимо указать ссылку на образ, необходимый для запуска контейнера. Этот образ загружается из VisionLabs registry. Перед этим необходима авторизация.
Логин и пароль можно запросить у представителя VisionLabs.
Введите логин <username>.
docker login dockerhub.visionlabs.ru --username <username>
После выполнения команды будет запрошен ввод пароля. Введите пароль.
В команде
docker login
можно вводить логин и пароль одновременно, однако это не гарантирует безопасность, т.к. пароль можно будет увидеть в истории команд.
Если сервисы LUNA PLATFORM уже запущены и лицензия с параметром, регулирующим количество потоков для работы LUNA Streams, уже активирована, то необходимо убедиться в том, что текущий ключ LUNA PLATFORM содержит данный параметр. Информация может быть предоставлена специалистами VisionLabs.
Если данный параметр не содержится в ключе, то необходимо запросить новый ключ и обратиться к специалистам VisionLabs для консультации по обновлению лицензионного ключа.
Существует два способа запуска FaceStream - ручной и автоматический с помощью скрипта Docker Compose.
Используйте гиперссылки ниже для перехода к инструкции по необходимому способу запуска:
Примечание. Выполняйте данные действия только если собираетесь запускать FaceStream вручную. Если собираетесь запускать FaceStream с помощью скрипта Docker Compose перейдите в раздел “Запуск FaceStream с помощью Docker Compose”.
Основные настройки LUNA Streams и FaceStream должны быть заданы в сервисе Configurator после его запуска. Исключением являются настройки FaceEngine, которые задаются в конфигурационном файле “faceengine.conf” и передаются во время запуска контейнера FaceStream.
При необходимости можно использовать вместо настроек сервиса Configurator конфигурационные файлы и передавать их во время запуска контейнера (для дополнительной информации см. раздел “Использование FaceStream с конфигурационными файлами” руководства администратора).
Настройки FaceStream и LUNA Streams загружаются в Configurator по-разному.
Для загрузки настроек LUNA Streams в сервис Configurator, необходимо использовать механизм миграции конфигураций.
docker run \
-v /etc/localtime:/etc/localtime:ro \
-v /tmp/logs/streams:/srv/logs \
--entrypoint=/bin/bash \
--rm \
--network=host \
dockerhub.visionlabs.ru/luna/streams-configs:v.0.6.35 \
-c "python3 -m streams_configs.migrate head --config_db_url postgres://luna:luna@127.0.0.1:5432/luna_configurator"
--config_db_url postgres://luna:luna@127.0.0.1:5432/luna_configurator
- флаг указания адреса БД luna_configurator
Настройки FaceStream расположены в специальном файле “facestream_dump.json”. Для загрузки этих настроек в сервис LUNA Configurator, необходимо использовать скрипт “load_dump.py”.
Для использования скрипта “load_dump.py” требуется наличие Python версии 2.x или 3.x. Если установлена версия 2.x, то скрипт нужно запускать с помощью команды
python
. Если же установлена версия 3.х, то скрипт нужно запускать с помощью командыpython3
.
cd /var/lib/fs/fs-current/example-docker/luna_configurator/dumps/
python3 -m load_dump --dump-file=facestream_dump.json --luna-config=http://127.0.0.1:5070/1
Все необходимые параметры будут автоматически добавлены в сервис LUNA Configurator.
Для запуска FaceStream необходимо запустить сервис LUNA Streams, создав и инициализировав для него БД. Данный сервис не входит в поставку LUNA PLATFORM 5, поэтому должен быть запущен отдельно.
Создайте базу данных для LUNA Streams:
docker exec -i postgres psql -U luna -c "CREATE DATABASE luna_streams;"
Дайте возможность пользователю авторизоваться в БД:
docker exec -i postgres psql -U luna -c "GRANT ALL PRIVILEGES ON DATABASE luna_streams TO luna;"
Активируйте PostGIS:
docker exec -i postgres psql -U luna luna_streams -c "CREATE EXTENSION postgis;"
Инициализируйте данные в БД LUNA Streams:
docker run -v /etc/localtime:/etc/localtime:ro \
--rm \
--network=host \
dockerhub.visionlabs.ru/luna/luna-streams:v.0.6.35 \
python3 ./base_scripts/db_create.py --luna-config http://localhost:5070/1
Запуск контейнера осуществляется следующей командой:
docker run \
--env=CONFIGURATOR_HOST=127.0.0.1 \
--env=CONFIGURATOR_PORT=5070 \
--env=PORT=5160 \
--env=WORKER_COUNT=1 \
--env=RELOAD_CONFIG=1 \
--env=RELOAD_CONFIG_INTERVAL=10 \
-v /etc/localtime:/etc/localtime:ro \
-v /tmp/logs/streams:/srv/logs \
--name=luna-streams \
--restart=always \
--detach=true \
--network=host \
dockerhub.visionlabs.ru/luna/luna-streams:v.0.6.35
Для проверки корректности запуска сервиса можно выполнить GET-запрос http://127.0.0.1:5160/version
. В ответе должна вернуться версия LUNA Streams v.0.6.35.
Запуск контейнера осуществляется следующим образом:
docker run \
--env=CONFIGURATOR_HOST=127.0.0.1 \
--env=CONFIGURATOR_PORT=5070 \
-v /var/lib/fs/fs-current/extras/conf/configs/faceengine.conf:/srv/facestream/data/faceengine.conf \
-v /var/lib/fs/fs-current/extras/conf/configs/runtime.conf:/srv/facestream/data/runtime.conf \
-v /etc/localtime:/etc/localtime:ro \
-v /tmp/logs/facestream:/srv/logs \
--env=PORT=34569 \
--detach=true \
--restart=always \
--name=facestream \
--network=host \
dockerhub.visionlabs.ru/luna/facestream:v.5.1.41
Описание остальных параметров и ключей запуска см. в разделе “Описание ключей запуска”.
Для проверки корректности запуска можно выполнить GET-запрос http://127.0.0.1:34569/version
. В ответе должна вернуться версия FaceStream.
Примечание. Используйте данную команду только если собираетесь использовать FaceStream с GPU.
Перед запуском FaceStream в режиме GPU необходимо установить дополнительные зависимости (см. раздел “Установка зависимостей для GPU”).
Перед запуском контейнера FaceStream с GPU требуется включить использование GPU для вычислений в настройках FaceStream с помощью параметра “enable_gpu_processing” (см. раздел “Настройки FaceStream” в руководстве администратора).
docker run \
--env=CONFIGURATOR_HOST=127.0.0.1 \
--env=CONFIGURATOR_PORT=5070 \
-v /var/lib/fs/fs-current/extras/conf/configs/faceengine.conf:/srv/facestream/data/faceengine.conf \
-v /var/lib/fs/fs-current/extras/conf/configs/runtime.conf:/srv/facestream/data/runtime.conf \
-v /etc/localtime:/etc/localtime:ro \
-v /tmp/logs/facestream:/srv/logs \
--env=PORT=34569 \
--gpus device=0 \
--detach=true \
--restart=always \
--name=facestream \
--network=host \
dockerhub.visionlabs.ru/luna/facestream:v.5.1.41
--gpus device=0
- параметр указывает используемое устройство GPU и позволяет использовать GPU. Один GPU используется для одного экземпляра FaceStream. Использование множества GPU для одного экземпляра невозможно.
Описание остальных параметров и ключей запуска см. в разделе “Описание ключей запуска”.
Для проверки корректности запуска можно выполнить GET-запрос http://127.0.0.1:34569/version
. В ответе должна вернуться версия FaceStream.
Скрипт Docker Compose:
загружает настройки LUNA Streams и FaceStream в Configurator
создает и инициализирует БД LUNA Streams
запускает LUNA Streams и FaceStream
тестируется с использованием настроек LUNA Streams и FaceStream по умолчанию.
не предназначен для использования в целях масштабирования FaceStream:
Не используется для развертывания FaceStream на нескольких серверах.
Не используется для развертывания и балансирования нескольких экземпляров FaceStream на одном сервере.
поддерживает использование GPU для вычислений FaceStream.
не обеспечивает возможность использования внешней базы данных для LUNA Streams, уже установленной на сервере.
не выполняет миграции из предыдущих версий FaceStream и обновления предыдущих сборок FaceStream.
См. файл “docker-compose.yml” и другие файлы в директории “example-docker” для получения дополнительной информации.
Можно написать собственный скрипт, который разворачивает и конфигурирует все необходимые сервисы LP и FaceStream. Данный документ не включает информацию о создании скриптов и не обучает использованию Docker. Обратитесь к документации Docker для получения подробной информации о Docker и Docker Compose:
Откройте директорию Docker Compose:
cd /var/lib/fs/fs-current/example-docker
Убедитесь в том, что контейнер FS не запущен до выполнения скрипта. Попытка запустить контейнер с таким же именем, как существующий контейнер, приведет к ошибке. Если контейнер запущен, необходимо остановить его с помощью команды
docker container rm -f <container_name>
. Чтобы остановить все контейнеры, используйтеdocker container rm -f $(docker container ls -aq)
.
Для запуска FaceStream с GPU с помощью Docker Compose необходимо выполнить действия, описанные в разделе “Установка зависимостей для GPU”.
Запуск FaceStream через Docker Compose:
Необходимо выполнить вход в VisionLabs registry (см. раздел “Вход в registry”)
./start_facestream.sh --configurator_address=127.0.0.1
--configurator_address=127.0.0.1
- адрес сервиса Configurator
Проверьте статус всех запущенных Docker контейнеров.
docker ps
Список потоков доступен по адресу
http://127.0.0.1:34569/api/1/streams/
. Просмотр потока в браузере доступен по адресуhttp://127.0.0.1:34569/api/1/streams/preview/<stream_id>
.
Для дальнейшей работы с FaceStream необходимо создать поток с помощью POST-запроса “create stream” к сервису LUNA Streams. Поток содержит политики обработки видеопотока/видеофайла/набора изображений. Если поток создается со статусом “pending” (по умолчанию), то “рабочий процесс” FaceStream автоматически начнет обработку потока.
См. подробную информацию работе с потоками и LUNA Streams в разделе “Взаимодействие FaceStream с LUNA Streams” руководства администратора.
Список обрабатываемых потоков доступен по адресу http://127.0.0.1:34569/api/1/streams/
. Просмотр потока в браузере доступен по адресу http://127.0.0.1:34569/api/1/streams/preview/<stream_id>
.
В данном разделе приводится следующая дополнительная информация:
Чтобы показать список запущенных Docker контейнеров, используйте команду:
docker ps
Чтобы показать все имеющиеся Docker контейнеры, используйте команду:
docker ps -a
Можно переносить файлы в контейнер. Используйте команду docker cp
для копирования файла в контейнер.
docker cp <file_location> <container_name>:<folder_inside_container>
Можно входить в отдельные контейнеры с помощью следующей команды:
docker exec -it <container_name> bash
Для выхода из контейнера используйте следующую команду:
exit
Можно увидеть все имена образов с помощью команды
docker images
Просмотреть логи контейнера можно с помощью следующей команды:
docker logs <container_name>
Если требуется удаление образа:
docker images
docker rmi -f 61860d036d8c
Удаление всех существующих образов:
docker rmi -f $(docker images -q)
Контейнер можно остановить с помощью следующей команды:
docker stop <container_name>
Остановка всех контейнеры:
docker stop $(docker ps -a -q)
Если необходимо удалить контейнер:
docker container rm -f 23f555be8f3a
Удаление всех контейнеров:
docker container rm -f $(docker container ls -aq)
Ключи запуска задаются с помощью переменных окружения:
--env=
- этот параметр задает переменные окружения, требуемые для запуска контейнера. Указываются следующие основные значения:
CONFIGURATOR_HOST
- хост, на котором запущен сервис Configurator. Локальный хост задается в случае, если контейнер запущен на том же сервере, где работает Configurator.CONFIGURATOR_PORT
- порт прослушивания для сервиса Configurator. По умолчанию используется порт 5070.PORT
- порт, где FaceStream будет слушать.STREAMS_ID
- в теге задается список идентификаторов потоков, которые будут запрошены из LUNA Streams для обработки. Остальные потоки будут отфильтрованы. Параметр “stream_id” выдается в ответе на запрос “create stream”.
Если значение равно “ ” или тег “STREAMS_ID” не задан, то FaceStream будет брать из очереди все существующие “stream_id”.
Если задано несуществующее значение, то при запуске FaceStream будет указана ошибка о некорректном UUID.
По умолчанию значение равно “ ”.
Для использования ключа должны быть указаны переменные “CONFIGURATOR_HOST” и “CONFIGURATOR_PORT”.
STREAMS_NAME
- в теге задается список имен потоков. Имена потоков задаются с помощью параметра “name” во время их создания (запрос “create streams”). Потоки с данными именами будут запрошены из LUNA Streams для обработки. Остальные потоки будут отфильтрованы.
В остальном принцип работы схож с тегом “STREAMS_ID”.
GROUPS_ID
и GROUPS_NAME
- в тегах задаются список идентификаторов групп или список имён групп. Параметры “group_id” или “group_name” задаются во время создания потока (запрос “create stream”). Потоки с данными параметрами будут запрошены из LUNA Streams для обработки. Остальные потоки будут отфильтрованы.
Если значение равно “ ” или теги “GROUPS_ID”/“GROUPS_NAME” не заданы, то FaceStream не будет фильтровать потоки по группам.
Если задано несуществующее значение, то при запуске FaceStream будет указана ошибка о некорректном UUID.
По умолчанию значение равно “ ”.
Для использования ключей должны быть указаны переменные “CONFIGURATOR_HOST” и “CONFIGURATOR_PORT”.
Для тегов “STREAMS_NAME”, “STREAMS_ID”, “GROUPS_NAME” и “GROUPS_ID” можно задать несколько значений. Пример синтаксиса: –env=STREAMS_ID=“037f3196-c874-4eca-9d7c-91fd8dfc9593 4caf7cf7-dd0d-4ad5-a35e-b263e742e28a”
CONFIGS_ID
- тег LUNA Configurator, который связан с основными конфигурациями для работы FaceStream. Единый тег должен быть задан для “TRACK_ENGINE_CONFIG” и “FACE_STREAM_CONFIG”.
Если задано значение “ ”, то будут использованы записи по умолчанию “TRACK_ENGINE_CONFIG” и “FACE_STREAM_CONFIG” из LUNA Configurator. Если запись по умолчанию не существует или содержит недопустимый для JSON синтаксис, то будет использован конфигурационный файл из комплекта поставки.
По умолчанию значение равно “ ”.
Для использования ключа должны быть указаны переменные “CONFIGURATOR_HOST” и “CONFIGURATOR_PORT”.
CONFIG_RELOAD
- тег, включающий проверку наличия изменений в секции “FACE_STREAM_CONFIG” сервиса LUNA Configurator и принимающий следующие значения:
По умолчанию значение равно “1”.
PULLING_TIME
- тег, задающий период получения новых параметров из секции “FACE_STREAM_CONFIG” сервиса LUNA Configurator в диапазоне [1…3600] сек. Используется совместно с тегом “CONFIG-RELOAD”.
По умолчанию значение равно “10”.
--device=
- данный параметр необходим для указания адреса USB устройства. Адрес должен быть указан в источнике потока при его создании. Пример: --device=/dev/video0
.
См. принцип работы FaceStream с LUNA Configurator в разделе “Использование FaceStream с LUNA Configurator” руководства администратора.
Ниже приведена расшифровка параметров запуска контейнера:
docker run
- команда для запуска выбранного образа в качестве нового контейнера.-v
- параметр volume позволяет загружать содержимое серверной папки в объем контейнера. Таким образом содержимое синхронизируется.-v /var/lib/fs/fs-current/extras/conf/configs/faceengine.conf:/srv/facestream/data/faceengine.conf \
- этот параметр позволяет использовать настройки FaceEngine из конфигурационного файла “faceengine.conf”.-v /var/lib/fs/fs-current/extras/conf/configs/runtime.conf:/srv/facestream/data/runtime.conf \
- этот параметр позволяет монтировать конфигурационный файл среды выполнения в контейнер FaceStream. Перед изменением стандартных настроек требуется проконсультироваться со специалистами VisionLabs.--network=host
- этот параметр указывает, что отсутствует симуляция сети и используется серверная сеть. При необходимости изменить порт для сторонних контейнеров следует заменить эту строку на -p 5440:5432
. Здесь первый порт 5440
- это локальный порт, а 5432
- это порт, используемый в контейнере./etc/localtime:/etc/localtime:ro
- задает текущий часовой пояс, используемый системой контейнера.--name=facestream
- этот параметр задает имя запускаемого контейнера. Имя должно быть уникальным. Если уже существует контейнер с таким же именем, произойдет ошибка.--restart=always
- этот параметр определяет политику перезагрузки. Daemon всегда перезагружает контейнер вне зависимости от кода завершения.--detach=true
- запуск контейнера в фоновом режиме.Чтобы включить сохранение логов на сервер, необходимо:
volume
при старте каждого контейнера.В скрипте Docker Compose не настроена синхронизация директорий с папками. Необходимо вручную добавить монтирование папок в файл
docker-compose.yml
.
Ниже приведены примеры команд для создания директорий для хранения логов и присвоения им прав для FaceStream и LUNA Streams.
mkdir -p /tmp/logs/facestream /tmp/logs/streams
chown -R 1001:0 /tmp/logs/facestream /tmp/logs/streams
Для активации записи в файл необходимо задать настройки log_to_file
и folder_with_logs
в секции <SERVICE_NAME>_LOGGER
настроек LUNA Streams.
Перейдите в интерфейс сервиса Configurator (127.0.0.1:5070
) и задайте путь расположения логов в контейнере в параметре folder_with_logs
для сервиса LUNA Streams. Например, можно использовать путь /srv/logs
.
Установите параметр log_to_file
как true
чтобы активировать запись логов в файл.
Для активации записи логов в файл необходимо задать значение настройки logging > mode
в секции FACE_STREAM_CONFIG
на l2f
(выводить логи только в файл) или l2b
(выводить логи и файл и в консоль).
Перейдите в интерфейс сервиса Configurator (127.0.0.1:5070
) и укажите необходимое значение настройки. Путь расположения логов в контейнере FaceStream невозможно изменить. Необходимо указывать путь /srv/logs
при монтировании.
По умолчанию в логах FaceStream выводятся только предупреждения системы. С помощью настройки параметра “severity” можно включить вывод ошибок (см. описание параметра в руководстве администратора).
Директория с логами монтируется с помощью следующего аргумента при старте контейнера:
-v <server_logs_folder>:<container_logs_folder> \
где <server_logs_folder>
директория, созданная на этапе создания директории логов, а <container_logs_folder>
директория, созданная на этапе активации записи логов.
Пример команды запуска FaceStream с монтированием директории с логами:
docker run \
--env=CONFIGURATOR_HOST=127.0.0.1 \
--env=CONFIGURATOR_PORT=5070 \
-v /var/lib/fs/fs-current/extras/conf/configs/faceengine.conf:/srv/facestream/data/faceengine.conf \
-v /var/lib/fs/fs-current/extras/conf/configs/runtime.conf:/srv/facestream/data/runtime.conf \
-v /etc/localtime:/etc/localtime:ro \
-v /tmp/logs/facestream:/srv/logs \
--env=PORT=34569 \
--detach=true \
--restart=always \
--name=facestream \
--network=host \
dockerhub.visionlabs.ru/luna/facestream:v.5.1.41
Примеры команд запуска контейнеров ручным способом содержат эти аргументы.
Чтобы ограничить размер логов, генерируемых Docker, можно настроить автоматическую ротацию логов. Для этого необходимо добавить в файл /etc/docker/daemon.json
следующие данные:
{
"log-driver": "json-file",
"log-opts": {
"max-size": "100m",
"max-file": "5"
}
}
Это позволит Docker хранить до 5 файлов логов на контейнер, при этом каждый файл будет ограничен 100 Мб.
После изменения файла необходимо перезапустить Docker:
systemctl reload docker
Вышеописанные изменения являются значениями по умолчанию для любого вновь созданного контейнера, они не применяются к уже созданным контейнерам.