.rst .pdf

On this page

Upgrade a Single Node Cluster Environment with the Delta Bundle

Note

• While 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.

The standard screen command should be used where indicated. See: Using the screen command.

Download Files and Check

Description and Steps

Notes and Status

VOSS files: https://voss.portalshape.com > Downloads > VOSS Automate > XXX > Upgrade where XXX is the release number. Download XXX-Delta-Bundle.script file. Transfer the XXX-Delta-Bundle.script file to the media/ folder. Two transfer options: Either using SFTP: sftp platform@<unified_node_hostname> cd media put <XXX-Delta-Bundle.script> Or using SCP: scp <XXX-Delta-Bundle.script> platform@<unified_node_ip_address>:~/media Verify that the .script file copied: ls -l media/ Verify that the original .sha256 checksums on the SFTP server match. system checksum media/<XXX-Delta-Bundle.script> Checksum: <SHA256>

Done

Adaptations Check

Description and Steps	Notes and Status
Identify installed adaptations and determine any effect on the upgrade plan. If the release is accompanied by Upgrade Notes, refer to the details.	Done

Schedules, Transactions and Version Check

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: Log in on the GUI as a high level administrator above Provider level. Select the Scheduling menu to view scheduled jobs. Click each scheduled job. On the Base tab, uncheck the Activate check box. Mass modify: On the GUI, export scheduled syncs into a bulk load sheet. Modify the schedule settings to de-activate scheduled syncs. Import the sheet. Schedules enabled on the CLI: Run schedule list to check if any schedules exist and overlap with the maintenance window. For overlapping schedules, disable. Run schedule disable <job-name>.	Done
Check for running imports. Either wait for them to complete or cancel them: Log in on the GUI as a high level administrator above Provider level. Select the Transaction menu to view transactions. Filter the Action column: Choose Status as “Processing” and then choose each Action that starts with “Import”, for example, “Import Unity Connection”. Click Search and confirm there are no results. If there are transactions to cancel, select them and click Cancel.	Done
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: Post Template Upgrade Tasks single node cluster (Maintenance Window). Version Record the current version information. This is required for upgrade troubleshooting. Log in on the GUI and record the information contained in the About > Extended Version	Done

Pre-Upgrade, Security and Health Steps

Description and Steps	Notes and Status
Validate the system health. diag health If there is any sign of the paths below are over 80% full, a clean-up is needed 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) Verify there are no pending Security Updates: security check	Done
Create a restore point. 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. VOSS cannot guarantee that a restore point can be used to successfully restore VOSS Automate. If you cannot restore the application from a restore point, your only recourse is to reinstall the application. 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.	Done

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. app status Verify the node is not in the ‘recovering’ state (stateStr is not RECOVERING) database config	Done

Upgrade

Description and Steps

Notes and Status

It is recommended that the upgrade steps are run in a terminal opened with the screen command. screen Run (optionally with command parameters below): app install media/<script_file> From release 19.1.2 and later, the delete-on-success parameter and yes or no value have been added to remove or keep the the script file in the media/ directory after successful installation. Note that during the upgrade, phone registration data is cleared. A message will show in the log: Remove phone registration data. This is required so that old values are not displayed, since after the upgrade this information is no longer stored in the resource cache.

Done

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 in data/NetworkDeviceList

• data/CallManager instance exists, but data/NetworkDeviceList is empty

• Call Manager AXL Generic Driver and Call Manager Control Center Services match the data/CallManager IP

Post-Upgrade, Security and Health Steps

Description and Steps	Notes and Status
Verify the status: diag health	Done
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.	Done
Check for needed security updates. security check If one or more updates are required, complete all the security updates. security update Note: if the system reboots, do not carry out the next manual reboot step. Manual reboot only if needed: system reboot	Done

Post Template Upgrade Tasks

Description and Steps	Notes and Status
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. 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. Create a Model Type List which includes the device/cucm/GatewayType model. Add the Model Type List to all the required Unified CM Data Syncs. Execute the Data Sync for all the required Unified CMs. Verify the upgrade Log in on the GUI and check the information contained in the About > Version menu. Confirm that versions have upgraded. Release should show 21.3 Platform Version should show 21.3 If your web browser cannot open the user interface, clear your browser cache before trying to open the interface again.	Done
Check themes on all roles are set correctly	Done

Restore Adaptations

Description and Steps	Notes and Status
Restore and adaptations prior to upgrade. If the release is accompanied by Upgrade Notes, refer to the details on adaptation impact.	Done

Restore Schedules

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: Log in on the GUI as a high level administrator above Provider level. Select the Scheduling menu to view scheduled jobs. Click each scheduled job. On the Base tab, check the Activate check box. Mass modify: Modify the exported sheet of schedules to activate scheduled syncs. Import the bulk load sheet. 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: For disabled schedules that were overlapping the maintenance window, enable. Run schedule enable <job-name>.

Done

Release Specific Updates

Description and Steps	Notes and Status
When upgrading to release 21.3, users of Microsoft apps should after upgrade, select each Microsoft Tenant (relation/MicrosoftTenant) in the Admin GUI and click Save on it without making any changes. This step is required so that VOSS Automate can communicate with the Tenant post upgrade.	Done

Log Files and Error Checks

Description and Steps	Notes and Status
Inspect the output of the command line interface for upgrade errors. 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 install directory to an SFTP server: log send sftp://x.x.x.x install	Done
Log in on the GUI as system level administrator, go to Administration Tools > Transaction and inspect the transactions list for errors.	Done

previous

Modular Cluster Topology: Upgrade a Multinode Environment with the Delta Bundle

next

Multi-Cluster Deployments Technical Guide