Skip to content

Deploying the Access#

This section describes how to install and use Docker and Docker Compose to deploy Access.

Docker and Docker Compose are not included in the Service distribution package.

Preparing for installation#

To install and run Access, the following components are required:

Component Version
Docker Engine 1.13.0 and higher
Docker Compose 1.21.0 and higher
unzip 6.0-21

Create a main directory where all versions of the product will be contained:

sudo mkdir /var/lib/vl-access-2/
sudo chown $(whoami) /var/lib/vl-access-2/

Docker and Docker Compose installation#

Use the official instructions to install Docker Engine and Docker Compose for CentOS. The current installation instructions are presented below.

1․ Install the yum-utils package (which provides the yum-config-manager utility):

sudo yum install -y yum-utils

2․ Set up the stable repository:

sudo yum-config-manager \
    --add-repo \
    https://download.docker.com/linux/centos/docker-ce.repo

3․ Install the latest version of Docker Engine and containerd:

sudo yum install docker-ce docker-ce-cli containerd.io

4․ Check that the installation was done correctly:

docker -v

5․ Download the current stable release of 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․ Apply executable permissions to the binary:

sudo chmod +x /usr/local/bin/docker-compose

7․ Start Docker:

systemctl start docker
systemctl enable docker

8․ Check Docker status:

systemctl status docker

Response must contain Active (running) status.

Preparing and unpacking the distribution#

The distribution package is an archive of the form «vl-access-2-v2.14.0».

A link to download the distribution kit must be requested from a VisionLabs representative.

The archive contains the components necessary for the installation and operation of Access.

The archive does not include dependencies that are included in the standard distribution package of the CentOS 7.4 x86_64 repository and can be downloaded from open sources.

The Service is launched from a Docker image.

Follow these steps:

1․ Move vl-access-2-v2.14.0.zip to /var/lib/vl-access-2.

2․ Install the unzip archiver if it is not installed. The command specifies version 6.0-21, later versions of the utility have not been tested:

yum install unzip-6.0-21.el7

3․ Unpack files:

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

4․ The directory contains:

  • /docs with pdf/html documentation;
  • README_FOR_ENGINEERS.md file with description of quick start;
  • .env configuration file.
  • docker-compose.yml configuration file;
  • CHANGELOG.md changelog;
  • vl_access_2_v2.14.0.tar.gz image archive, if the archive contains an image.

When working with an archive without an image, you need to download the image at startup, see the Launching the Access section.

Setting up Access#

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

nano .env

Parameter

Description

Default values

FastAPI Settings

DEBUG

Access debug mode - output in the OS logs and in the interface of information like Debug about the work of Access 1 — debugging; 0 — without debugging

0

VL_ACCESS_TAG

The Access tag is taken from the internal settings. Changing this parameter is not recommended

2.14.0 |

Redis Settings

REDIS_HOST

Redis host name.

redis

REDIS_PORT

Redis port.

6379

REDIS_DB_BASE

The number of the primary Redis database.

0

REDIS_DB_PERSONS

The number of the Redis database that stores information about people.

1

REDIS_DB_CELERY_BEAT

Redis database number for storing information about periodic worker-beat service tasks.

2

Rabbit Settings

RABBITMQ

Name of the message queue broker. Access only supports Rabbit MQ.

rabbitmq

RABBITMQ_USER

User login to connect to Rabbit MQ

guest

RABBITMQ_DEFAULT_PASSWORD

Password to connect to Rabbit MQ

guest

RABBITMQ_DEFAULT_USER

User login to connect to Rabbit MQ

guest

RABBITMQ_PASSWORD

Password to connect to Rabbit MQ

guest

RABBITMQ_PROTOCOL

RabbitMQ protocol type. Only AMQP is supported

amqp

FrontEnd Settings

BACKEND_HOST

Host of fastapi service. Specify IP address if frontend and fastapi are running on different machines

fastapi

BACKEND_PORT

Port to connect to the Access backend

9091

Celery Settings

CELERY_BROKER_URL

Celery path

CELERY_BROKER_URL=amqp://guest:guest@rabbitmq:5672/

Launching the Access#

1․ Import the image:

1․1. If there is an image in the archive:

docker load -i vl-access-2-images-v2.14.0.tar.gz

1․2. Without image:

docker login dockerhub.visionlabs.ru
docker-compose pull
docker logout dockerhub.visionlabs.ru

2․ Add symlink to the directory /var/lib/vl-access-2/, which links to the latest version of the product:

ln -s /var/lib/vl-access-2-v2.14.0 /var/lib/vl-access-2/current

2․ Run the Service:

docker-compose up -d

3․ Check the availability of the GUI at: http://<IP_address>:9092/.

To access the Access interface, create an administrator (see Account Management).