Multinode Upgrade Sheet#
Description |
Steps |
|---|---|
Download Files and Check Steps |
Download Files and Check Steps |
=================================== |
===================================== |
Download VOSS files - XXX is the release number |
https://voss.portalshape.com > Downloads > VOSS Automate > XXX > Upgrade |
Download .iso and .template files |
Transfer the .iso file to the media/ folder of all nodes |
Download .iso and .template files |
Transfer the .template file to the media/ folder of the primary node |
Two transfer options: |
|
Either using SFTP: |
|
sftp platform@<unified_node_hostname> |
|
cd media |
|
put <upgrade_iso_file> |
|
put <upgrade_template_file> |
|
Or using SCP: |
|
scp <upgrade_iso_file> platform@<unified_node_ip_address>:~/media |
|
scp <upgrade_template_file> platform@<unified_node_ip_address>:~/media |
|
Verify that the .iso image and .template file copied: |
ls -l media/ |
Verify that the original .sha256 checksums on the SFTP server match. |
system checksum media/<upgrade_iso_file> |
|
|
system checksum media/<upgrade_template_file> |
|
|
|
Security and Health Check Steps |
Security and Health Check Steps |
=================================== |
===================================== |
Verify that the primary node is the active primary node at the time of upgrade |
database config |
Ensure that the node on which the installation will be initiated has the stateStr parameter set to PRIMARY and has the highest priority number (highest priority number could vary depending on cluster layout) |
Example output |
|
|
Validate the system health. Carry out the following (19.x only): |
system mount - mount the upgrade ISO. |
app install check_cluster - install the new version of the cluster check command. |
|
For details: refer to the ‘Cluster Check’ topic in the Platform Guide. |
|
cluster check - inspect the output of this command for warnings and errors. You can also use cluster check verbose to see more details. While warnings will not prevent an upgrade. It is advisable that these be resolved prior to upgrading where possible. Some warnings may be resolved by upgrading. |
cluster check |
For troubleshooting and resolutions: also refer to the Health Checks for Cluster Installations Guide and Platform Guide. |
|
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 |
On the Primary Unified Node: verify there are no pending Security Updates on any of the nodes. |
|
Note: If you run cluster status after installing the new version of cluster check: any error message regarding a failed command can be ignored. This error message will not show after upgrade. |
|
Schedules, Transactions and Version Check steps |
Schedules, Transactions and Version Check steps |
=================================== |
===================================== |
Run cluster check and verify that no warnings and errors show. |
cluster check |
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. |
|
|
|
|
|
3a. Choose Status as Processing and then choose each Action that starts with Import for example ‘Import Unity Connection’. |
|
3b. Click Search and confirm there are no results. |
|
3c. If there are transactions to cancel: select them and click Cancel. |
|
Customized data/Settings |
If data/Settings instances have been modified: record these or export them as JSON. |
The modifications can be re-applied or exported JSON instances can be merged following the upgrade. See: Window Post Template Upgrade Tasks. |
|
Version |
|
Record the current version information. This is required for upgrade troubleshooting. |
Log in on the Admin Portal and record the information contained in the About > Extended Version |
Pre-Upgrade Steps |
Pre-Upgrade Steps |
=================================== |
===================================== |
VOSS cannot guarantee that a restore point can be used to successfully restore VOSS-4-UC. If you cannot restore the application from a restore point, your only recourse is to reinstall the application. |
|
Create a restore point as per the guidelines for the infrastructure on which the VOSS-4-UC platform is deployed. |
|
Optional: If a backup is also required |
backup add <location-name> |
backup create <location-name> |
|
For details, refer to the Platform Guide. |
|
After restore point creation and before upgrading: validate system health and check all services nodes and weights for the cluster: |
cluster run application cluster list |
Make sure all application nodes show 4 or 6 nodes. |
cluster check |
inspect the output of this command, for warnings and errors. You can also use cluster check verbose to see more details. |
|
Make sure no services are stopped/broken. The message ‘suspended waiting for mongo’ is normal on the fresh unified nodes. |
|
Check that the database weights are set. It is critical to ensure the weights are set before upgrading a cluster. |
|
Example output: |
|
172.29.21.240: weight: 80 |
|
172.29.21.241: weight: 70 |
|
172.29.21.243: weight: 60 |
|
172.29.21.244: weight: 50 |
|
Verify the primary node in the primary site and ensure no nodes are in the ‘recovering’ state (stateStr is not RECOVERING). |
|
Upgrade steps |
Upgrade steps |
=================================== |
===================================== |
It is recommended that the upgrade steps are run in a terminal opened with the screen command. |
|
Verify that the ISO has been uploaded to the ‘media/’ directory on each node. This will speed up the upgrade time. |
|
On the primary unified node: |
screen |
cluster upgrade media/<upgrade_iso_file> |
|
Note: The cluster upgrade command will also silently first run cluster check and the upgrade will fail if any error conditions exist. |
|
Note: A check for security updates will also be made, with message ‘Checking for security updates …’. If updates are found, a message will show the number and carry out the update. If no updates are found, a message ‘No security updates found’ shows. |
|
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: |
cluster run notme system reboot |
If node messages: ‘<node name> failed with timeout’ are displayed,these can be ignored. |
system reboot |
Since all services will be stopped, this takes some time. |
|
Post-Upgrade, Security and Health Steps |
Post-Upgrade, Security and Health Steps |
=================================== |
===================================== |
On the primary unified node, verify the cluster status: |
cluster check |
If any of the above commands show errors, check for further details to assist with troubleshooting: |
cluster run all diag health |
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. |
|
Check for needed security updates. On the primary node, run: |
cluster run all security check |
Note: if the system reboots, do not carry out the next manual reboot step. |
|
Manual reboot only if needed: |
cluster run notme system reboot |
If node messages: <node name> failed with timeout are displayed, these can be ignored. |
system reboot |
Since all services will be stopped, this takes some time. |
|
Database Filesystem Conversion Steps |
Database Filesystem Conversion Steps |
=================================== |
===================================== |
Shut down all the nodes. Since all services will be stopped this takes some time. |
cluster run all system shutdown |
Create a restore point as per the guidelines for the infrastructure on which the VOSS-4-UC platform is deployed - in the case of a conversion error. |
|
Database Schema Upgrade steps |
Database Schema Upgrade steps |
=================================== |
===================================== |
It is recommended that the upgrade steps are run in a terminal opened with the screen command. |
On the primary unified node: screen |
voss upgrade_db |
|
Check cluster status |
cluster check |
Template Upgrade steps |
Template Upgrade steps |
=================================== |
===================================== |
It is recommended that the upgrade steps are run in a terminal opened with the screen command. |
On the primary unified node: screen |
app template media/<VOSS-4-UC.template> |
|
Review the output from the app template command and confirm that the upgrade message appears. |
|
If no errors are indicated: make a backup or create a restore point as per the guidelines for the infrastructure on which the VOSS-4-UC platform is deployed. This restore point can be used if post-upgrade patches that may be required, fail. |
|
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, i.e. 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. |
Verify the ‘extra_functions’ have the same checksum across the cluster. |
cluster run application voss get_extra_functions_version -c |
Post upgrade migrations: |
On a single node of a cluster: run: voss post-upgrade-migrations |
Check cluster status and health |
cluster status |
Post Template Upgrade steps |
Post Template Upgrade steps |
=================================== |
===================================== |
Import device/cucm/PhoneType |
|
In order for a security profile to be available for a Call Manager Analog Phone, the ‘device/cucm/PhoneType’ model needs to be imported for each Unified CM. |
|
|
|
|
|
Customized data/Settings |
|
Merge the previously backed up customized ‘data/Settings’ with the latest settings on the system by manually adding the differences or exporting the latest settings to JSON, merging the customized changes and importing the JSON. |
|
Support for VG400 and VG450 Analogue Gateways |
|
Before adding the VG400 or VG450 Gateway, the ‘device/cucm/GatewayType’ model needs to be imported for each Unified CM. |
|
|
|
|
|
Verify the upgrade |
|
Log in on the Admin Portal and check the information contained in the About > Version menu. Confirm that versions have upgraded. |
|
Release should show ‘XXX’, where this matches the upgrade release. |
|
Check themes on all roles are set correctly |
|
For configurations that make use of the Northbound Billing Integration (NBI): please check the service status of NBI and restart if necessary. |
|
Restore Schedules |
Restore Schedules |
=================================== |
===================================== |
Re-enable scheduled imports if any were disabled prior to the upgrade. Two options are available: |
|
Individually for each job: |
|
|
|
|
|
Mass modify: |
|
|
|
Schedules enabled on the CLI: |
|
Run schedule enable <job-name>. |
|
Release Specific Updates |
Release Specific Updates |
=================================== |
===================================== |
Re-import the following from all CUCM devices: |
|
CUCM models: |
device/cucm/PhoneType |
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. |
|
User Management migration updates default authentication types on SSO Identity Providers. If an SSO Identity Provider exists at the provider hierarchy level - default authentication settings: |
|
Authentication Scope: Current hierarchy level and below |
|
User Sync Type: All users |
|
Will not allow any non-SSO user logins (typically local administrators). The solution is to log in as higher level administrator account (full access) and set the SSO Identity Provider: |
Authentication Scope: Current hierarchy level only |
User Sync Type: LDAP synced users only |
|
Please refer to the SSO Identity Provider: Field Reference topic in the Core Feature Guide. |
|
Users of Microsoft apps |
|
When upgrading to release 21.3, after upgrading, users of Microsoft apps should 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: |
voss migrate_summary_attributes data/InternalNumberInventory |
Log Files and Error Checks |
Log Files and Error Checks |
=================================== |
===================================== |
Inspect the output of the command line interface for upgrade errors - for example: File import failed! or Failed to execute command. |
|
To view any log files indicated in the error messages - for example run the command if the following message appears: |
log view |
For more information refer to the execution log file with log view platform/execute.log |
|
If it is for example required send all the install log files in the install directory to an SFTP server: |
log send sftp://x.x.x.x install |
Log in on the Admin Portal as system level administrator |
Go to Administration Tools > Transaction and inspect the transactions list for errors |