Перейти к содержанию

Установка Access#

Данный раздел описывает установку и использование Docker и Docker Compose для развертывания Access.

Docker и Docker Compose не входят в дистрибутив Access.

Подготовка к установке#

Создайте главную директорию, где в дальнейшем будут все версии продукта и перейдите в нее:

sudo mkdir /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).

Подготовка окружения и распаковка дистрибутива#

Дистрибутив представляет собой архив вида «vl-access-2-v2.16.0».

Ссылку для скачивания дистрибутива необходимо запросить у представителя VisionLabs.

Архив содержит компоненты, необходимые для установки и эксплуатации Access.

Архив не включает зависимости, которые входят в стандартную поставку ОС и могут быть загружены из открытых источников.

Запуск Access осуществляется из Docker образа.

Для запуска необходимо выполнить действия:

1․ Переместите скачанный архив vl-access-2-v2.16.0.zip в директорию /var/lib/vl-access-2.

2․ Установите архиватор unzip, если он не установлен. В команде указана версия 6.0-47, более поздние версий утилиты не тестировались:

yum install unzip-6.0-47.el8_10

3․ Распакуйте файлы дистрибутива:

unzip vl-access-2-v2.16.0.zip -d vl-access-2-v2.16.0

4․ Директория содержит:

  • директорию docs с документацией в формате pdf/html;
  • README_FOR_ENGINEERS.md файл c описанием быстрого запуска;
  • .env файл конфигурации;
  • конфигурацию docker-compose.yml;
  • конфигурацию conf.yml;
  • архив изменений CHANGELOG.md;
  • архив с образом vl_access_2_v2.16.0.tar.gz (при наличии).

5․ Перейдите в директорию:

cd vl_access_2_v2.16.0

При работе с дистрибутивом без образа необходимо скачать образ при запуске, см. раздел Запуск

Настройка Access#

Произведите настройку с помощью файла .env (Таблица 7):

nano .env

Таблица 7. Описание параметров env

Параметр

Описание

Значения по умолчанию

Параметры FastAPI и Worker

DEBUG

Режим отладки Access - вывод в логах ОС и в интерфейсе информации типа Debug о работе Access

  • 1 – отладка.
  • 0 – без отладки.

0

VL_ACCESS_TAG

Тэг Access, берется из внутренних настроек. Не рекомендуется изменять этот параметр.

2.16.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 поддерживает только Rabbit MQ.

rabbitmq

RABBITMQ_DEFAULT_USER

Логин пользователя для подключения к Rabbit внешнех систем

guest

RABBITMQ_DEFAULT_PASS

Пароль для подключения к Rabbit внешнех систем

guest

RABBITMQ_PROTOCOL

Тип протокола RabbitMQ. Поддерживается только AMQP.

amqp

RABBITMQ_URL

Адрес для подключения к Rabbit

${RABBITMQ_PROTOCOL}://${RABBITMQ_DEFAULT_USER}: ${RABBITMQ_DEFAULT_PASS}@${RABBITMQ}:5672/

CELERY_BROKER_URL

Адрес для подключения к Celery

${RABBITMQ_PROTOCOL}://${RABBITMQ_DEFAULT_USER}: ${RABBITMQ_DEFAULT_PASS}@${RABBITMQ}:5672/

Параметры подключения 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.16.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.16.0 /var/lib/vl-access-2/current

3․ Запустите Access:

docker-compose up -d

Контейнеры Access поставляются с предустановленными утилитами, необходимыми для работы с образом.

4․ Проверьте доступность Access по адресу: http://<IP_address>:9092/.

Для доступа к интерфейсу Access создайте администратора (см. раздел Управление учетными записями).