Установка Access#
Данный раздел описывает установку и использование Docker и Docker Compose для развертывания Access.
Docker и Docker Compose не входят в дистрибутив Access.
Процесс настройки и установки необходимо выполнять под учетной записью суперпользователя (с root правами).
В руководстве приведены команды для CentOS.
Подготовка к установке#
Создайте главную директорию, где в дальнейшем будут все версии продукта и перейдите в нее:
sudo mkdir -p -v /var/lib/vl-access-2/
sudo chown $(whoami) /var/lib/vl-access-2/
cd /var/lib/vl-access-2/
Установка Docker и Docker Compose#
Используйте официальную инструкцию для установки Docker Engine и Docker Compose для используемой ОС.
Перед запуском Access необходимо убедиться что Docker запущен и активен.
1． Запустите Docker:
systemctl start docker
systemctl enable docker
2． Проверьте Docker:
systemctl status docker
Ответ должен содержать статус Active (running).
3． Проверьте установку Docker Compose:
docker-compose --version
В ответе должна быть указана версия docker-compose, например:
docker-compose version 1.29.2, build 5becea4.
Подготовка окружения и распаковка дистрибутива#
Дистрибутив представляет собой архив вида «vl-access-2-v2.19.0».
Ссылку для скачивания дистрибутива необходимо запросить у представителя VisionLabs.
Архив содержит компоненты, необходимые для установки и эксплуатации Access.
Архив не включает зависимости, которые входят в стандартную поставку ОС и могут быть загружены из открытых источников.
Запуск Access осуществляется из Docker образа.
Для запуска необходимо выполнить действия:
1． Переместите скачанный архив vl-access-2-v2.19.0.zip в директорию /var/lib/vl-access-2.
2． Установите архиватор unzip, если он не установлен.
yum install unzip
Команда установки может отличаться в зависимости от менеджера пакетов в ОС, например в Ubuntu/Debian используется
apt, а в AlmaLinuxdnf.
3． Распакуйте файлы дистрибутива:
unzip vl-access-2-v2.19.0.zip -d vl-access-2-v2.19.0
Дистрибутив содержит (Таблица 7):
Таблица 7. Состав дистрибутива
| Имя директории | Описание |
|---|---|
| /db | Набор файлов для работы с JSON-хранилищем (создается автоматически после запуска Access). |
| /docs | Директория содержащая документацию по Access. |
| .env | Конфигурационный файл для настройки переменных среды. |
| CHANGELOG.md | Полное описание изменений версий. |
| docker-compose.yml | Файл содержащий команды запуска docker контейнеров. |
| conf.yml | Файл содержащий конфигурации для сервиса log-agent. |
| README_FOR_ENGINEERS.md | Краткое руководство по запуску для инженеров внедрения. |
| /scripts | Директория с полезными скриптами см. Руководство администратора. |
| vl-access-2-images-v2.19.0.tar.gz | Дистрибутив Access, при выборе архива с образом. |
| /tls | Директория для хранения сертификатов взаимодействия с внешними системами в формате .pem (создается автоматически после запуска Access). |
4． Перейдите в директорию:
cd vl-access-2-v2.19.0
При работе с дистрибутивом без образа необходимо скачать образ при запуске, см. раздел Запуск
Настройка Access#
Произведите настройку с помощью файла .env (Таблица 8):
nano .env
Таблица 8. Описание параметров env
|
Параметр |
Описание |
Значения по умолчанию |
|
Параметры FastAPI и Worker |
||
|
DEBUG |
Режим отладки Access - вывод в логах ОС и в интерфейсе информации типа Debug о работе Access
|
0 |
|
VL_ACCESS_TAG |
Тэг Access, берется из внутренних настроек. Не рекомендуется изменять этот параметр. |
2.19.0 | |
|
LOG_DB_HOST |
Имя хоста для хранение логов. |
log-storage |
|
LOG_DB_PORT |
Порт для подключения к log-storage. |
27017 |
|
LOG_DB_NAME |
Имя БД логов. |
logs |
|
LOG_DB_USER |
Имя пользователя БД логов. |
username |
|
LOG_DB_PASSWORD |
Пароль пользователя БД логов. |
password |
|
C_FORCE_ROOT |
Принудительный запуск Celery от имени root пользователя. |
true |
|
WORKER_CONCURRENCY |
Максимальное кол-во процессов у компонента Worker, которые могут обрабатываться параллельно. Задается исходя от нагрузки на систему. |
16 |
|
WORKERS_AMOUNT |
Количество инстансов worker (необходим для увеличения количества обрабатываемых событий, используется на высоконагруженных объектах). |
1 |
|
Параметры Redis |
||
|
REDIS_HOST |
Имя хоста Redis. |
redis |
|
REDIS_PORT |
Порт, на котором развернут Redis. |
6379 |
|
REDIS_DB_BASE |
Номер основной базы данных Redis. |
0 |
|
REDIS_DB_PERSONS |
Номер базы данных Redis, хранящей информацию о людях. |
1 |
|
REDIS_DB_CELERY_BEAT |
Номер базы данных Redis для хранения информации о периодических задачах сервиса worker-beat. |
2 |
|
Параметры Rabbit |
||
|
RABBITMQ |
Название брокера очередей сообщений. Access поддерживает только RabbitMQ. |
rabbitmq |
|
RABBITMQ_DEFAULT_USER |
Логин пользователя для подключения к RabbitMQ внешних систем |
guest |
|
RABBITMQ_DEFAULT_PASS |
Пароль для подключения к RabbitMQ внешних систем |
guest |
|
RABBITMQ_PROTOCOL |
Тип протокола RabbitMQ. Поддерживается только AMQP. |
amqp |
|
RABBITMQ_URL |
Адрес для подключения к RabbitMQ |
|
|
CELERY_BROKER_URL |
Адрес для подключения к брокеру Celery |
|
|
Параметры подключения FrontEnd |
||
|
BACKEND_HOST |
Хост сервиса fastapi. Указать IP адрес, если frontend и fastapi запущены на разных машинах |
fastapi |
|
BACKEND_PORT |
Порт для подключения к backend Access. |
9091 |
Запуск Access#
1． Импортируйте образ:
1．1. При наличии образа в архиве
docker load -i vl-access-2-images-v2.19.0.tar.gz
1．2. Без образа:
docker login dockerhub.visionlabs.ru
docker-compose pull
docker logout dockerhub.visionlabs.ru
2． Добавьте symlink в директорию /var/lib/vl-access-2/, которая ссылается на последнюю версию продукта:
ln -s /var/lib/vl-access-2-v2.19.0 /var/lib/vl-access-2/current
3． Запустите Access:
docker-compose up -d
Контейнеры Access поставляются с предустановленными утилитами, необходимыми для работы с образом.
4． Проверьте доступность Access по адресу: http://<IP_address>:9092/.
Для доступа к интерфейсу Access создайте администратора (см. раздел Управление учетными записями).