Upgrading Contrail In-Service Software from Releases 3.2 and 4.1 to 5.0.x using Helm Deployer

Contrail In-Service Software Upgrade (ISSU) Overview

If your installed version is Contrail Release 3.2 or higher, you can perform an in-service software upgrade (ISSU) to upgrade to Contrail Release 5.0.x using the Helm deployer. In performing the ISSU, the Contrail controller cluster is upgraded side-by-side with a parallel setup, and the compute nodes are upgraded in place.

The procedure for performing the ISSU using the Contrail Helm deployer is similar to previous ISSU upgrade procedures.

1. Deploy the new cluster.
2. Synchronize the new and old clusters.
3. Upgrade the compute nodes.
4. Finalize the synchronization and complete the upgrades.

Prerequisites

The following prerequisites are required to use the Contrail Helm deployer ISSU procedure:

• A previous version of Contrail installed, not earlier than Release 3.2.

• There are OpenStack controller and compute nodes, and Contrail nodes.

• OpenStack needs to have been installed from packages.

• Contrail and OpenStack should be installed on different nodes.

Preparing the Contrail System for the Helm Deployer ISSU Procedure

1. Deploy the 5.0.x version of Contrail using the Contrail Helm deployer, but make sure to include only the following Contrail controller services:

   • Config

   • Control

   • Analytics

   • Databases

   • Any additional support services like rmq, kafka, and zookeeper. (The vrouter service will be deployed later on the old compute nodes.)

   Note

   You must provide keystone authorization information for setup.

2. After deployment is finished, you can log into the Contrail web interface to verify that it works.

Detailed instructions for deploying the new cloud using Helm are provided in Installing Contrail Networking for Kubernetes using Helm.

Provisioning Control Nodes and Performing Synchronization Steps

1. Provision new control nodes in the old cluster and old control nodes in the new cluster.
2. Stop the following containers in the new cluster on all nodes:

   • contrail-device-manager

   • contrail-schema-transformer

   • contrail-svcmonitor

3. Switch the new cloud into maintenance mode to prevent provisioning computes in the new cluster.
4. Prepare the config file for the ISSU.
5. Run the pre-sync script from the ISSU package.
6. Run the run-sync script from the ISSU package in background mode.

1. Pair the old control nodes in the new cluster. It is recommended to run it from any config-api container:
   content_copy zoom_out_map

   config_api_cid=`docker ps | awk '/config-api/{print $1}' | head`

2. Run this command for each old control node, substituting actual values where indicated:
   content_copy zoom_out_map

   docker exec -it $config_api_cid /bin/bash -c "LOG_LEVEL=SYS_NOTICE source /common.sh ; python /opt/contrail/utils/provision_control.py --host_name hostname of old control node --host_ip IP of old control node --api_server_ip $(hostname -i) --api_server_port 8082 --oper add --router_asn 64512 --ibgp_auto_mesh \$AUTH_PARAMS"

3. Pair the new control nodes in the old cluster with similar commands (the specific syntax depends on the deployment method of the old cluster), again substituting actual values where indicated.
   content_copy zoom_out_map

   python /opt/contrail/utils/provision_control.py --host_name new controller hostname --host_ip new controller IP --api_server_ip old api-server IP/VIP --api_server_port 8082 --oper add --admin_user admin --admin_password password --admin_tenant_name admin --router_asn 64512 --ibgp_auto_mesh

4. Stop all the containers for contrail-device-manager, contrail-schema-transformer, and contrail-svcmonitor in the new cluster on all controller nodes.
   content_copy zoom_out_map

   docker ps | grep config-devicemgr | awk '{print $1}' | xargs docker pause
   docker ps | grep config-schema | awk '{print $1}' | xargs docker pause
   docker ps | grep config-svcmonitor | awk '{print $1}' | xargs docker pause
   

These next steps should be performed from any new Contrail controller. Then the configuration prepared for ISSU runs. (For now, only manual preparation is available.)

The configuration appears as follows and can be stored locally:

[DEFAULTS]
# details about oldrabbit
old_rabbit_user = contrail
old_rabbit_password = ab86245f4f3640a29b700def9e194f72
old_rabbit_q_name = vnc-config.issu-queue
old_rabbit_vhost = contrail
old_rabbit_port = 5672
old_rabbit_address_list = ip-address
# details about new rabbit
# new_rabbit_user = rabbitmq
# new_rabbit_password = password
# new_rabbit_ha_mode =
new_rabbit_q_name = vnc-config.issu-queue
new_rabbit_vhost = /
new_rabbit_port = 5673
new_rabbit_address_list = rabbitmq.contrail
# details about other old/new services
old_cassandra_user = controller
old_cassandra_password = 04dc0540b796492fad6f7cbdcfb18762
old_cassandra_address_list = ip-address:9161
old_zookeeper_address_list = ip-address:2181
new_cassandra_address_list = ip-address:9161 ip-address:9161 ip-address:9161
new_zookeeper_address_list = ip-address:2181
# details about new controller nodes
new_api_info = {"ip-address": [("root"), ("password")], "ip-address": [("root"), ("password")], "ip-address": [("root"), ("password")]}

