Upgrade a Single Node Cluster Environment with the ISO and Template#
Important
Upgrading to release 21.1 requires a system on 19.x, with security updates completed.
While template installation and system upgrade takes approximately two hours at a single site, this may vary in accordance with your topology, number of devices and subscribers. Adjust your upgrade maintenance window to allow for your configuration.
When upgrading from CUCDM 11.5.3 Patch Bundle 2 or VOSS-4-UC 18.1 Patch Bundle 2 and earlier, re-import specified CUC models according to your current version. Refer to the final upgrade procedure step.
Tasks that are marked Prior to Maintenance Window can be completed a few days prior to the scheduled maintenance window so that VOSS support can be contacted if needed and in order to allow for reduce down time.
The standard screen command should be used where indicated. See: Using the screen command.
Download Files and Check (Prior to Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
VOSS files: https://voss.portalshape.com > Downloads > VOSS Automate > XXX > Upgrade Download Either using SFTP:
Or using SCP:
Verify that the
Verify that the original
|
Security and Health Steps single node cluster (Prior to Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
Validate the system health. Verify there are no pending Security Updates: security check |
|
Check system health.
If there is any sign of the paths below are over 80% full, a clean-up is needed, for example to avoid risk of full logs occurring during upgrade. Clean-up steps are indicated next to the paths: / (call support if over 80%)
/var/log (run: log purge)
/opt/platform (remove any unnecessary files from /media directory)
/tmp (reboot)
|
Schedules, Transactions and Version Check (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
Turn off any scheduled imports to prevent syncs triggering part way through the upgrade. Two options are available: Individually for each job:
Mass modify:
Schedules enabled on the CLI:
|
|
Check for running imports. Either wait for them to complete or cancel them:
|
|
Customized ``data/Settings`` If The modifications can be re-applied or exported JSON instances can be merged following the upgrade. See: Post Template Upgrade Tasks single node cluster (Maintenance Window). Version Record the current version information. This is required for upgrade troubleshooting.
|
Pre-Upgrade Steps single node cluster (Maintenance Window)#
Create a restore point and then restart server. As part of the rollback procedure, ensure that a suitable restore point is obtained prior to the start of the activity, as per the guidelines for the infrastructure on which the VOSS Automate platform is deployed. If you cannot restore the application from a restore point, your only recourse is to reinstall the application. When the backup is complete and you do not need the restore point for restore activities, you can remove it. After the restore point has been created, restart. Optional: If a backup is required in addition to the restore point, use the backup add <location-name> and backup create <location-name> commands. For details, refer to the Platform Guide. |
Description and Steps |
Notes and Status |
---|---|
Before upgrading, check all services: Make sure no services are stopped/broken. The message ‘suspended waiting for mongo’ is normal on a fresh node.
Verify the node is not in the ‘recovering’ state (
|
The following step is needed if own private certificate and generated SAN certificates
are required and the The steps below are needed to check if a CSR private key exists but no associated signed certificate is available. Request VOSS support to run on the CLI as for LST in /opt/platform/apps/nginx/config/csr/*;
do openssl x509 -in $LST -text -noout >/dev/null
2>&1 && SIGNED="$LST"; done
echo $SIGNED
If the mv /opt/platform/apps/nginx/config/csr/ /opt/platform/apps/nginx/config/csrbackup
|
Upgrade single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
It is recommended that the upgrade steps are run in a terminal opened with the screen command. On the primary unified node:
All unused docker images except Note: If the system reboots, do not carry out the next manual reboot step. When upgrading from pre-19.1.1, an automatic reboot should be expected. To remove a mount directory cluster run all app cleanup Manual reboot only if needed:
If node messages: Since all services will be stopped, this takes some time. Close screen: |
Note
In order to carry out fewer upgrade steps, the updates of instances of the some models are skipped in the cases where:
data/CallManager
instance does not exist as instance indata/NetworkDeviceList
data/CallManager
instance exists, butdata/NetworkDeviceList
is emptyCall Manager AXL Generic Driver and Call Manager Control Center Services match the
data/CallManager
IP
Post-Upgrade, Security and Health Steps single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
Verify the status:
|
|
If upgrade is successful, the screen session can be closed by typing exit in the screen terminal. If errors occurred, keep the screen terminal open for troubleshooting purposes and contact VOSS support. |
|
Complete all the security updates.
The docker images Note: If the system reboots, do not carry out the next manual reboot step . When upgrading from pre-19.1.1, an automatic reboot should be expected. Manual reboot only if needed:
|
Database Filesystem Conversion single node cluster (Maintenance Window, if required)#
Important
To check if the step is not required:
Run drives list and ensure that the LVM storage shows for all converted database nodes under
Volume Groups
. If the output of the drives list command containsdm-0 - mongodb:dbroot
, the step is not required. Refer to the drives list command output example below.
The database convert_drive command provides parameters that allow for a flexible upgrade schedule in order to limit system downtime.
When the database convert_drive command is run, the voss-deviceapi
service will be stopped first and started after completion. The command
should therefore be run during a maintenance window while there are no
running transactions.
For a single node cluster system drive conversion, ensure the standalone
parameter is used.
Description and Steps |
Notes and Status |
---|---|
Shut down. Since all services will be stopped, this takes some time.
Create a restore point as per the guidelines for the infrastructure on which the VOSS Automate platform is deployed so that the system can easily be reverted in the case of a conversion error. Stop transactions from being scheduled. Run:
Note: this step may take a few hours. Wait until it completes successfully.
|
Database Schema Upgrade single node cluster (Maintenance Window)#
Important
When upgrading from 19.X or earlier, please refer to the VOSS-4-UC 21.1 Release Changes and Impact document for details on model and workflow changes. Customizations related to these changes may be affected by this step.
Description and Steps |
Notes and Status |
---|---|
It is recommended that the upgrade steps are run in a terminal opened with the screen command.
|
Template Upgrade single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
It is recommended that the upgrade steps are run in a terminal opened with the screen command.
|
The following message appears:
Running the DB-query to find the current environment's
existing solution deployment config...
Python functions are deployed
System artifacts are imported.
The template upgrade automatically detects the deployment mode: “Enterprise”, “Provider with HCM-F” or “Provider without HCM-F”. A message displays according to the selected deployment type. Check for one of the messages below:
Importing EnterpriseOverlay.json
Importing ProviderOverlay_Hcmf.json ...
Importing ProviderOverlay_Decoupled.json ...
The template install automatically restarts necessary applications.
Description and Steps |
Notes and Status |
---|---|
Review the output from the app template command and confirm that the upgrade message appears: Deployment summary of PREVIOUS template solution
(i.e. BEFORE upgrade):
-------------------------------------------------
Product: [PRODUCT]
Version: [PREVIOUS PRODUCT RELEASE]
Iteration-version: [PREVIOUS ITERATION]
Platform-version: [PREVIOUS PLATFORM VERSION]
This is followed by updated product and version details: Deployment summary of UPDATED template solution
(i.e. current values after installation):
-----------------------------------------------
Product: [PRODUCT]
Version: [UPDATED PRODUCT RELEASE]
Iteration-version: [UPDATED ITERATION]
Platform-version: [UPDATED PLATFORM VERSION]
|
Description and Steps |
Notes and Status |
---|---|
|
|
For an unsupported upgrade path, the install script stops with the message: Upgrade failed due to unsupported upgrade path.
Please log in as sysadmin
and see Transaction logs for more detail.
You can restore to the backup or rollback/revert to the restore point made before the upgrade. |
|
If there are errors for another reason, the install script stops with a failure message listing the problem. Contact VOSS support. |
|
Post upgrade migrations:
Data migrations that are not critical to system operation can have significant execution time at scale. These need to be performed after the primary upgrade, allowing the migration to proceed whilst the system is in use - thereby limiting upgrade windows. A transaction is queued on VOSS Automate and its progress is displayed as it executes. |
Description and Steps |
Notes and Status |
---|---|
Check status and health
|
Post Template Upgrade Tasks single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
Import ``device/cucm/PhoneType`` In order for a security profile to be available for a Call Manager Analog Phone,
the
SSO Login URL check if needed Verify the SSO Login URL if needed. Go to Single Sign On > SSO Identity Provider and ensure your URL matches the SSO Login URL value. Support for VG400 and VG450 Analogue Gateways Before adding the VG400 or VG450 Gateway, the
Verify the upgrade: Log in on the Admin Portal and check the information contained in the About > Version menu. Confirm that versions have upgraded.
where If your web browser cannot open the user interface, clear your browser cache before trying to open the interface again. |
|
|
Restore Schedules single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
Re-enable scheduled imports if any were disabled prior to the upgrade. Two options are available: Individually for each job:
Mass modify:
Note Select the Skip next execution if you do not wish to execute schedules overlapping the maintenance window, but only execute thereafter. Schedules enabled on the CLI:
|
Release Specific Updates single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
When upgrading from CUCDM 11.5.3 Patch Bundle 2 or VOSS-4-UC 18.1 Patch Bundle 2 and earlier, re-import the following from all CUCM devices, since this upgrade deleted obsolete CUC timezone codes from the VOSS Automate database:
Note: This is a once off data migration step. If this was performed previously when upgrading to 19.1.x, then it does not have to be repeated. |
|
After upgrading, obtain and install the following patch according to its accompanying MOP file, where XXX matches the release:
Note: This is a once off data migration step. If this was performed previously when upgrading to 19.x, then it does not have to be repeated. |
|
Re-import the following from all CUCM devices:
For steps to create a custom data sync, refer to the chapter on Data Sync in the Core Feature Guide. Note: This is a once off data migration step. If this was performed previously when upgrading to 19.1.x, then it does not have to be repeated. |
|
When upgrading to release 21.3, users of Microsoft apps should after upgrade, select each
Microsoft Tenant ( This step is required so that VOSS Automate can communicate with the Tenant post upgrade. |
|
Only if the following step was not carried out when upgrading to Release 21.3-PB1: On the primary node, run:
|
Log Files and Error Checks single node cluster (Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
Inspect the output of the command line interface for upgrade errors,
for example Use the log view command to view any log files indicated in the error messages, for example, run the command if the following message appears: For more information refer to the execution log file with
'log view platform/execute.log'
For example, if it is required send all the install log files in the
|
|
Log in on the Admin Portal as system level administrator, go to Administration Tools > Transaction and inspect the transactions list for errors. |
Licensing (outside, after Maintenance Window)#
Description and Steps |
Notes and Status |
---|---|
From release 21.4 onwards, the deployment needs to be licensed. After installation, a 7-day grace period is available to license the product. Since license processing is only scheduled every hour, if you wish to license immediately, first run voss check-license on the CLI. 1. Obtain the required license token from VOSS. 2.
|
For Upgrading from 18.1.3 to the current release, see: Upgrading from 18.1.3 to Current Release - Summary.