Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Importing Contrail Cluster Data using Contrail Command

Contrail Release 5.0.1 supports importing of Contrail cluster data using Contrail Command.

Before you begin

docker-py is obsolete in Contrail Release 5.0.2. You must remove docker-py and docker Python packages from all the nodes where you want to install the Contrail Command UI.

System Requirements

  • A VM or physical server with:

    • 8 vCPUs

    • 64 GB RAM

    • 300 GB disk out of which 256 GB is allocated to /root directory.

  • Internet access to and from the physical server, hereafter referred to as the Contrail Command server

  • (Recommended) x86 server with CentOS 7.5 as the base OS to install Contrail Command


Perform the following steps to import Contrail cluster data.

  1. Install Docker on the Contrail Command server. These packages are necessary to automate the deployment of Contrail Command software.

    yum install -y yum-utils device-mapper-persistent-data lvm2

    yum-config-manager --add-repo

    yum install -y docker-ce

    systemctl start docker

  2. Download the contrail-command-deployer Docker container image to deploy contrail-command (contrail_command, contrail_mysql containers) from Allow Docker to connect to the private secure registry.

    docker login --username <container_registry_username> --password <container_registry_password>

    Pull Contrail-Command-Deployer Container from the private secure registry.

    docker pull<container_tag>

    Example, for container_tag: 5.0.1-0.214, use the following command:

    docker pull

  3. Get the instances.yml file that was used to provision the Contrail cluster.
  4. Start the Contrail-Command-Deployer container to deploy the Contrail Command (UI) server and import Contrail cluster data to Contrail Command (UI) server using the instances.yml file provided.
    • To import a Contrail cluster using OpenStack:

      docker run -t --net host -e orchestrator=openstack -e action=import_cluster -v < ABSOLUTE_PATH_TO_COMMAND_SERVERS_FILE>:/command_servers.yml -v < ABSOLUTE_PATH_TO_INSTANCES_FILE>:/instances.yml -d --privileged --name contrail_command_deployer <container_tag>

    • To import a Contrail cluster using Kubernetes:

      docker run -t --net host -e orchestrator=kubernetes -e action=import_cluster -v < ABSOLUTE_PATH_TO_COMMAND_SERVERS_FILE>:/command_servers.yml -v < ABSOLUTE_PATH_TO_INSTANCES_FILE>:/instances.yml -d --privileged --name contrail_command_deployer <container_tag>


    These steps explain how to import Contrail cluster data provisioned using OpenStack and Kubernetes. If your orchestrator is different, use -e orchestrator=<YOUR_ORCHESTRATOR> in the above command. The following orchestrators are supported:

    • OpenStack—Use orchestrator=openstack

      Kubernetes—Use orchestrator=kubernetes

      Red Hat OpenShift—Use orchestrator=openshift

      VMware vCenter—Use orchestrator=vcenter

Sample instances.yml File