Installation instructions
Upload images and create a Kubernetes cluster
Preparation
Download and extract OMNI Platform distribution kit to the machine used for installation. To do this, use the command below:
curl --output platform.zip link to the distribution kit
In the curl request, specify a link to the platform distribution kit (zip file). A link to the folder that contains the distribution kit and accompanying documentation in pdf format will be provided in the email.
Next, move the face_sdk.lic license file (attached to the email) to the setup folder.
The distribution kit contains:
- ./cli.sh: entry point to run the commands
- ./cfg: folder with OMNI Platform configuration files
Further commands are to be executed in the system console from setup directory.
Install the required software
Before installing the main product, you need to install the required software using the script ./cli.sh smc package {OS_NAME} install, provided with the distribution (an internet connection is required).
Supported OS_NAME: ubuntu, astra, centos.
Cluster connections may be blocked due to an active firewall. Disable it with the following command:
sudo systemctl stop firewalld
To ensure the system works correctly, use the following command:
./cli.sh smc system-patch
Upload images
First, upload OMNI Platform images from the archive to the local registry:
./cli.sh generic load-images
Then, upload the infrastructure images from the archive to the local registry:
./cli.sh smc load-images
Uploading can last for about five minutes.
Configuration
Enter environment variables
Open the configuration files below in a text editor, set values for the variables and save changes.
Values set in yaml files via dots denote nesting.
| Configuration File | Variables |
| ./cfg/smc.settings.cfg |
|
| ./cfg/license-server.settings.cfg |
|
| ./cfg/platform.secrets.json |
|
| ./cfg/platform.values.yaml |
|
| ./cfg/platform-ui.values.yaml |
|
The full list of configuration parameters is available here.
Docker settings for GPU usage (optionally)
Docker configuration
To set nvidia-container-runtime as the default low-level runtime, add the following lines to the configuration file located at /etc/docker/daemon.json:
"default-runtime": "nvidia",
"runtimes": {
"nvidia": {
"path": "/usr/bin/nvidia-container-runtime",
"runtimeArgs": []
}
}Applying configuration
To apply configuration, restart docker-service:
sudo systemctl restart docker
Install and configure a cluster
If you already have a deployed cluster, move to Launch Deployment.
To create and configure the cluster, run the following commands:
./cli.sh smc system-patch
./cli.sh smc install
./cli.sh platform db-create-mountpoint
./cli.sh platform install-secrets
This commands:
- Create database mount point.
- Initialize a cluster.
- Install the secrets.
To use GPU in a cluster, install NVIDIA device plugin:
./cli.sh smc nvidia install
Cluster health check
After initializing the master node, make sure that all nodes are ready for operation and have the Ready status. You can check this by running the command below:
kubectl get nodes
As a result, the following output will be displayed in the terminal:
NAME STATUS ROLES AGE VERSION
master-node Ready control-plane,master 11d v1.23.8
To check all cluster components, run the following command:
kubectl get all --all-namespaces
Configure licensing
Install a license server
Before installation, open the ./cfg/license-server.settings.cfg file and set the IP address of the machine, on which the license server will be installed, in the license_server_address field.
Run the command below to install the license server. If license_server_address differs from the host address of the machine where the deployment is taking place, it will be set via sshpass.
./cli.sh license-server install
Run the command to start the license server:
./cli.sh license-server start
Check that the license server is in the running status:
./cli.sh license-server status
Console output example:
floatingserver.service - Floating License Server
Loaded: loaded (/etc/systemd/system/floatingserver.service; enabled; vendor preset: enabled)
Active: active (running) since Tue 2022-12-20 12:25:54 +05; 1min 48s ago
To check that the license server is available, follow http://<license_server_address>:8090 in your web browser. As a result, you should be redirected to the login form.
License activation
Before activation, make sure that the key field (from file ./cfg/license-server.settings.cfg) contains the license key.
Run the license activation command:
./cli.sh license-server activate
When license is successfully activated, the console will return the following result:
[2022-12-20 12:25:53+05:00] INF Activating license key...
[2022-12-20 12:25:54+05:00] INF License activated successfully!
To check the license status after activation, run the command below:
./cli.sh license-server status-license
Example console output:
Activation Status: OK
License key: YOUR-LICENSE-KEY
Days Left To Expiration: 100
Compare the command output with your license information. Days Left To Expiration=14 means that the trial license was automatically activated. In this case, repeat the activation steps.
To activate the license in a closed environment (without internet access), follow the instructions for offline activation.
Before activation, make sure that the license_key field (from file ./cfg/license-server.settings.cfg) contains the license key.
For offline activation, set "1" in the enable_offline_activation field in the license-server.settings.cfg file.
Run the command below to generate an offline license request:
./cli.sh license-server generate-offline
As a result, the request-offline.dat file should appear in the setup directory.
Send the generated request-offline.dat request file to support-platform@3divi.com. The license file will be submitted in the response email.
Copy the received license file to the setup folder.
Open the configuration file license-server.settings.cfg in a text editor and fill in the variable license_offline_activation_file with the license file name and its extension, if present, separated by a dot.
Run the license activation command:
./cli.sh license-server activate
When license is successfully activated, the console will return the following result:
[2022-09-08 01:30:36+05:00] INF Offline activating license key...
[2022-09-08 01:30:36+05:00] INF License activated successfully!
Deployment
Launch deployment
Install Image API:
./cli.sh image-api install
Install Matcher (matcher-router + matcher-shard):
./cli.sh matcher install
To install OMNI Platform, run the following script:
./cli.sh platform install
If necessary, run the installation of OMNI Platform web interface:
./cli.sh platform-ui install
To monitor the deployment progress, open another terminal tab and enter the following command:
watch 'kubectl get pods'
After startup, check the license status. If the received data is not true, insert the license key into the fields license_key (in ./cfg/license-server.settings.cfg) and license-secret.key (in ./cfg/platform. secrets.json) and perform all the steps from here.
Configure DNS server
To provide access to OMNI Platform, DNS server on your network should contain a record that domain is available at <external_ip_address>.
For testing you need to fill in IP address and domain in the /etc/hosts file on Linux or C:\Windows\System32\drivers\etc\hosts on Windows. Just add a new line like <external_ip_address> <ingress.rules.gateway.host> to the end of the file and save the file. The variable values are specified in the ./cfg/smc.settings.cfg and ./cfg/platform.values.yaml files, respectively.
Note that you need to have administrator privileges to edit the hosts file.
To use OMNI Platform at the machine where it was deployed, you can use a script below. It will automatically add the necessary entry to the /etc/hosts file.
./cli.sh generic add-dns - <external_ip_address> <domain>
Description of deployed system
To get the status of OMNI Platform services, run the command below:
kubectl get pods
As result, the console will display a list of services, their statuses, the number of restarts, and the service age.
The example of console output:
NAME READY STATUS RESTARTS AGE
image-api-age-estimator-dep-c66c8f575-zb84s 1/1 Running 0 24h
image-api-body-detector-dep-5588d96ddc-lnrrx 1/1 Running 0 24h
image-api-emotion-estimator-dep-b6c947ff-mz7cw 1/1 Running 0 24h
image-api-face-detector-face-fitter-dep- 1/1 Running 0 24h
image-api-face-detector-liveness-estimator-dep- 2/2 Running 0 24h
image-api-face-detector-template-extractor-dep- 1/1 Running 0 24h
image-api-gender-estimator-dep-7948d8cf85-4hk2q 1/1 Running 0 24h
image-api-mask-estimator-dep-5ccfcc8cb9-sjnqz 1/1 Running 0 24h
image-api-quality-assessment-estimator-dep- 1/1 Running 0 24h
image-api-verify-matcher-dep-6b8f5b4d6f-jjqr4 1/1 Running 0 24h
image-api-template-extractor-dep-64d9d7f6f7-b5bpd 1/1 Running 0 24h
image-api-liveness-estimator-dep-6b757b994c-hd9cn 2/2 Running 0 24h
platform-activity-matcher-dep-8697574c9b-xvh5z 2/2 Running 0 24h
platform-agent-sync-dep-899c9ddc8-7qcvj 1/1 Running 0 24h
platform-backend-dep-685675d648-ngcrj 1/1 Running 0 24h
platform-event-service-dep-5fcd66f999-24jjg 1/1 Running 0 24h
platform-admin-static-dep-f4cd7db78-h86jz 1/1 Running 0 24h
platform-licensing-dep-84d78745d6-2flk2 1/1 Running 0 24h
platform-memcached-dep-64d9d7f6f7-b5bpd 1/1 Running 0 24h
platform-minio-dep-58fc7db749-l457d 1/1 Running 0 24h
platform-postgres-dep-67c5b75b84-fm8wr 1/1 Running 0 23h
platform-rabbit-dep-69cd659f8c-sbnk2 1/1 Running 0 24h
platform-redis-dep-694df659f-9vhrh 1/1 Running 0 24h
platform-ui-dep-78bcb9d878-8mtqx 1/1 Running 0 24h
platform-matcher-adapter-dep-dd947d74c-5cjz7 1/1 Running 0 24h
matcher-router-dep-76b9766867-fcrtl 1/1 Running 0 24h
matcher-shard-dep-0-5c5c786694-wqvpk 1/1 Running 0 24h
Overview of the services is given below:
- platform-activity-matcher-dep is the service used to search for people by activities.
- image-api-age-estimator-dep is the service used to estimate a person’s age from a face image.
- platform-agent-sync-dep is the service responsible for synchronization of profile data with OMNI Agents.
- platform-backend-dep is the main container of OMNI Platform, responsible for how most of API works.
- image-api-body-detector-dep is the service designed to detect bodies in an image.
- platform-rabbit-dep is RabbitMQ service used to work with asynchronous task queue.
- platform-cache-dep is Memcached service used for data caching.
- platform-postgres-dep is an instance of PostgreSQL database that stores all information of OMNI Platform.
- platform-minio-dep is MinIO service used to store images.
- image-api-emotion-estimator-dep is the service that estimates a person's emotions from a face image.
- image-api-face-detector-face-fitter-dep is the service used to determine the anthropometric points of the face and the head rotation angles.
- image-api-face-detector-liveness-estimator-dep is the service used to detect a face and determine if the face in the image is real or fake.
- image-api-face-detector-template-extractor-dep is the service used to detect faces and extract biometric templates.
- image-api-liveness-estimator-dep is the service used to determine if the face in the image is real or fake.
- platform-admin-static-dep is the service responsible for the web interface of Django administration page.
- image-api-gender-estimator-dep is the service used to estimate a person’s gender from a face image.
- platform-licensing-dep is the service that limits the Platform capabilities according to the license parameters.
- image-api-mask-estimator-dep is the service that detects if a person in the image is wearing a medical mask.
- image-api-quality-assessment-estimator-dep is the service designed to assess the quality of the face image.
- platform-redis-dep is Redis service used to work with webSockets.
- image-api-verify-matcher-dep is the service that compares two face images to determine if they belong to the same person.
- platform-event-service-dep is the service used to handle events coming from OMNI Agent.
- platform-ui-dep is the service responsible for OMNI Platform web interface.
- matcher-adapter-dep is the service responsible for synchronizing the platform’s face database and the Matcher Service search index.
- matcher-router is the service used for balancing face search requests on matcher-shards.
- matcher-shard is the service responsible for searching for faces.