Verify that the nodes and services in your existing deployment are healthy. This process takes approximately 5 minutes. If the platform health check indicates that any components are unhealthy, then you should recover those components prior to proceeding with the upgrade.

ansible-playbook checks/check-vms.yml 

Perform a backup of the keys and passwords in the old MSX 3.8.0 container (There is no container for MSX 3.8.2.).

ansible-playbook vms-backup.yml --tags pass-to-vault,keys-to-vault

Copy the files that are essential for the upgrade process. These files should not have changed from your first MSX install and they will be used for all future MSX versions. The commands for copying the files are:

cp /msx-3.8.0/ansible/ssh.cfg /msx-3.8.0/ansible/vms-backup/infra/
cp /msx-3.8.0/ansible/inventory/inventory /msx-3.8.0/ansible/vms-backup/infra/
cp /msx-3.8.0/ansible/keys/id_rsa.pub /msx-3.8.0/ansible/vms-backup/infra/
cp /msx-3.8.0/ansible/keys/id_rsa /msx-3.8.0/ansible/vms-backup/infra/
cp /msx-3.8.0/ansible/group_vars/all/external_addresses.yml /msx-3.8.0/ansible/vms-backup/infra
cp /msx-3.8.0/ansible/vms-backup/infra/<openrc> /msx-3.8.0/ansible/

Download the following tar files from the MSX Software Download page. Click Download Options to see the files.

At this stage, you will create files that will verify that the msx-container and msx-binaries tar files are not corrupt. On the Software Download page, hover your mouse over the msx-binaries-3.9.0-xxx.tar file. You will see a dialog that shows the SHA512 checksum.

Click the copy icon and then paste the checksum content into a text file called msx-binaries-3.9.0-xxx.tar.sha512sum.

Repeat this process for the msx-container-3.9.0-xxx.tar file and name the saved file: msx-container-3.9.0-xxx.tar file.sha512sum.

Untar the following signature files:

Validate the binaries and container signature files (*.sig) as follows:

Copy the msx-binaries-3.9.0-xxx.tar and msx-container-3.9.0-xxx.tar to the host where you plan on installing MSX.

Use SSH to connect to the host where you will install MSX.

Run this command on the host to load the MSX container image:

[root@CentOS localadmin] # docker load -i MSX-container-3.9.0-xxx.tar

Extract msx-binaries-3.9.0-xxx.tar to /vms-binaries-mount-source.

Get the <docker_image_ID> using the command:

[root@CentOS localadmin] # docker images
REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
<none>              <none> 	    e94ad25e65a9         5 days ago          383 MB

Spin up the 3.9.0 container with the vms-backup-mount-source folder attached as a volume:

docker run --name <3.9.0-Container_Name> -v <vms-container-mount-source>:/msx-3.9.0/ansible/repo -v <vms-backup-mount-source>:/msx-3.9.0/ansible/vms-backup <docker image id> -it /bin/bash

Copy the required files as shown:

cp /msx-3.9.0/ansible/vms-backup/infra/inventory-active /msx-3.9.0/ansible/inventory/inventory
cp /msx-3.9.0/ansible/vms-backup/infra/ssh.cfg-active /msx-3.9.0/ansible/ssh.cfg
cp /msx-3.9.0/ansible/vms-backup/infra/external_addresses.yml-active /msx-3.9.0/ansible/group_vars/all/external_addresses.yml
cp /msx-3.9.0/ansible/vms-backup/infra/<openrc> /msx-3.9.0/ansible/<openrc>
 

Create a folder to copy the keys into and perform the copy operation:

mkdir /msx-3.9.0/ansible/keys
cp /msx-3.9.0/ansible/vms-backup/infra/id_rsa /msx-3.9.0/ansible/keys
cp /msx-3.9.0/ansible/vms-backup/infra/id_rsa.pub /msx-3.9.0/ansible/keys

Edit /msx-3.9.0/ansible/ssh.cfg to replace all instances of "msx-3.8.0" with "msx-3.9.0".

Make the required changes in group_vars/all/main.yml, using the backed up main.yml as a reference.

Edit main.yml to set the auto_generate_password variable to 'false'. This is the path to the file:/msx-3.9.0/ansible/group_vars/all/main.yml

Create a vault_password file with the same password used in MSX 3.8.0 and export the path as specified:

export ANSIBLE_VAULT_PASSWORD_FILE=<path to vault_password file>

(OpenStack Only) Source the V3 OpenStack configuration file to enable access to your OpenStack project, which will use the values within the openrc file:

source <path-to-openrc> 

Navigate to the msx-3.9.0/ansible folder. All playbooks must be run from this folder after this.

Execute the MSX prerequisites playbook to prepare the new MSX 3.9 container for an upgrade. The playbook will perform password, security group-related, and other updates as required. This process should take approximately 5 minutes.

ansible-playbook upgrade-prereq.yml --extra-vars @vms-backup/infra/passwords.yml --skip-tags vnfoutside,csr_route_upgrade 

Verify that the nodes and services in your upgraded deployment are healthy. If any part of the system is unhealthy, then do not perform the MSX upgrade until issues are remedied and a system check successfully passes. This process should take approximately 5 minutes.

ansible-playbook checks/check-vms.yml