1. Detect the config-api image ID:
   content_copy zoom_out_map

   image_id=`docker images | awk '/config-api/{print $3}' | head -1`

2. Run the pre-synchronization.
   content_copy zoom_out_map

   docker run --rm -it --network host -v $(pwd)/contrail-issu.conf:/etc/contrail/contrail-issu.conf --entrypoint /bin/bash -v /root/.ssh:/root/.ssh $image_id -c "/usr/bin/contrail-issu-pre-sync -c /etc/contrail/contrail-issu.conf"

3. Run the run-synchronization.
   content_copy zoom_out_map

   docker run --rm --detach -it --network host -v $(pwd)/contrail-issu.conf:/etc/contrail/contrail-issu.conf --entrypoint /bin/bash -v /root/.ssh:/root/.ssh --name issu-run-sync $image_id -c "/usr/bin/contrail-issu-run-sync -c /etc/contrail/contrail-issu.conf"

4. Check the logs of the run-sync process. To do this, open the run-sync container.
   content_copy zoom_out_map

   docker exec -it issu-run-sync /bin/bash
   cat /var/log/contrail/issu_contrail_run_sync.log

5. Stop and remove the run-sync process after all compute nodes are upgraded.
   content_copy zoom_out_map

   docker rm -f issu-run-sync

Transferring the Compute Nodes into the New Cluster

1. Select the compute node(s) for transferring into the new cluster.
2. Move all workloads from the node(s) to other compute nodes. You also have the option to terminate workloads as appropriate.
3. For Contrail Release 3.x, remove Contrail from the node(s) as follows:

   • Stop the vrouter-agent service.

   • Remove the vhost0 interface.

   • Switch the physical interface down, then up.

   • Remove the vrouter.ko module from the kernel.

4. For Contrail Release 4.x, remove Contrail from the node(s) as follows:

   • Stop the agent container.

   • Restore the physical interface.

5. Add the required node(s) to instances.yml with the roles vrouter and openstack_legacy_compute.
6. Run the Contrail Helm deployer to deploy the new vrouter and to configure the old compute service.
7. All new compute nodes will have:

   • The collector setting pointed to the new Contrail cluster

   • The Control/DNS nodes pointed to the new Contrail cluster

   • The config-api setting in vnc_api_lib.ini pointed to the new Contrail cluster

8. (Optional) Run a test workload on transferred nodes to ensure the new vrouter-agent works correctly.

1. Move the workload from the compute node.
2. Stop the Contrail Release 5.0.x containers.
3. Ensure the network configuration has been successfully reverted.
4. Deploy the previous version of Contrail using the deployment method for that version.

The detailed steps for transferring compute nodes into the new cluster are as follows:

# stop services
systemctl stop contrail-vrouter-nodemgr
systemctl stop contrail-vrouter-agent
# remove packages
apt-get purge -y contrail*
# restore original interfaces definition
cd /etc/network/interfaces.d/
cp 50-cloud-init.cfg.save 50-cloud-init.cfg
rm vrouter.cfg
# restart networking
systemctl restart networking.service
# remove old kernel module
rmmod vrouter
# maybe you need to restore default route
ip route add 0.0.0.0/0 via 10.0.10.1 dev ens3

1. Download the file contrail-helm-deployer-release-tag.tgz onto your provisioning host
2. Run the command scp contrail-helm-deployer-release-tag.tgz for all nodes in the cluster
3. Untar contrail-helm-deployer-release-tag.tgz on all nodes:
   content_copy zoom_out_map

   tar -zxf contrail-helm-deployer-release-tag.tgz -C /opt/
   

The next set of steps sets up the new compute nodes for Contrail deployment.

1. Add the new instance to /opt/openstack-helm-infra/tools/gate/devel/multinode-inventory.yaml, in the nodes section.
2. Prepare the new compute nodes for Contrail deployment:
   content_copy zoom_out_map

   export BASE_DIR=/opt
   export OSH_INFRA_PATH=${BASE_DIR}/openstack-helm-infra
   export CHD_PATH=${BASE_DIR}/contrail-helm-deployer
   cd ${OSH_INFRA_PATH}
   make dev-deploy setup-host multinode
   make dev-deploy k8s multinode
   

3. Verify the new node names by using the command kubectl get nodes.
4. Label the new nodes as follows:
   content_copy zoom_out_map

   kubectl label node name --overwrite openstack-control-plane=disable
   kubectl label node name opencontrail.org/vrouter-kernel=enabled
   

5. To avoid reprovisioning compute nodes when adding them, set the maintenance mode to TRUE in values.yaml. For example:
   content_copy zoom_out_map

   global:
   contrail_env_vrouter_kernel:
   MAINTENANCE_MODE: TRUE
   

6. If adding vrouter with the DPDK or SRIOV role, switch the kernel to dpdk or sriov mode as appropriate.
   Note

   You need only to deploy the vrouter Helm chart just once for the first compute node or nodes. Upon subsequent deployments, k8s will automatically deploy vrouter on the new nodes.

