Upgrading an Existing Installation

Prerequisites:

Check in the release notes of the new CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. version that an upgrade path from the currently installed version exists. If there is no direct upgrade path then it will be necessary to perform a series of upgrades following defined upgrade paths, for example 8.10 - 8.12 is not supported so an 8.10 - 8.11 upgrade would need to be performed, followed by an 8.11 - 8.12 upgrade.
If the release notes for the target release state that PostgreSQL or Linux A well-known widely used open source operating system. major versions need to be upgraded, then complete those upgrades prior to starting the installation.
Ensure that the Ansible version on the control server is aligned to the requirements of the target CMP release.
Complete the pre-installation tasks as described in the release note of the CMP version to be upgraded to.
Review the Installation Configuration Tool section of this guide to identify new parameters, or changes to existing parameters, that you may need for your upgrade.
Update the original inventory file used for the last installation or upgrade of the target system using the Installation Configuration tool online at https://inventory-config.cmp-docs.com:

1. Open the Installation Configuration Tool and select the CMP version to be upgraded to

2. Click on load and select the original inventory file used for the last installation or upgrade of the target system

3. Acknowledge the warning that the CMP version to be installed by the inventory file is being updated

4. Make any changes required to the properties to be used for the installation paying particular attention to update values for new mandatory properties added since the previous release version

To upgrade an existing CMP installation, use the same ansible-playbook command to deploy a new installation:

ansible-playbook --ask-vault-password-file=<vault_password_file> -i <inventory_file> -b playbooks/deploy.yaml

The playbooks/deploy.yaml file can be executed multiple times. At each run the playbooks will:

Deploy the latest CMP RPMs
Recreate the necessary configuration file

It is safe to run the deploy.yaml playbook multiple times as long as the principal properties in the inventory file used during the execution are not modified. The principal properties of the inventory file are:

Group hosts
Ports allocated to each component
Credentials used within the CMP components

The group In the Customer Manager Platform hierarchy, the highest level of the structure. The group level can be used to group corporates. Groups can hold financial information. hosts must not be modified under any circumstances (except where adding additional hosts). If there is a need to change a host in the group ,the CMP stack must currently be uninstalled first using the old inventory file. After that the hosts can be changed and the deploy.yaml playbook executed again with the modified inventory file.

Ports in theory can be changed, however the old ports must be excluded from the firewall configuration (if firewall is enabled on the target host).

Database credentials can be changed in the inventory file only to reflect manual changes. For example, if an administrator changes a database user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. password, the new password in question must be modified in the inventory file prior to the next upgrade.

The same applies to the application credentials.

Certificate Updates

In a similar way to running an upgrade, you can also run a deployment to ONLY update the SSL Certificates installed in the various backend systems. To do this, first make sure the new certificates are in the correct location as defined in your inventory file under the ssl_certificates section.

Then use the same ansible-playbook command as previously but adding to the end of it --tags ssl_configuration -e ssl_update=true as shown below:

ansible-playbook --vault-password-file=<vault_password_file> -i <inventory_file> -b playbooks/deploy.yaml --tags ssl_configuration -e ssl_update=true

Patch Updating

There is an option to run a deployment to ONLY patch update the installed CMP components where necessary. This option uses the Ansible tags in order to skip running unnecessary tasks and run only those tasks required for updating the RPMs that may have been patched for the CMP system.

This method runs through the playbook, installs only those RPMs that have been patched/updated and performs a service restart, thereby reducing downtime by affecting only those updated components.

When you are ready to patch update, first ensure you read and adhere to the above notes on updating an existing installation (although unless explicitly stated in the patch release note, a patch will not require any change to the inventory file that was used for the last installation) and then use the same ansible-playbook command as previously but adding to the end of it -e patch_update=true --tags installation as shown in the following example:

ansible-playbook --ask-vault-password-file=<vault_password_file> -i <inventory_file> -b playbooks/deploy.yaml -e patch_update=true --tags installation