Installing Contrail with OpenStack and Kolla Ansible

Set Up the Base Host

This procedure assumes you are installing with CentOS 7.5 kernel 3.10.0-862.11.6.el7.x86_64. The vRouter has a dependency with the host kernel. Install this kernel version on the target nodes before provisioning.

To set up the base host:

1. Download the appropriate installer package from the Contrail Download page.

2. Install Ansible.

   yum -y install epel-release

   yum -y install git ansible-2.4.2.0

3. Untar the tgz. file.

   - tar xvf contrail-ansible-deployer-5.0.1-0.214.tgz

   The instances.yaml is located at the contrail-ansible-deployer/config/

4. Configure Contrail and Kolla parameters in the file instances.yaml, using the following guidelines:

   • The provider configuration (provider_config) section refers to the cloud provider where the Contrail cluster will be hosted, and contains all parameters relevant to the provider. For bare metal servers, the provider is bms.

   • The kolla_globals section refers to OpenStack services. For more information about all possible kolla_globals, see https://github.com/Juniper/contrail-kolla-ansible/.../globals.yml.

   • Additional Kolla configurations (contrail-kolla-ansible) are possible as contrail_additions. For more information about all possible contrail_additions to Kolla, see https://github.com/Juniper/contrail-kolla-ansible/.../all.yml.

   • The contrail_configuration section contains parameters for Contrail services.

     • CONTAINER_REGISTRY specifies the registry from which to pull Contrail containers. It can be set to your local Docker registry if you are building your own containers. If a registry is not specified, it will try to pull the containers from the Docker hub.

       If a custom registry is specified, also specify the same registry under kolla_globals as contrail_docker_registry.

     • CONTRAIL_VERSION, if not specified, will default to the "latest" tag. It is possible to specify a tag from nightly builds.

     • For more information about all possible parameters for contrail_configuration, see https://github.com/Juniper/contrail-container-builder/.../common.sh.

     • If “roles” is not specified, the following roles are assumed.

       content_copy zoom_out_map

       config_database:
          config:
          control:
          analytics_database:
          analytics:
          webui:
          vrouter:
          openstack:
          openstack_compute:

     • If there are host-specific values per host, for example, if the names of the interfaces used for "network_interface" are different on the servers in your cluster, use the example configuration at Configuration Sample for Multi Node OpenStack HA and Contrail (multi interface).

     • Many of the parameters are automatically derived to sane defaults (how the first configuration works). You can explicitly specify variables to override the derived values if required. Review the code to see the derivation logic.

     • CONTROL_DATA_NET_LIST can be a comma separated list of CIDR subnets that can be designated for CONTROL/DATA plane traffic. The 'kolla' parameters 'network_interface' will be derived from this subnet as the interface that corresponds to an IP address in this subnet. CONTROL_DATA_NET_LIST can still be used in a single interface setup by specifying the management subnet as the value so that the interface names need not be specified.

   Example: instances.yaml

   This example is a bare minimum configuration for a single node, single interface, all-in-one cluster.

   content_copy zoom_out_map

   provider_config:
     bms:
       ssh_pwd: <password>
       ssh_user: root
       ntpserver: <IP NTP server>
       domainsuffix: local
   instances:
     bms1:
       provider: bms
       ip: <IP BMS>1
   contrail_configuration:
     RABBITMQ_NODE_PORT: 5673
     AUTH_MODE: keystone
     KEYSTONE_AUTH_URL_VERSION: /v3
   kolla_config:
     kolla_globals:
       enable_haproxy: no
     kolla_passwords:
       keystone_admin_password: <Keystone admin password>

   Example: instances.yaml

   This example is a more elaborate configuration for a single node, single interface, all-in-one cluster.

   content_copy zoom_out_map

   provider_config:
     bms:
       ssh_pwd: <password>
       ssh_user: root
       ntpserver: <IP NTP server>
       domainsuffix: local
   instances:
     bms1:
       provider: bms
       ip: <IP BMS>
       roles:
         config_database:
         config:
         control:
         analytics_database:
         analytics:
         webui:
         vrouter:
         openstack:
         openstack_compute:
   global_configuration:
     CONTAINER_REGISTRY: <Registry FQDN/IP>:<Registry Port>
     REGISTRY_PRIVATE_INSECURE: True
   contrail_configuration:
     CONTRAIL_VERSION: latest
     CLOUD_ORCHESTRATOR: openstack
     VROUTER_GATEWAY: <IP gateway>
     RABBITMQ_NODE_PORT: 5673
     PHYSICAL_INTERFACE: <interface name>
     AUTH_MODE: keystone
     CONTROL_DATA_NET_LIST: 198.168.10.0/24
     KEYSTONE_AUTH_URL_VERSION: /v3
   kolla_config:
     kolla_globals:
       kolla_internal_vip_address: <Internal VIP>
       contrail_api_interface_address: <Contrail API Addr>
       enable_haproxy: no
     kolla_passwords:
       keystone_admin_password: <Keystone Admin Password>
    

