Установка Access#
Данный раздел описывает установку и использование Docker Compose для развертывания Access.
Docker и Docker Compose не входят в дистрибутив Access.
Docker позволяет создать контейнер, в котором уже имеется требуемый Access, программная среда для него и минимальный набор необходимых инструментов. Docker Compose используется для автоматического развертывания контейнеров.
Подготовка к установке#
Для установки и запуска VL Access, необходимы следующие компоненты:
| Компонент | Версия |
|---|---|
| Docker Engine | 1.13.0 и выше |
| Docker Compose | 1.21.0 и выше |
| unzip | 6.0-21 |
Создайте главную директорию, где в дальнейшем будут все версии продукта:
sudo mkdir /var/lib/vl-access-2/
sudo chown $(whoami) /var/lib/vl-access-2/
Установка Docker и Docker Compose#
Используйте официальную инструкцию для установки Docker Engine и Docker Compose для ОС CentOS. Актуальная на момент написания документа инструкция по установке представлена ниже.
1․ Установите дополнительные зависимости:
sudo yum install -y yum-utils
2․ Добавьте репозиторий Docker в менеджер установки:
sudo yum-config-manager \
--add-repo \
https://download.docker.com/linux/centos/docker-ce.repo
3․ Установите последнюю версию Docker:
sudo yum install docker-ce docker-ce-cli containerd.io
4․ Проверьте корректность установки:
docker -v
5․ Скачайте Docker Compose:
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
6․ Назначьте свойства исполняемого файла:
sudo chmod +x /usr/local/bin/docker-compose
7․ Запустите Docker:
systemctl start docker
systemctl enable docker
8․ Проверьте Docker:
systemctl status docker
Ответ должен содержать статус Active (running).
Подготовка окружения и распаковка дистрибутива#
Дистрибутив представляет собой архив вида «vl-access-2-v2.13.0».
Ссылку для скачивания дистрибутива необходимо запросить у представителя VisionLabs.
Архив содержит все компоненты, необходимые для установки и эксплуатации Access.
Архив не включает зависимости, которые входят в стандартную поставку репозитория CentOS 7.4 x86_64 и могут быть загружены из открытых источников.
Запуск Access осуществляется из Docker образа.
Для запуска необходимо выполнить следующие действия:
1․ Переместите скачанный архив vl-access-2-v2.13.0.zip в директорию /var/lib/vl-access-2.
2․ Установите архиватор unzip, если он не установлен. В команде указана версия 6.0-21, в работе более поздних версий замечены ошибки:
yum install unzip-6.0-21.el7
3․ Распакуйте файлы дистрибутива:
unzip vl-access-2-v2.13.0.zip -d vl-access-2-v2.13.0
4․ После распаковки появится директория, содержащая:
- README_FOR_ENGINEERS.md файл c описанием быстрого запуска;
- .env файл конфигурации;
- конфигурацию docker-compose.yml;
- архив изменений CHANGELOG.md;
- архив образа vl_access_2_v2.13.0.tar.gz.
При отсутствие в дистрибутиве архива образа
vl_access_2_vX.X.X.tar.gz, запросите ссылку для скачивания у представителя VisionLabs.
1․ Добавьте symlink в директорию /var/lib/vl-access-2/, которая ссылается на последнюю версию продукта:
ln -s /var/lib/vl-access-2-v2.13.0 /var/lib/vl-access-2/current
6․ В случае изменения расположения программно-аппаратной части БД в docker-compose, выполните команду для доступа из контейнера к хранению данных PostgreSQL (выполнить единоразово для образа):
docker volume create --name=db_data
Настройка Access#
Произведите настройку с помощью файла .env:
nano .env
| Параметр | Описание | Значения по умолчанию |
|---|---|---|
| Параметры FastAPI и Worker | ||
| DEBUG | Режим отладки Access - вывод в логах ОС и в интерфейсе информации типа Debug о работе Access | 0 |
| 1 – отладка. | ||
| 0 – без отладки. | ||
| DB_DEBUG | Режим отладки БД - вывод в логах ОС и в интерфейсе информации типа Debug о работе БД | 0 |
| 1 – отладка. | ||
| 0 – без отладки. | ||
| VL_ACCESS_TAG | Тэг Access, берется из внутренних настроек. Не рекомендуется изменять этот параметр. | 2.13.0 |
| DB_USER | Логин пользователь базы данных. | postgres |
| DB_HOST | Хост на котором развернута БД. По умолчанию БД разворачивается там же, где и Access. | postgres |
| DB_PORT | Порт на котором развернута БД | 5432 |
| DB_NAME | Имя БД | postgres_base |
| DB_PASSWORD | Пароль пользователя базы данных. | postgres_password |
| LOG_DB_HOST | Имя хоста для сбора логов БД. | elasticsearch |
| LOG_DB_PORT | Порт на котором развернута БД. | 9200 |
| C_FORCE_ROOT | Принудительный запуск Celery от имени root пользователя. | true |
| MAX_CONCURRENCY | Максимальное кол-во процессов у компонента Worker, которые могут обрабатываться параллельно. Задается исходя от нагрузки на систему. | 20 |
| Параметры БД PostgreSQL | ||
| POSTGRES_USER | Логин пользователя базы данных. | postgres |
| POSTGRES_PASSWORD | Пароль пользователя базы данных. | postgres_password |
| POSTGRES_HOST | Хост на котором развернута БД. По умолчанию БД разворачивается там же, где и Access. | postgres |
| Параметры 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 | Название брокера очередей сообщений. В данной версии поддерживается только Rabbit MQ. | rabbitmq |
| RABBITMQ_USER | Логин пользователя для подключения к Rabbit MQ | guest |
| RABBITMQ_PASSWORD | Пароль для подключения к Rabbit MQ | guest |
| RABBITMQ_PROTOCOL | Тип протокола RabbitMQ. Поддерживается только AMQP. | amqp |
| Параметры подключения FrontEnd | ||
| BACKEND_HOST | Хост сервиса fastapi. Указать IP адрес, если frontend и fastapi запущены на разных машинах | fastapi |
| BACKEND_PORT | Порт для подключения к backend Access. | 9091 |
| Параметры Flower | ||
| CELERY_BROKER_URL | Параметры менеджера очередей сообщений Celery | CELERY_BROKER_URL=amqp://guest:guest@rabbitmq:5672/ |
Запуск Access#
1․ Импортируйте образ:
docker load -i vl-access-2-images-v2.13.0.tar.gz
2․ Запустите проект:
docker-compose up -d
3․ Проверьте доступность Access по адресу: http://<IP_address>:9092/.
Для доступа к функционалу Access создайте администратора (см. раздел Управление учетными записями).