Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Installing a Contrail Cluster Using Contrail Command


Use this example procedure to create a Contrail and OpenStack Kolla cluster using Contrail Command. The resulting cluster consists of Contrail containers deployed alongside OpenStack Kolla containers to provide an OpenStack installation that uses Contrail as the SDN.


  • VMs or physical x86 servers as follows:

    • Contrail Controller — 8 vCPU, 64 GB memory, 300 GB storage

    • OpenStack Controller — 4 vCPU , 32 GB memory, 100 GB storage

    • Contrail Service Node (CSN) — 4 vCPU, 16 GB memory, 100 GB storage

    • Compute nodes — Dependent on the workloads

    For a list of supported platforms including software requirements, see Supported Platforms.

  • User storage for all servers resides in the “/” partition (that is, remove the “/home” partition if it exists, and increase the “/” partition by the amount of freed storage).

  • An IP interface on each server attached to the management network. Each server is managed by Contrail Command over this interface. Ensure the name for this management interface is the same on all servers.

  • An IP interface on each server attached to the user data network. This is the interface that the overlay network will be set up on. Ensure the name for this user data interface is the same on all servers.

  • SSH access


A Contrail cluster consists of hosts that run the Contrail controller, the orchestrator (OpenStack, VMware or Kubernetes), and the compute nodes.

Before you begin, set up servers and/or VMs that meet the specified requirements. Also ensure that the Contrail Command server and all the hosts in the Contrail cluster have /etc/hosts entries for each other over the management network.


Consider a sample cluster topology, with a non-HA environment of one Contrail Controller and one OpenStack Controller, one compute node and one Contrail Service Node (CSN), as displayed in Figure 1.

Figure 1: Sample Contrail Cluster Topology
Sample Contrail Cluster Topology


Step-by-Step Procedure

