Deploying Contrail Cluster using Contrail-Command and instances.yml

date_range 16-Oct-23

arrow_backward

arrow_forward

Contrail Release 5.0.1 supports deploying a Contrail cluster using Contrail Command and the instances.yml file.

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 (Minimal ISO) as the base OS to install Contrail Command

Prerequisite

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.

content_copy zoom_out_map
pip uninstall docker-py docker

Configuration

Perform the following steps to deploy a Contrail cluster using Contrail Command and the instances.yml file.

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 https://download.docker.com/linux/centos/docker-ce.repo

yum install -y docker-ce

systemctl start docker
Download Contrail-Command-Deployer docker container image from hub.juniper.net. To download these containers and for access to hub.juniper.net, refer to the Access to Contrail Registry topic on the Contrail software download page. Allow Docker to connect to the private secure registry.
docker login hub.juniper.net --username < container_registry_username > --password < container_registry_password >

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

docker pull hub.juniper.net/contrail/contrail-command-deployer:<container_tag>

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

docker pull hub.juniper.net/contrail/contrail-command-deployer:5.0.1-0.214
Edit the input configuration instances.yml file. See #deploying-contrail-cluster-using-contrail-command-and-instances-yml__sample_instances_yml for a sample instances.yml file.
Start the Contrail_Command_Deployer container to deploy the Contrail-Command (UI) server and provision Contrail-Cluster using the instances.yml file provided.
docker run -t --net host -e action=provision_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 hub.juniper.net/contrail/contrail-command-deployer: <container_tag>

The contrail_command and contrail_mysq Contrail Command containers are deployed. Contrail cluster is also provisioned using the given instances.yml file.
(Optional) Track the progress of 4.
docker logs -f contrail_command_deployer
Once the playbook execution completes, log in to Contrail Command using https://Contrail-Command-Server-IP-Address:9091. Use the same user name and password that was entered in 3. Default username is admin and password is contrail123.

Sample instances.yml File

content_copy zoom_out_map
global_configuration:
  CONTAINER_REGISTRY: hub.juniper.net/contrail
  CONTAINER_REGISTRY_USERNAME: < container_registry_username >
  CONTAINER_REGISTRY_PASSWORD: < container_registry_password >
provider_config:
  bms:
    ssh_pwd: <Pwd>
    ssh_user: root
    ntpserver: <NTP Server>
    domainsuffix: local
instances:
  bms1:
    provider: bms
    ip: <BMS IP>
    roles:
      config_database:
      config:
      control:
      analytics_database:
      analytics:
      webui:
      vrouter:
      openstack:
      openstack_compute:
  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
  CONTRAIL_VERSION: latest or <contrail_container_tag>
  CONTRAIL_CONTAINER_TAG: <contrail_container_tag>-queens
  RABBITMQ_NODE_PORT: 5673
  VROUTER_GATEWAY: <Gateway IP>
  ENCAP_PRIORITY: VXLAN,MPLSoUDP,MPLSoGRE
  AUTH_MODE: keystone
  KEYSTONE_AUTH_HOST: <Internal VIP>
  KEYSTONE_AUTH_URL_VERSION: /v3
  CONTROLLER_NODES: < list of mgmt. ip of control nodes >
  CONTROL_NODES: <list of control-data ip of control nodes>
  OPENSTACK_VERSION: queens
kolla_config:
  kolla_globals:
    openstack_release: queens
    kolla_internal_vip_address: <Internal VIP>
    kolla_external_vip_address: <External VIP>
    openstack_release: queens
    enable_haproxy: "no" 	 ("no" by default, set "yes" to enable)
    enable_ironic: "no"       ("no" by default, set "yes" to enable)
    enable_swift: "no"        ("no" by default, set "yes" to enable)
    keepalived_virtual_router_id: <Value between 0-255>
  kolla_passwords:
    keystone_admin_password: <Keystone Admin Password>

