Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Contrail Insights Installation for OpenStack in HA

HA Design Overview

Contrail Insights Platform can be deployed to multiple hosts for high availability (HA). Platform services continue to communicate using an API proxy that listens on a virtual IP address. Only one host will have the virtual IP at a time, and so only one API proxy will be the “active” API proxy at a time.

The API proxy is implemented by HAProxy. HAProxy is configured to use services in active-standby or load-balanced active-active mode, depending on the service.

At most, one host will be assigned the virtual IP at any given time. This host is considered the “active” HAproxy. The virtual IP address is assigned to a host by keepalived, which uses VRRP protocol for election.

Services are replicated in different modes of operation. In the “active-passive” mode, HAProxy sends all requests to a single “active” instance of a service. If the service fails, then HAProxy will select a new “active” from the other hosts, and begin to send requests to the new “active” service.In the “active-active” mode, HAProxy load balances requests across hosts on which a service is operational.

Contrail Insights Platform can be deployed in a 3-node, 5-node, or 7-node configuration for high availability.


  • For each host, on which Contrail Insights Platform is installed, see Contrail Insights General Requirements for hardware and software requirements. For a list of Contrail Insights Agent supported platforms, see Contrail Insights Agent Requirements.

  • Note:

    Upgrade notice: Starting with Contrail Insights 3.2.6, the requirement for a license file is removed. If you are installing a version earlier than 3.2.6, a license is required prior to installation.

    You can obtain a license key from Provide the following information in your request:


  • One virtual IP address to be shared among all the Platform Hosts. This IP address should not be used by any host before installation. It should have reachability from all the Platform Hosts after installation.

  • Dashboard client (in browser) must have IP connectivity to the virtual IP.

  • IP addresses for each Platform Host for installation and for services running on these hosts to communicate.

  • keepalived_vrrp_interface for each Platform Host which would be used for assigning virtual IP address. Details on how to configure this interface is described in the sample_inventory section.

Install Contrail Insights for High Availability

To install Contrail Insights to multiple hosts for high availability:

  1. Download the Contrail Insights installation packages from software downloads to the Contrail Insights Platform node. Get the following files:

    If you are installing a version earlier than 3.2.6, copy the Contrail Insights license file to the Contrail Insights Platform node.

  2. Install Ansible on the installer node. Ansible will install docker and the docker Python package on the appformix_controller.

    For Ansible 2.3:

  3. Install Python and python-pip on all the Platform hosts so that Ansible can run between the installer node and the appformix_controller node.

  4. Install python pip package on the hosts where Contrail Insights Agents run.

  5. To enable passwordless login to all Platform hosts by Ansible, create an SSH public key on the node where Ansible playbooks are run and then copy the key to all the Platform hosts.

  6. Use the sample_inventory file as a template to create a host file. Add all the Platform hosts and compute hosts details.


    Note: In the case of 5-node or 7-node deployment, list all the nodes under appformix_controller.

  7. At top-level of the distribution, create a directory named group_vars and then create a file named all inside this directory.

    Add the following entries to the newly created all file:

    If you are installing a version earlier than 3.2.6, include the path to the Contrail Insights license file in group_vars/all:

  8. Copy and source the openrc file from the OpenStack controller node (/etc/contrail/openrc) to the appformix_controller to authenticate the adapter to access admin privileges over the controller services.


    In Contrail Insights version 3.2.0, support for discovering OpenStack Octavia Load Balancer services is added. Contrail Insights only collects load balancer state information, such as provisioning_status and operating_status, as well as flavor information. To enable this service discovery, provide Octavia service's endpoint as variable appformix_octavia_endpoint_url in the group_vars/all file. For example:

    Chargeback costs can also be configured for the Octavia Load Balancer services. See Configure Load Balancer Costs.

  9. Run Ansible with the created inventory file.

  10. If running the playbooks as root user then this step can be skipped. As a non-root user (for example. “ubuntu”), the user “ubuntu” needs access to the docker user group. The following command adds the user to the docker group.