Upgrade a Single Node Cluster Environment#
Read “Prepare for Upgrade” before proceeding.
Prior to Maintenance Window#
Download Files and Check#
Description and Steps |
Notes and Status |
|---|---|
VOSS files: https://voss.portalshape.com > Downloads > VOSS Automate > XXX > Upgrade Download 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
Verify that the original
|
Security and Health Steps Single Node Cluster#
Description and Steps |
Notes and Status |
|---|---|
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. 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 the following command (displayed for information only): if [ -d /opt/platform/apps/nginx/config/csr/ ] ;
then
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;
else:
echo "No further action required";
fi
If the
|
Validate System Health#
Important
Before starting the upgrade, ensure that the hardware version of each of your virtual machines (VMs) is at least version 11, compatible with ESXi 6.0 and up, and that your host CPU supports AVX (Advanced Vector Extensions).
A
check clustercommand in the Automate pre-upgrade steps checks for AVX support. To ensure that AVX support is added to the VMs, you’ll need to upgrade the compatibility of the VM in vCenter.Follow all of the steps in the table, in the order presented.
Description and Steps |
Notes and Status |
|---|---|
|
|
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)
Verify there are no pending Security Updates. Note If you run
|
Version Check#
Also verify VMWare, Cloud Deployments, and Application version compatibility as indicated in the Compatibility Matrix.
Description and Steps |
Notes and Status |
|---|---|
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. Version Record the current version information. This is required for upgrade troubleshooting.
|
Maintenance Window#
Pre-Upgrade Steps single node cluster#
Description and Steps |
Notes and Status |
|---|---|
Choose an option:
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 commands:
and
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 (
|
Upgrade single node cluster#
Note
By default, the cluster upgrade is carried out in parallel on all nodes and without any backup in order to provide a fast upgrade.
For systems upgrading to 24.2 from 21.4.0 - 21.4-PB5:
The VOSS platform maintenance mode will be started automatically when the
cluster upgradecommand is run. This prevents any new occurrences of scheduled transactions, including the 24.2 database syncs associated withinsights sync. For details oninsights sync, see the Insights Analytics topic in the Platform Guide.The
cluster maintenance-mode stopcommand must however be run manually after the maintenance window of the upgrade: End of the Maintenance Window and Restoring Schedules.
For details on the VOSS platform maintenance mode, see the Maintenance Mode topic in the Platform Guide.
Description and Steps |
Notes and Status |
|---|---|
It is recommended that the upgrade steps
are run in a terminal opened with the On the primary unified node:
All unused docker images except Note: If the system reboots, do not carry out the next manual reboot step. To remove a mount directory
Manual reboot only if needed:
If node messages: Since all services will be stopped, this takes some time. Close Log in on the primary database node and run:
If the report shows
|
Note
In order to carry out fewer upgrade steps, the updates of instances of some models are skipped in the cases where:
data/CallManagerinstance does not exist as instance indata/NetworkDeviceListdata/CallManagerinstance exists, butdata/NetworkDeviceListis emptyCall Manager AXL Generic Driver and Call Manager Control Center Services match the
data/CallManagerIP
Post-Upgrade, Security and Health Steps single node cluster#
Description and Steps |
Notes and Status |
|---|---|
Verify the status:
|
|
If upgrade is successful, the screen session can be closed by typing |
|
Complete all the security updates:
The docker images Note: If the system reboots, do not carry out the next manual reboot step . Manual reboot only if needed:
|
Database Schema Upgrade single node cluster#
Description and Steps |
Notes and Status |
|---|---|
It is recommended that the upgrade steps
are run in a terminal opened with the
|
Template Upgrade single node cluster#
Description and Steps |
Notes and Status |
|---|---|
It is recommended that the upgrade steps
are run in a terminal opened with the
|
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, either “Enterprise” or “Provider”. A message displays according to the selected deployment type. Check for one of the messages below:
Importing EnterpriseOverlay.json
Importing ProviderOverlay.json ...
The template install automatically restarts necessary applications.
Description and Steps |
Notes and Status |
|---|---|
Review the output from the 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#
Description and Steps |
Notes and Status |
|---|---|
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. |
|
|
Log Files and Error Checks single node cluster#
Description and Steps |
Notes and Status |
|---|---|
Inspect the output of the command line interface for upgrade errors,
for example Use the 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. |
Post Maintenance Window#
End of the Maintenance Window and Restoring Schedules#
Description and Steps |
Notes and Status |
|---|---|
On the CLI: Run the This will allow scheduled data sync transactions to resume, including For details on the VOSS platform maintenance mode, see the Maintenance Mode topic in the Platform Guide.
|
Licensing#
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
|
Mount the Insights disk#
Description and Steps |
Notes and Status |
|---|---|
On the primary unified node, assign the For example, if Unused disks:
sde
then run the command below on each unified node where the drive has been added:
The message below can be ignored on release 24.2:
Sample output: $ drives add sde insights-voss-sync:database
Configuration setting "devices/scan_lvs" unknown.
Configuration setting "devices/allow_mixed_block_sizes" unknown.
WARNING: Failed to connect to lvmetad. Falling back to device scanning.
71ad98e0-7622-49ad-9fg9-db04055e82bc
Application insights-voss-sync processes stopped.
Migrating data to new drive - this can take several minutes
Data migration complete - reassigning drive
Checking that /dev/sde1 is mounted
Checking that /dev/dm-0 is mounted
/opt/platform/apps/mongodb/dbroot
Checking that /dev/sdc1 is mounted
/backups
Application services:firewall processes stopped.
Reconfiguring applications...
Application insights-voss-sync processes started.
With release 24.2, the initial management of dashboards on the GUI and use of VOSS
Wingman is available after the first scheduled For details, see the Insights Analytics section of the Platform Guide. |