5. Run the following Commands:

   • ansible-playbook -e orchestrator=openstack -i inventory/ playbooks/configure_instances.yml

   • ansible-playbook -i inventory/ playbooks/install_openstack.yml

   • ansible-playbook -e orchestrator=openstack -i inventory/ playbooks/install_contrail.yml

6. Open web browser and type https://contrail-server-ip:8143 to access Contrail WebUI.

   The default login user name is admin. Use the same password which was entered in step 4

Run OpenStack Commands

At this time, it is necessary to manually install the OpenStack client (python-openstackclient) using pip. You cannot install using Yum repos because some dependent Python libraries conflict with the installation of the python-openstackclient. You also cannot install using pip repos because Ansible libraries can be overwritten.

1. Manually install the python-openstackclient.

   yum install -y gcc python-devel

   pip install python-openstackclient

   pip install python-ironicclient

2. Test the setup with VM-to-VM ping.

   content_copy zoom_out_map

   source /etc/kolla/admin-openrc.sh
   wget http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
   openstack image create cirros2 --disk-format qcow2 --public --container-format bare --file cirros-0.4.0-x86_64-disk.img                                      
   openstack network create testvn
   openstack subnet create --subnet-range 198.168.100.0/24 --network testvn subnet1
   openstack flavor create --ram 512 --disk 1 --vcpus 1 m1.tiny
   NET_ID=`openstack network list | grep testvn | awk -F '|' '{print $2}' | tr -d ' '`
   openstack server create --flavor m1.tiny --image cirros2 --nic net-id=${NET_ID} test_vm1
   openstack server create --flavor m1.tiny --image cirros2 --nic net-id=${NET_ID} test_vm2

Multiple Interface Configuration Sample for Multinode OpenStack HA and Contrail

This is a configuration sample for a multiple interface, multiple node deployment of high availability OpenStack and Contrail Release 5.0.x. Use this sample to configure parameters specific to your system.

For more information or for recent updates, refer to the github topic Configuration Sample for Multi Node OpenStack HA and Contrail (multi interface).

provider_config:
  bms:
    ssh_pwd: <Pwd>
    ssh_user: root
    ntpserver: <NTP Server>
    domainsuffix: local
instances:
  bms1:
    provider: bms
    ip: <BMS1 IP>
    roles:
      openstack:
  bms2:
    provider: bms
    ip: <BMS2 IP>
    roles:
      openstack:
  bms3:
    provider: bms
    ip: <BMS3 IP>
    roles:
      openstack:
  bms4:
    provider: bms
    ip: <BMS4 IP>
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
  bms5:
    provider: bms
    ip: <BMS5 IP>
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
  bms6:
    provider: bms
    ip: <BMS6 IP>
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
  bms7:
    provider: bms
    ip: <BMS7 IP>
    roles:
      vrouter:
        PHYSICAL_INTERFACE: <Interface name>
        VROUTER_GATEWAY: <Gateway IP>
      openstack_compute:
  bms8:
    provider: bms
    ip: <BMS8 IP>
    roles:
      vrouter:
        # Add following line for TSN Compute Node
        TSN_EVPN_MODE: True
      openstack_compute:
contrail_configuration:
  CLOUD_ORCHESTRATOR: openstack
  CONTROL_DATA_NET_LIST: <Control Data Subnet CIDR>
  KEYSTONE_AUTH_URL_VERSION: /v3
  IPFABRIC_SERVICE_HOST: <Service Host IP>
  # Add following line for TSN Compute Node
  TSN_NODES: <TSN NODE IP List>
  # For EVPN VXLAN TSN
  ENCAP_PRIORITY: "VXLAN,MPLSoUDP,MPLSoGRE"
  PHYSICAL_INTERFACE: <Interface name>
kolla_config:
  kolla_globals:
    kolla_internal_vip_address: <Internal VIP>
    kolla_external_vip_address: <External VIP>
    contrail_api_interface_address: <Contrail API IP>
  kolla_passwords:
    keystone_admin_password: <Keystone Admin Password>

Single Interface Configuration Sample for Multinode OpenStack HA and Contrail

