How to install ABBYY Vantage in an OpenShift cluster

ABBYY Vantage is provided as a set of Docker containers running in an OpenShift cluster and interacting with third-party services. 

To install Vantage on-premise, please, open the ABBYY Vantage System Administrator’s Guide, and make sure you are familiar with the described required components and installation procedure.

In this article, we will give you a quick walk-through of the Vantage on-prem deployment procedure, and also provide a demonstration video depicting a Vantage on-prem installation in a real cluster.

Vantage may be deployed on-prem in two configurations:

  1. Highly available. This is a scaling configuration for production, intended to process hundreds of thousands of pages per working day, which we define as eight hours. This configuration also requires additional resources for high-availability features and redundancy fail-safes.
  1. Without high availability. This is used mostly for Proof-of-Concept configurations for demo, test, and trial deployments. It is intended to process up to 10000 pages per working day (eight hours) and has minimal requirements with no fault tolerance features.

Vantage on-prem deployment consists of four steps:

  1. Preparing necessary prerequisite resources and configurations according to the System Requirements specified in the System Administrator’s Guide.
  2. Downloading the container images and specifying the recourse credentials.
  3. Running the installation from the Installer container.
  4. Setting up Vantage after the deployment.

The principal part of installing Vantage on-prem is to meet all the prerequisites. To install ABBYY Vantage, you need several virtual machines, which will become cluster nodes. Also, additional services and resources are required, such as:

       1.  OpenShift Container Platform (Versions: 4.8 and 4.9. Separate OpenShift cluster is preferable).


       2. Four virtual machines to be used as the OpenShift Kubernetes nodes. Depending on the configuration, each virtual machine should meet the following minimum configuration:


High Availability Configuration

Not High Availability Configuration

Operating System

Red Hat CoreOS 4.8+

Red Hat CoreOS 4.8+

Number of CPU cores




36 GB

16 GB

Disk Storage

200 GB

200 GB


At least 1 Gbps

At least 1 Gbps


    3. File Storage accessible via SMB with a throughput of 1 Gbps or more. 


    4. Docker Registry to store images of all containers required for Vantage work. As an option, Harbor Docker Registry can be installed along with Vantage. Docker Registry (for both High Availability Configuration and Not High Availability Configuration) requires a virtual machine with the following minimum configuration:

Operating System

Ubuntu 18.04

CPU cores



4 GB

Disk Storage

1024 GB


At least 1 Gbps

This VM should have a user account with the name “ansible”. The DNS record must be created on the machine to access the Docker Registry.


   5. Database Servers (RDBMS) for Vantage operation and Warehouse:

    1. PostgreSQL is always required.
    2. Microsoft SQL Server is optional and required only for Business Process Reporting installation.

Each virtual machine should meet the following minimum configuration:



Microsoft SQL Server


12.2 or later


Operating System

Linux OS

Linux OS

CPU cores




3 GB

4 GB

Disk storage

400 GB

500 GB


   6. In-memory cache for communications between Vantage components and queueing – required for High Availability configuration only. There are two options: using an existing Redis cluster, or installing a Redis cluster along with Vantage.

    1. The minimum configuration parameters for the existing Redis cluster:



Number of nodes

6 or more

RAM for each node

At least 4 GB

Cluster password

Must be set

 Specific options, other than the standard redis.conf

See Admin Guide

              2. If you install the Redis cluster along with Vantage, the minimum configuration parameters are:

Number of VMs


Operating System

Red Hat CoreOS 4.8+

CPU cores for each VM


RAM for each VM

4 GB

Disk storage for each VM

40 GB

Network for each VM

At least 1 Gbps


   7. SMTP Server, which works via SMTP protocol, and has authentication set up.


   8. Load balancer to distribute incoming requests between Kubernetes nodes.

Traffic from the load balancer should be directed to the OpenShift Kubernetes nodes in the following way:

  1. On port 32443
  2. In TCP mode
  3. With PROXY protocol enabled

The load balancer should have a network connection of 1 Gbps or better on the cluster.


   9. TLS certificate for secured HTTPS communications with Vantage users.


   10. DNS record for further access to Vantage.


After the prerequisites are met, you need to specify the credentials of all required resources. For this, edit the two required configuration files: inventory and env_specific.yml. Download them using the link in the System Administrator’s Guide, and change their parameters using the description from the Admin’s Guide.

When you have completed setting up all the prerequisite dependencies, you need to download the Vantage installation container. Follow the instruction from the Admin’s Guide to find the sample code for this. You will need to:

  1. Download the installer image.
  2. Push the installer image to the docker registry.
  3. Run the installer from the docker image.
  4. Import all other required docker images into your docker registry.

If you have an isolated environment without an Internet connection, then follow the following procedure:

  1. Download the docker images using a machine with an internet connection.
  2. Push the images to the docker registry.
  3. Run the installer from a docker image.

The next step is to run the deployment from the Vantage Installation container. The installation is automatic. The installation is performed by the Ansible tool, which is installed and set up inside the Installer Docker container. You need only to initiate the installation by running two ansible playbooks:

  1. Prepare the appropriate infrastructure:
      • External components check is done at this step.
      • Accept the terms of the Vantage End User License Agreement and Privacy Policy to proceed with the deployment.
      • Skip changing the Docker Registry password, if your registry is used, or set up the password if you install the Docker Registry with Vantage.

      2. Install the product.

Find the sample code that runs the described playbooks in the System Admin’s Guide.


The last step is to set up the newly installed Vantage instance. For this, you need to:

  1. Open Vantage and log in with System Admin login and password – they are displayed in the Terminal at the end of the Vantage installation.
  2. Create a new tenant and assign a subscription.
  3. Start processing documents.


The ABBYY Vantage System Administrator’s Guide contains a comprehensive explanation of all the prerequisites and installation process. Nevertheless, to have a better picture, please watch this 20-minute walk-through video of a live Vantage installation. 




Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request



Please sign in to leave a comment.