The general workflow is for you to first add the servers and VMs that you want to make available for the cluster you’re creating, and then add the cluster.

  1. Log in to Contrail Command at https://<Contrail-Command-Server-IP-Address>:9091.

    If you used the sample command_servers.yml files when you installed Contrail Command, then the username is admin and the password is contrail123.


    Username and password combinations are provided in this document for illustrative purposes only. We suggest using unique passwords in accordance with your organization’s security guidelines in your environment.


    If no cluster exists, you are automatically placed into a wizard that guides you to set up a cluster. The left-nav bar shows your progress. If a cluster already exists, you will need to explicitly add a cluster. Regardless of whether you are using the wizard or not, the steps to set up a cluster are very similar. Differences are noted in the steps below.

  2. Add the login credentials of the servers and VMs that you’re making available. In this step, you are adding the credentials to a floating list. You will explicitly associate each set of credentials to the proper server or VM at a later step. Contrail Command uses these credentials to log in to the servers and VMs when creating the cluster.

    1. To see the list of credentials, navigate to Servers > Credentials. The set of credentials you specified during Contrail Command installation (in the server1 section of the command_servers.yml file) is automatically listed.
    2. Click Create to add a new set of credentials.

      Enter Name, SSH User, and SSH Password.

  3. Add the servers or VMs, either one at a time or using the bulk import capability.

    Navigate to Servers > Create.

    • To add servers one at a time, select Express or Detailed. In this example, we select Detailed.

      Enter the following information:

      • Workload type - Select Physical/Virtual Node if you want the workload to run as a VM on the server or Baremetal if you want the workload to run directly on the server.

      • Hostname - Enter the hostname part of the FQDN.

      • Management IP - Enter the IP address for the management interface.

      • Management Interface - Enter the interface name for the management interface.

      • Credentials - Use the drop-down list to select the correct login credentials for this server. This is the set of credentials you added in step 2. Contrail Command uses the credentials you select to log in to the server.

      • MAC Address (optional) - Specify the MAC address for the management interface.

      • Disk Partition(s) (optional) - Specify the disk partitions you want to use.

      • Network Interfaces - Click Add to add the interfaces on the server. As a minimum, add the management and the user data interface.


      If you select the Express option, then you will need to edit the server afterwards to add in any missing information.

    • To add servers in bulk, select Bulk Import (csv).

      1. Click Download to download the csv template to use. The downloaded file is a template with sample values.

        Here is a sample csv file:


        The demo topology above has only one compute node. If you are deploying additional compute nodes, you must include them in the CSV file.

      2. Fill in the values for your servers, and save and upload the file by clicking Upload.

    The added servers are now shown in the list of available servers.

  4. You can now create the cluster. If you are in the wizard, click Next. Otherwise, select Clusters > Add Cluster.
  5. Set the general parameters for the cluster.
    1. Select Contrail Enterprise Multicloud as the Provisioning Manager.
    2. Enter the required information.
      • Cluster Name - the name that you want to call the cluster

      • Container Registry, Container Registry Username, Container Registry Password, Contrail Version

        See README Access to Contrail Registry 19XX   for the correct values for these fields. The Contrail Version corresponds to the Contrail-Command (UI) container deployment value specified in that document.

      • Provisioner Type - Ansible

      • Domain Suffix - the domain name for the cluster

      • NTP Server - the FQDN or IP address of the NTP server you want to use

      • Default Vrouter Gateway - the default gateway for the compute nodes

        The default that you specify here is made available in the Default Gateway fields in later steps. If a particular node has a different default gateway, you can always override the default at that later step.

      • Encapsulation Priority

        Select VXLAN, MPLSoUDP, MPLSoGRE.

    3. Ensure Insecure is not selected.
    4. Click Enable ZTP.Note

      From Contrail Networking Release 1911 and later, Enable ZTP option is replaced by Fabric Management.

    5. Click the drop-down arrow for Contrail Configuration.
    6. Click Add and enter the following Key/Value pairs.




      List of comma-separated user data interface IP addresses for the controller(s)


      The user data interface name


      List of comma-separated user data interface IP addresses for the Contrail Service Node(s)


      The container tag for the desired Contrail and OpenStack release combination as specified in README Access to Contrail Registry 19XX  

    7. Click Next.
  6. Assign the control nodes for the cluster.
    Figure 2: Select Control Nodes
    Select Control Nodes

    Select High availability mode if you have HA setup for the controller node. Select all the control nodes from Available servers list.

  7. Select the orchestrator and assign the orchestrator nodes.
    1. Select Openstack from the Orchestrator type drop-down list.
    2. Use the arrows to move one or more servers from the Available servers list to the Assigned Openstack nodes list.
    3. Check the Show Advanced option to customize your deployment.
    4. Set up the virtual IP addresses if you are deploying an HA cluster.
      • Control & Data Network Virtual IP address - this is an internal VIP (e.g.

      • Management Network Virtual IP address - this is an external VIP (e.g.

      • keepalived_virtual_router_id - (optional) it can be set to any value between 0-255. The default value is 51.

    5. Add the following parameters under Customize configuration for a VM-based setup:

      Minimum 8 indent spaces are required for lines following the nova.conf.

    6. Click Add under Kolla Globals and enter the following Key/Value pairs. These are the standard OpenStack Kolla globals.








      Set to no if you are not using Life Cycle Management in Contrail Command or PXE boot on Bare Metal Servers (BMS).



      Set to yes if you are using object store. This parameter is disabled by default.


      queens (for example)

      This must be one of the supported OpenStack releases.



      The default value is 5 GB. If you have two or more images, you must have at least 20 GB allocated for hitless image upload procedure.

    7. Click Add under Kolla Passwords to explicitly add Kolla passwords if desired.

      These passwords are placed into the etc/kolla/passwords.yml file. By default, all kolla passwords are set to contrail123.


      We suggest changing the default password to a unique password in accordance with your organization’s security guidelines.

    8. Click Next.
  8. Assign the compute nodes.

    1. Use the arrows to move one or more servers from the Available servers list to the Assigned Compute nodes list.
    2. Enter the Default Vrouter Gateway for each node.
    3. Select Kernel in the Type drop-down list. This is the only type supported in the current release.
      Figure 3: Select Compute Nodes
      Select Compute Nodes
    4. Click Next.
  9. Assign the Contrail Service nodes.

    1. Use the arrows to move one or more servers from the Available servers list to the Assigned Service nodes list.
    2. Enter the Default Vrouter Gateway for each node.
      Figure 4: Select Contrail Service Nodes
      Select Contrail Service Nodes
    3. Click Next.
  10. (Optional) Assign the AppFormix nodes.

    For details, refer to Installing AppFormix and AppFormix Flows using Contrail Command.

    Click Next.

  11. Verify your cluster configuration in the Cluster overview panel and your nodes configuration in the Nodes overview panel.
    Figure 5: Verify Summary
    Verify Summary
    Verify Summary

    If the configuration is correct, click Provision. If not, click Previous to go back to fix any misconfigurations.

  12. You can monitor the progress by running the following commands from Contrail Command server.

    docker logs -f contrail_command


    docker exec contrail_command tail -f /var/log/contrail/deploy.log


The Reprovision button does not support editing Kolla or Contrail configuration parameters. After each failed attempt to provision a fabric, you must destroy and rebuild all the VMs and repeat the process.