7. Add vrouter as follows:
   content_copy zoom_out_map

   helm install --name contrail-vrouter ${CHD_PATH}/contrail-vrouter --namespace=contrail --values=/tmp/values.yaml

8. After labeling and installing the new nodes, get the pods to verify they are operational.
   content_copy zoom_out_map

   kubectl get pods -n contrail

   Note

   If the new nodes are not deployed correctly, check for the presence of a default route. If a default route is not present, restore it.

9. At this point, contrail-status for compute nodes should have output as follows:
   content_copy zoom_out_map

   vrouter kernel module is PRESENT
   == Contrail vrouter ==
   nodemgr: active
   agent: initializing (No Configuration for self)
   

10. Restart contrail-control on all the new controller nodes after upgrading the compute nodes.
    content_copy zoom_out_map

    docker ps | grep control-control | awk '{print $1}' | xargs docker 

11. Transfer the new code into the compute node as follows:
    content_copy zoom_out_map

    pythonpath=`python -c "import sys; paths = [path for path in sys.path if 'packages' in path] ; print(paths[-1])"`
    	init_image_id=`docker images | awk '/contrail-vrouter-agent/{print $1":"$2}' | head -1 | sed 's/contrail-vrouter-agent/contrail-openstack-compute-init/'`
    	docker run --rm -it --network host -v /usr/bin:/opt/plugin/bin -v $pythonpath:/opt/plugin/site-packages $init_image_id
    

12. Check status of new compute nodes by running contrail-status on them. All components should be active now. You can also check the status of the new instance by creating AZ/aggregates with the new compute nodes and run some test workloads to ensure it operates correctly.

Finalizing the Contrail Helm Deployer ISSU Process

1. Stop the issu-run-sync container.
   content_copy zoom_out_map

   docker rm -f issu-run-sync

2. Run the post synchronization commands.
   content_copy zoom_out_map

   docker run --rm -it --network host -v $(pwd)/contrail-issu.conf:/etc/contrail/contrail-issu.conf --entrypoint /bin/bash -v /root/.ssh:/root/.ssh --name issu-run-sync $image_id -c "/usr/bin/contrail-issu-post-sync -c /etc/contrail/contrail-issu.conf"
   docker run --rm -it --network host -v $(pwd)/contrail-issu.conf:/etc/contrail/contrail-issu.conf --entrypoint /bin/bash -v /root/.ssh:/root/.ssh --name issu-run-sync $image_id -c "/usr/bin/contrail-issu-zk-sync -c /etc/contrail/contrail-issu.conf"
   

3. Start all previously stopped containers.
   content_copy zoom_out_map

   docker ps | grep config-devicemgr | awk '{print $1}' | xargs docker unpause | xargs docker restart
   docker ps | grep config-schema | awk '{print $1}' | xargs docker unpause | xargs docker restart
   docker ps | grep config-svcmonitor | awk '{print $1}' | xargs docker unpause | xargs docker restart
   

4. Disengage maintenance mode. To do this, set the entry MAINTENANCE_MODE in values.yaml to FALSE, then run the following command from the deployment node:
   content_copy zoom_out_map

   helm upgrade -f /tmp/values.yaml contrail-vrouter /opt/contrail-helm-deployer/contrail-vrouter

5. Clean up and remove the old Contrail controllers. Use the provision-issu.py script called from the config-api container, with the config issu.conf. Replace the credential variables and API server IP with appropriate values as indicated.
   content_copy zoom_out_map

   [DEFAULTS]
   db_host_info={"ip-address": “node-ip-address”, "ip-address": “node-ip-address”, "ip-address": “node-ip-address”}
   config_host_info={"ip-address": “node-ip-address”, "ip-address": “node-ip-address”, "ip-address": “node-ip-address”}
   analytics_host_info={"ip-address": “node-ip-address”, "ip-address": “node-ip-address”, "ip-address": “node-ip-address”}
   control_host_info={"ip-address": “node-ip-address”, "ip-address": “node-ip-address”, "ip-address": “node-ip-address”}
   admin_password = admin password
   admin_tenant_name = admin tenant
   admin_user = admin username
   api_server_ip= any IP of new config-api controller
   api_server_port=8082
   

6. Run the following commands from any controller node:
   Note

   All *host_info parameters should contain the list of new hosts.

   content_copy zoom_out_map

   config_api_cid=`docker ps | awk '/config-api/{print $1}' | head`
   	docker cp issu.conf $config_api_cid:issu.conf
   	docker exec -it $config_api_cid python /opt/contrail/utils/provision_issu.py -c issu.conf
   

7. Servers can be cleaned up if there are no other services present.
8. All configurations for the neutron-api must be edited to have the parameter api_server_ip point to the list of new config-api IP addresses. Locate ContrailPlugin.ini (or other file that contains this parameter) and change the IP addresses to the list of new config-api IP addresses.
9. The heat configuration needs the same changes. Locate the parameter [clients_contrail]/api_server and change it to point to the list of the new config-api IP addresses.