The following Table 1 defines the function of each variable present in the instances.yml file.

Table 1: Description of Variables in Instances.yml file
Instances	Description
`CONTROLLER_NODES`	Enter the management interface IP address of the controller node. The default value is either populated from the IP address in the instances.yml file or the IP address provided while adding the server from contrail command UI. `CONTROLLER_NODES` is a meta variable that is used to populate other unpopulated nodes like CONFIG_NODES, CONTROL_NODES, ANALYTICS_NODES, and others.
`CONTROL_NODES`	Enter the data interface IP address of the controller node. The default value is populated from the `CONTROLLER_NODES` variable. The `CONTROL_NODES` variable also indicates the interfaces on which the control services can function.
`kolla_internal_vip_address`	Enter the ctrl-data-network IP address. `kolla_internal_vip_address` is a virtual IP address that separates internal communication requests.
`kolla_external_vip_address`	Enter the management network IP address. `kolla_external_vip_address` is a virtual IP address that separates external communication requests.
`KEYSTONE_AUTH_HOST`	Enter the IP address of the host, which has `AUTH_MODE` set to keystone. The default value is populated automatically.
`CLOUD_ORCHESTRATOR`	Enter the name of orchestrator you are using. Default value: none. A `CLOUD_ORCHESTRATOR` is the platform that automates provisioning of cloud services.
`CONTRAIL_VERSION`	Enter the Contrail version number. Default value: `latest`.
`RABBITMQ_NODE_PORT`	Enter the port number assigned to RabbitMQ node. Default value: `5672`. RabbitMQ is a software that provides message queuing service, which is an efficient method of exchanging data between applications and servers.
`VROUTER_GATEWAY`	Enter the gateway IP address of the virtual router. The default gateway assigned to the virtual router is known as virtual router gateway. The default value is the default gateway IP address of management subnet in case of single interface setup. The `VROUTER_GATEWAY` is default gateway IP address for the compute nodes in the contrail cluster.
`ENCAP_PRIORITY`	`ENCAP_PRIORITY` is used to set the order of Encapsulation Priority for the EVPN supported methods - MPLS over UDP, MPLS over GRE And VxLAN. Default value: `MPLSoUDP,MPLSoGRE,VXLAN`.
`AUTH_MODE`	Enter the desired keystone authentication mode. Default value: `noauth`.
`KEYSTONE_AUTH_URL_VERSION`	Enter the URL of the Keystone authentication server. Default value: `/v2.0`. Keystone is a Opentack identity service. All Openstack operations are authenticated via the keystone server.
`OPENSTACK_VERSION`	Enter the software version number of the Openstack platform. Default value: `queens`.
`enable_haproxy`	Enter `yes` to enable haproxy. Enter `no` to disable haproxy. Default value: `no`. High Availability Proxy (Haproxy) provides high availability load balancing and proxy servers in cloud networking.
`enable_irony`	Enter `yes` to deploy Ironic notification manager service container. Default value: `no`. Deploy Ironic if you want to perform Life Cycle Management in Contrail Command.
`enable_swift`	Enter `yes` to deploy Swift. Default value: `no`. Deploy Swift if you want to perform Image management in Contrail Command.
`keepalived_virtual_router_id`	Enter value between 0-255. Default value: `51`. `keepalived_virtual_router_id` is used to configure keepalives. In Openstack HA, the keepalives are used to run and elect a master based on VRRP protocol.
`keystone_admin_password`	Enter keystone admin password. Default value: `contrail123`. `keystone_admin_password` is used to set a password for the admin to access keystone. Keystone is a Openstack identity service.

arrow_backward PREVIOUS Deploying Contrail Cluster using the Contrail Command UI

NEXT arrow_forward Importing Contrail Cluster Data using Contrail Command

Contrail Feature Guide

Deploying Contrail Cluster using Contrail-Command and instances.yml

Related Documentation