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 (Table 7).

Table 8. Required utilities

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

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 your operation system.

Before starting Access, you need to make sure that Docker is running and active.

1․ Start Docker:

systemctl start docker
systemctl enable docker

2․ 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.15.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 OS and can be downloaded from open sources.

The Service is launched from a Docker image.

Follow these steps:

1․ Move vl-access-2-v2.15.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

3․ Unpack files:

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

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.15.0.tar.gz image archive, if the archive contains an image.

5․ Change directory:

cd vl_access_2_v2.15.0

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 (Table 8).

nano .env

Table 9. Env description

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

DEBUG_DB

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

0

LOG_DB_HOST

Hostname for storing elasticsearch logs

elasticsearch

LOG_DB_PORT

Port for connecting to elasticsearch

9200

C_FORCE_ROOT

Force Celery to run as root user.

true

WORKER_CONCURRENCY

The maximum number of processes for the Worker component that can be processed in parallel. It is set based on the load on the system.

1...16

WORKERS_AMOUNT

Number of worker instances

1

VL_ACCESS_TAG

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

2.15.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

RABBITMQ_URL

Address to connect to Rabbit

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

CELERY_BROKER_URL

Address to connect to Celery

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

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

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.15.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.15.0 /var/lib/vl-access-2/current

3․ Run the Service:

docker-compose up -d

Access containers come pre-installed with popular utilities.

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

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