Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Upgrading to Contrail Service Orchestration Release 3.3


From Contrail Service Orchestration (CSO) Release 3.3, you can directly upgrade the CSO software from Release 3.2.1 by running scripts.

This upgrade procedure is independent of the deployment type (trial and production), environment type (non-HA and HA), infrastructure components and microservices used, and the hypervisor type (KVM or VMware ESXi).

Before you begin the upgrade:

  • Ensure that you are in Contrail Service Orchestration (CSO) Release 3.2.1.

  • Ensure the installer Virtual Machine (VM) is up and running.

  • If you are using VMware ESXi VMs, you must create the provision_vm.conf file in the Contrail_Service_Orchestration_3.3/confs/ directory.

    For example, for a trial environment with HA, you can refer to the provision_vm.conf that is available in the Contrail_Service_Orchestration_3.3/confs/trial/ha/provisionvm/.

  • If you have created a device template by cloning an existing device template, you must specify the new device template name in the customer_migration.json file, and place the file in the /path/Contrail_Service_Orchestration_3.3/ micro_services/data/ location.

    For example, in the following customer_migration.json file, you must specify the new device template name in new-device-template-name.

To upgrade to CSO Release 3.3:

  1. Download the CSO Release 3.3 installer package from the Software Downloads page to the local drive.
  2. Login to the installer VM as root.
  3. Copy the installer package from your local folder to the installer VM.
    root@host:~/# scp Contrail_Service_Orchestration_3.3.tar.gz root@installer VM :/root
  4. On the installer VM, extract the installer package.

    For example, if the name of the installer package is Contrail_Service_Orchestration_3.3.tar.gz,

    root@host:~/# tar –xvzf Contrail_Service_Orchestration_3.3.tar.gz

    The contents of the installer package are extracted in a directory with the same name as the installer package.

  5. Navigate to the CSO Release 3.3 directory in the installer VM.
    root@host:~/# cd Contrail_Service_Orchestration_3.3

    (Optional) You can view the list of files in the Contrail_Service_Orchestration_3.3.

    root@host:~/Contrail_Service_Orchestration_3.3# ls

    The file includes the following scripts:



  6. Run the script.Warning

    Before you upgrade ensure that all ongoing jobs in Administration Portal and Customer Portal are stopped; otherwise during the upgrade the ongoing jobs are stopped. During the upgrade, you experience a downtime as CSO goes into maintenance mode.

    This script upgrades CSO software from Release 3.2.1 to Release 3.3. The script puts CSO in maintenance mode, takes a snapshot of running status of all VMs (optional), upgrades all microservices and infrastructure components if required, performs health checks at various levels, validates if all VMs, infrastructure components, and microservices are up and running, and puts the CSO in live mode.

    If the environment type is production, the script takes a snapshot of all VMs by default. For trial environment you are prompted to confirm whether you want to take a snapshot.


    The script does not take a snapshot of installer VM and Virtual Route Reflector (VRR) VM.

    root@host:~/Contrail_Service_Orchestration_3.3# ./


    The password for each infrastructure component and the Administration Portal password are displayed on the console after the upgrade is successful. You must note the password that is displayed on the console as they are not saved in the system. To enhance the password security, the length and pattern for each password is different and the password is encrypted, and passwords in the log file are masked.

    The time taken to complete the upgrade process depends on the hypervisor type and the environment type. If you are using KVM as the hypervisor, while taking a snapshot all VMs are shut down. If you are using VMware ESXi as the hypervisor, while taking a snapshot all VMs are up and running.

    If an error occurs, you must fix the error and rerun the script. When you rerun the script, the script continues to execute from the previously failed step.

    You can view the following log files that are available at root/Contrail_Service_Orchestration_3.3/logs:

    • upgrade_console.log

    • upgrade_error.log

    • upgrade.log

  7. (Optional) If you are unable to troubleshoot the error you can roll back to your previous release. Run the script.
    root@host:~/Contrail_Service_Orchestration_3.3# ./

After a successful upgrade, CSO is functional and you can login to Administrator Portal and Customer Portal.


After you successfully upgrade from CSO Release 3.2.1 to Contrail Service Orchestration (CSO) Release 3.3, ensure that you download the application signatures before installing signatures on the device. This is a one-time operation after the upgrade.