This is a configuration sample for a multiple interface, single node deployment of high availability OpenStack and Contrail Release 5.0.x. Use this sample to configure parameters specific to your system.

For more information or for recent updates, refer to the github topic Configuration Sample for Multi Node OpenStack HA and Contrail (single interface).

provider_config:
  bms:
    ssh_pwd: <password>
    ssh_user: root
    ntpserver: xx.xx.x.xx
    domainsuffix: local
instances:
  centos1:
    provider: bms
    ip: ip-address
    roles:
      openstack:
  centos2:
    provider: bms
    ip: ip-address
    roles:
      openstack:
  centos3:
    provider: bms
    ip: ip-address
    roles:
      openstack:
  centos4:                                                       
    provider: bms
    ip: ip-address
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
  centos5:
    provider: bms
    ip: ip-address
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
  centos6:
    provider: bms
    ip: ip-address
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
  centos7:
    provider: bms
    ip: ip-address
    roles:
      vrouter:
      openstack_compute:
  centos8:
    provider: bms
    ip: ip-address
    roles:
      vrouter:
      openstack_compute:
contrail_configuration:
  CONTRAIL_VERSION: <contrail_version>
  CONTROLLER_NODES: ip-addresses separated by comma
  CLOUD_ORCHESTRATOR: openstack
  RABBITMQ_NODE_PORT: 5673
  VROUTER_GATEWAY: gateway-ip-address
  PHYSICAL_INTERFACE: eth1
  IPFABRIC_SERVICE_IP: ip-address
  KEYSTONE_AUTH_HOST: ip-address
  KEYSTONE_AUTH_URL_VERSION: /v3
kolla_config:
  kolla_globals:
    kolla_internal_vip_address: ip-address
    contrail_api_interface_address: ip-address
    network_interface: "eth1"
    enable_haproxy: "yes"
  kolla_passwords:
    keystone_admin_password: <password>

Frequently Asked Questions

This section presents some common error situations and gives guidance on how to resolve the error condition.

• Using Host-Specific Parameters
• Containers from Private Registry Not Accessible
• Error: Failed to insert vrouter kernel module
• Fatal Error When Vrouter Doesn’t Specify OpenStack
• Need for HAProxy and Virtual IP on a Single OpenStack Cluster
• Using the kolla_toolbox Container to Run OpenStack Commands

# ON BASE HOST OF OPENSTACK CONTROL NODE
    cd /etc/kolla/kolla-toolbox
    wget http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img

    docker exec -it kolla_toolbox bash
    # NOW YOU ARE INSIDE THE KOLLA_TOOLBOX CONTAINER
    (kolla-toolbox)[ansible@server1 /]$ source /var/lib/kolla/config_files/admin-openrc.sh
    (kolla-toolbox)[ansible@server1 /]$ cd /var/lib/kolla/config_files
    (kolla-toolbox)[ansible@server1 /var/lib/kolla/config_files]$ openstack image create cirros2 --disk-format qcow2 --public --container-format bare --file cirros-0.4.0-x86_64-disk.img
    +------------------+------------------------------------------------------+
    | Field            | Value                                                |
    +------------------+------------------------------------------------------+
    | checksum         | 443b7623e27ecf03dc9e01ee93f67afe                     |
    | container_format | bare                                                 |
    | created_at       | 2018-03-29T21:37:48Z                                 |
    | disk_format      | qcow2                                                |
    | file             | /v2/images/e672b536-0796-47b3-83a6-df48a5d074be/file |
    | id               | e672b536-0796-47b3-83a6-df48a5d074be                 |
    | min_disk         | 0                                                    |
    | min_ram          | 0                                                    |
    | name             | cirros2                                              |
    | owner            | 371bdb766278484bbabf868cf7325d4c                     |
    | protected        | False                                                |
    | schema           | /v2/schemas/image                                    |
    | size             | 12716032                                             |
    | status           | active                                               |
    | tags             |                                                      |
    | updated_at       | 2018-03-29T21:37:50Z                                 |
    | virtual_size     | None                                                 |
    | visibility       | public                                               |
    +------------------+------------------------------------------------------+
    (kolla-toolbox)[ansible@server1 /var/lib/kolla/config_files]$ openstack image list
    +--------------------------------------+---------+--------+
    | ID                                   | Name    | Status |
    +--------------------------------------+---------+--------+
    | e672b536-0796-47b3-83a6-df48a5d074be | cirros2 | active |
    | 57e6620e-796a-40ee-ae6e-ea1daa253b6c | cirros2 | active |
    +--------------------------------------+---------+--------+