Navigate to the msx-3.9.0 Ansible folder.

cd /msx-<version>/ansible 

Create an Ansible vault password file with the same password used in MSX 3.8.0 and export the path as specified:

export ANSIBLE_VAULT_PASSWORD_FILE=<path_to_vault_password_file> 

(OpenStack only) Source the V3 OpenStack configuration file to enable access to your OpenStack project, which will use the values within the openrc file:

source <path-to-openrc>

Upload the MSX isolated binaries to your S3 (AWS) / minio (OpenStack) bucket. This process should take approximately 15 minutes.

ansible-playbook upload-isolated-binaries.yml 

Edit /msx-3.9.0/ansible/group_vars/all/main.yml to change the mode variable from “FreshInstall” to "Upgrade".

Upload the service packs that you require. For all Service Packs, this process should take approximately 30 minutes.

ansible-playbook upload-all-servicepacks.yml 

Run the following script from the 3.9 container to perform a data backup of the MSX instance that is in service. The data backup process allows you to take a backup of all persistent MSX data, such as Cassandra, Elasticsearch, and NSO data. This process is useful in cases where you might need to recover lost or corrupted MSX data from a backup. This process should take approximately 30 minutes.

ansible-playbook vms-backup.yml --extra-vars backup_tag=backup-tag-name 

Edit each Service Pack deployment variables file so that it matches your deployment requirements. Additionally, set the schema_mode variable to "Upgrade". The Service Pack variable files are located at: /msx-3.9.0/ansible/group_vars/all/servicepack_name_variables.yml

Upgrade the Infra Services to update the infrastructure components for the Platform Microservices and Service Packs. This process should take approximately 20 minutes.

ansible-playbook upgrade-infra-services.yml 

Run the Blue/Green platform Microservice update, which will upgrade the Platform and Service Packs. Both 3.8.2 and 3.9.0 Microservices will be running in parallel, however all traffic will be routed to 3.8.2 at this stage. Additionally, all Microservices will be running in non-HA mode.

ansible-playbook blue-green-ms-upgrade.yml 

Perform an upgrade of the Network Service Orchestrator (NSO) component. At this point, any updates to existing services or the provisioning of new services will be queued (and delayed) until the NSO upgrade has completed.

ansible-playbook bg-nso-upgrade.yml 

Run the switch-ms-routing.yml playbook. This will redirect traffic from MSX 3.8.2 to 3.9, enable HA mode, and will delete all 3.8.2 Microservice instances once complete.

ansible-playbook switch-ms-routing.yml 

Upgrade the MSX user interface for the Platform and Service Packs.

ansible-playbook upgrade-ui.yml 

Upgrade Action Orchestrator and the Workflow engine. The Workflow engine will be placed in maintenance mode, so no new Workflows can be created or updated during this time. This process should take approximately 40 minutes.

ansible-playbook upgrade-ao.yml 

Upgrade OS and Kubernetes. This will update Kubernetes and the underlying Operating System kernel, security components, and any other required system updates. This upgrade will be performed one node at a time starting with the Kubernetes Master nodes.

ansible-playbook os-k8s-rolling-upgrade.yml 

Verify that the nodes and services in your upgraded deployment are healthy. This process should take approximately 5 minutes.

ansible-playbook checks/check-vms.yml 

Import Service Provider metadata into MSX.

1. Save the metadata file to the following location in the Kubernetes node:

   /data/vms/heapdumps/usermanagementservice/vmanage_metadata.xml

   MSX Usermanagement services maps the above Kubernetes location to the following:

   /data/conf/vmanage_metadata.xml

   Specify the location (/data/conf/vmanage_metadata.xml) as the metadata file location while importing the file into MSX.

2. Log in to the Cisco MSX Portal.

3. In the main menu, go to Settings > SSO Configuration.

4. In the Add SSO Client’s section, select the SAML service provider client ID (vManage in this case) and click the Edit icon.

   In the Attributes section, specify the vManage metadata file location (from step a) in the Metadata Source field. The metadata source field takes a URL or a file path.

   Note	Metadata fields appear only if you have selected SAML service provider client ID.

[Applicable only for Cisco SD-WAN] Turn off the SAML security settings.

1. Log in to Inception VM and access the kubernetes master node.

   ssh -i id_rsa centos@_INCEPTION_FLOATING_IP_ADDRESS_ -t ssh _kubernetes-master-1_IP_ADDRESS

2. Use the following cURL commands:

   curl --request PUT -g -k -v -H "X-Consul-Token: {consul_token_value}" --data 'false' https://localhost:8500/v1/kv/userviceconfiguration/defaultapplication/security.auth.saml.want-authn-request-signed

   curl --request PUT -g -k -v -H "X-Consul-Token: {consul_token_value}" --data 'false' https://localhost:8500/v1/kv/userviceconfiguration/defaultapplication/security.auth.saml.encrypt-assertion

   Note	Replace {consul_token_value} with your actual consul token value from the passwords.yml file.

3. Save the above consul entries. To save, restart the UserManagement microservices from the Kubernetes master node using the following commands:

   kubectl -n vms delete -f /etc/kube-manifests/usermanagementservice-rc.yml
   kubectl -n vms create -f /etc/kube-manifests/usermanagementservice-rc.yml