Use these procedures to upgrade redundant appliances to SolOS-TR 10.10.0.
These upgrade procedures only apply to the latest version of the Solace PubSub+ appliance. Refer to the version-specific documentation to upgrade to versions before SolOS-TR 10.10.0.
With Guaranteed Messaging
To upgrade SolOS software to SolOS-TR 10.10.0 without a prolonged service outage on a redundant appliance pair that uses guaranteed messaging, follow the procedure in this section.
In the example solace-primary is the primary appliance, and solace-backup is the backup.
Before you begin
Perform the following steps to ensure the redundant pair is in the correct state before upgrading.
-
Review the appliance upgrade notices.
Appliance Upgrade Notices
Before upgrading to version 10.2.0 or later, ensure there are no queue, client-profile, or acl-profile objects configured whose name begins with #telemetry-. As a general rule, no objects should be configured that start with # since Solace uses such object names for internal use.
The following upgrade paths are not supported:
- Direct upgrades from SolOS 9.11.0 or earlier to SolOS 10.9.1 or later.
For unsupported upgrade paths, you must follow the upgrade procedure to the last SolOS-TR version that is part of a supported upgrade path from the source version, before following the upgrade procedure to the destination version.
Upgrades to or from SolOS Early Availability (EA) loads are not supported. All configuration and spooled messages may be lost during the upgrade.
Faulty or noisy serial connections can result in the appliance not booting correctly following an upgrade or restart. Ensure either serial connections are fully functional, or disconnect all serial cables from the Solace appliance prior to upgrading.
Solace recommends upgrading SolAdmin and SolGeneos to the most recent versions before upgrading the appliance to a new major or minor version.
On upgrade, some appliances that have ADB version ADB-04210M-01 will require additional message-spool disk space to support the higher scaling capabilities of this software release. This additional disk space persists and will reduce the amount of disk space available for spooling messages.
3560 appliances with ADB version ADB-04210M-01 will have 10 GB of additional space consumed on each disk partition (primary and backup).
In mixed release replication configurations between this SolOS version and older SolOS versions, config-sync may not work correctly. Running mixed release replication configurations with older SolOS versions is not recommended for extended periods of time. Once the releases are the same, the config-sync issues will clear, so upgrading both replications to the same version should be done as soon as possible. For additional information, contact Solace.
Upgrades that require changing the underlying version of SolBase will not preserve files in the root partition of the appliance’s internal file system.
Configuration changes should not be made while performing any in-service upgrade. This includes avoiding the use of administrative config-sync commands.
Before upgrading standalone appliances that use the Replication feature, follow the Performing a Controlled Failover procedure to fail over to Message VPNs at the alternate replication site.
If the message-spool is enabled as backup but no mate-router-name is configured, the event broker will fail to boot following the upgrade. Prior to upgrading, ensure that either a mate-router-name is configured or the message-spool is not enabled as backup.
The screen output examples shown in this section reflect the software release to which you are upgrading. In the steps that occur before the upgrade, the screen outputs may be formatted differently, or contain slightly different information, depending on the software release from which you are upgrading.
Before upgrading to version 10.9.1 or later, remove any LAG interface that was erroneously configured without a mode of
lacporactive-backup. Such interfaces were always non-functional, however, if they are not removed the event broker will fail to boot following the upgrade.For appliances in Active/Standby redundancy mode, prior to upgrading to version 10.0.1 or later, ensure that the
active-standby-roleis set to eitherprimaryorbackup. If the redundancy role isnoneon either appliance, the upgrade will fail. For appliances in Active/Active redundancy mode, this setting is expected to be set tonone. See Configuring Redundancy Parameters for instructions. -
Ensure that the internal disks are in a redundant state on both the primary and backup appliances.
solace-primary> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State up up RAID in fully redundant state: Yes solace-backup> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State up up RAID in fully redundant state: Yes
If the displayed output shows the RAID disk 1 and disk 2 drives to be in a non-redundant state (see example below), contact Solace and stop this software upgrade procedure immediately to prevent software corruption on the appliance.
Some appliances contain slots for disk 3 and disk 4, however, these slots are not presently used, and the redundancy state for disk 3 and disk 4 should be ignored.
Example
solace-primary> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State failed up RAID in fully redundant state: No -or- solace-backup> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State failed up RAID in fully redundant state: No
-
Copy the latest SolOS software from an external file server (using either SFTP or SCP) to the
/loadssubdirectory on both appliances.solace-primary# copy sftp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-primary# copy scp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-backup# copy sftp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-backup# copy scp://[<username>@]<ip-addr>/<remote-pathname> /loads
Where:
<username>,<ip-addr>, and<remote-pathname>correspond to the access information of where the new SolOS software is located. -
Copy the correct SolBase software for the latest SolOS version software (the correct SolBase software is packaged with each SolOS version) from an external file server (using either SFTP or SCP) to the
/loadssubdirectory on both appliances. -
Ensure that the primary appliance is in the correct redundancy state.
If using Active/Active redundancy mode, the output from
show redundancyon the primary appliance should look like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Active AD-Disabled Priority Reported By Mate Standby ActiveIf using Active/Standby redundancy mode, the output from
show redundancyon the primary appliance should look like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Shutdown Routing Interface 1/6/lag1:1 VRRP VRID 50 Routing Interface Status Up VRRP Status Master VRRP Priority 250 Message Spool Status AD-Active Priority Reported By Mate Standby- If the Message Spool Status of the Primary Virtual Router is not AD-Active, loss of spooled messages may occur during the upgrade.
- The Auto Revert value is a configurable option and may be set to
Yes, depending on the redundant system configuration. Solace recommends a setting ofNofor this option, but either is valid.
-
Ensure that the backup appliance is in the correct redundancy state.
If using Active/Active redundancy mode, the output from
show redundancyon the backup appliance should look like this:Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 197 50 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Disabled AD-Standby Priority Reported By Mate Standby ActiveIf using Active/Standby redundancy mode, the output from
show redundancyon the backup appliance should look like this:Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Shutdown Mate Active Routing Interface 1/6/lag1:2 VRRP VRID 50 Routing Interface Status Up VRRP Status Backup VRRP Priority 100 Message Spool Status AD-Standby Priority Reported By Mate ActiveThe
Auto Revertvalue is a configurable option and may be set toYes, depending on the redundant system configuration. Solace recommends a setting ofNofor this option, but either is valid. -
With the exception of the
Auto Revertvalue, if the redundancy state of either the primary or backup appliance does not correspond to the examples above, do NOT upgrade the appliances. Instead, contact Solace for further instructions. -
If using Config-Sync, confirm that it is operationally
Upon both primary and backup appliances, which means all configuration is synchronized.solace-primary> show config-sync Admin Status : Enabled Oper Status : Up solace-backup> show config-sync Admin Status : Enabled Oper Status : Up
If the operational status of Config-Sync is not
Up, you should resolve this before proceeding. Otherwise you may lose configuration during the upgrade.
Before upgrading the appliance, SolAdmin may also need to be upgraded. In addition, after the upgrade, SolGeneos Agent may also need to be upgraded. See Appliance Upgrade Notices for more information.
Procedure
-
Follow all steps in Before you begin. Do not proceed if you cannot confirm that the system is in the correct state.
-
Make a copy of the current SolOS configuration in the
/configssubdirectory on both appliances:solace-primary> enable solace-primary# copy current-config /configs/<old_version>_preUpgradeCfg solace-backup> enable solace-backup# copy current-config /configs/<old_version>_preUpgradeCfg
Where:
<old_version>is the version number of current SolOS software as seen in the output of the show version command. -
On the backup appliance, release activity to the primary appliance:
solace-backup# configure solace-backup(configure)# redundancy solace-backup(configure/redundancy)# release-activity solace-backup(configure/redundancy)# end
-
On the primary appliance, confirm the redundancy status.
If using Active/Active redundancy mode, the Activity Status for both virtual routers should be
Local Active:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Down Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Local Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Master Master VRRP Priority 250 250 Message Spool Status AD-Active AD-Disabled Priority Reported By Mate Release ReleaseIf using the Active/Standby redundancy mode, the Activity Status for the primary virtual router should be
Local Active:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Down Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Routing Interface 1/6/lag1:1 VRRP VRID 50 Routing Interface Status Up VRRP Status Master VRRP Priority 250 Message Spool Status AD-Active Priority Reported By Mate ReleaseIf the redundancy status on the primary appliance is not correct, do NOT proceed with the upgrade. Instead, contact Solace Technical Support for further instructions.
-
If you are using Config-Sync, confirm that it is operationally
Upon the primary appliance.solace-primary> show config-sync Admin Status : Enabled Oper Status : Up
If the operational status of Config-Sync is not
Up, you should resolve this before proceeding. -
If you are using MQTT retained messages in your deployment, verify that your retain cache instances are synchronized. For more information, refer to Verifying Retain Cache Redundancy.
-
Upgrade the backup appliance:
solace-backup# boot <new_version>
Where:
<new_version>is the version number of new SolOS software that was previously copied to the appliance. -
Respond to prompts and then wait for the backup appliance to restart using the new SolOS software. This may take several minutes. You will be disconnected from the CLI and have to reconnect to the appliance.
-
Once reconnected to the backup appliance, confirm that the appliance has started using the new software version:
solace-backup> enable solace-backup# show version
-
Allow activity back to the backup appliance:
solace-backup# configure solace-backup(configure)# redundancy solace-backup(configure/redundancy)# no release-activity solace-backup(configure/redundancy)# end
-
On the backup appliance, confirm the redundancy status.
If using Active/Active redundancy mode, the output from show redundancy on the backup appliance looks like this:
Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Mate Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 197 50 Routing Interface Status Up Up VRRP Status Backup Backup VRRP Priority 100 100 Message Spool Status AD-Disabled AD-Standby Priority Reported By Mate Active ActiveIf using Active/Standby redundancy mode, the output from show redundancy on the backup appliance looks like this:
Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Shutdown Mate Active Routing Interface 1/6/lag1:2 VRRP VRID 50 Routing Interface Status Up VRRP Status Backup VRRP Priority 100 Message Spool Status AD-Standby Priority Reported By Mate ActiveIt may take several minutes for the backup redundancy status to transition to
Upstate as the backup router synchronises its states from the primary appliance.If the redundancy status on the backup appliance is not correct, do NOT proceed with the upgrade. Instead, contact Solace Technical Support for further instructions.
-
If you are using Config-Sync, confirm that it is operationally
Upon the backup appliance.solace-backup> show config-sync Admin Status : Enabled Oper Status : Up
If the operational status of Config-Sync is not
Up, you should resolve this before proceeding. -
Release activity on the primary appliance to the backup appliance:
solace-primary# configure solace-primary(configure)# redundancy solace-primary(configure/redundancy)# release-activity solace-primary(configure/redundancy)# end
-
On the backup appliance, confirm the redundancy status.
If using Active/Active redundancy mode, the output from
show redundancyon the backup appliance looks like this:Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Down Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Local Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 197 50 Routing Interface Status Up Up VRRP Status Master Master VRRP Priority 250 240 Message Spool Status AD-Disabled AD-Active Priority Reported By Mate Release ReleaseIf using Active/Standby redundancy mode, the output from
show redundancyon the backup appliance looks like this:Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Down Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Shutdown Local Active Routing Interface 1/6/lag1:2 VRRP VRID 50 Routing Interface Status Up VRRP Status Master VRRP Priority 240 Message Spool Status AD-Active Priority Reported By Mate ReleaseIf the redundancy status on the backup appliance is not correct, do NOT proceed with the upgrade. Instead, contact Solace Technical Support for further instructions.
-
If you are using MQTT retained messages in your deployment, verify that your retain cache instances are synchronized. For more information, refer to Verifying Retain Cache Redundancy.
-
Upgrade the primary appliance:
solace-primary# boot <new version>
Where:
<new_version>is the version number of the new SolOS software that was previously copied to the appliance. -
Respond to prompts and then wait for the primary appliance to restart using the new SolOS software. This may take several minutes. You will be disconnected from the CLI and have to reconnect to the appliance.
-
Once reconnected to the primary appliance, confirm that the appliance has started using the new software version:
solace-primary> enable solace-primary# show version
-
Allow activity on the primary:
solace-primary# configure solace-primary(configure)# redundancy solace-primary(configure/redundancy)# no release-activity solace-primary(configure/redundancy)# end
-
On the primary appliance, confirm the redundancy status.
If using Active/Active redundancy mode, the output from
show redundancyon the primary appliance looks like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Mate Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Backup Backup VRRP Priority 150 100 Message Spool Status AD-Standby AD-Disabled Priority Reported By Mate Active ActiveIf using Active/Standby redundancy mode, the output from
show redundancyon the primary appliance looks like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Mate Active Shutdown Routing Interface 1/6/lag1:2 VRRP VRID 50 Routing Interface Status Up VRRP Status Backup VRRP Priority 150 Message Spool Status AD-Standby Priority Reported By Mate ActiveIt may take several minutes for the primary redundancy status to transition to
Upstate as the backup router synchronises its states from the primary appliance. -
If you are using Config-Sync, confirm that it is operationally
Upon the primary appliance.solace-primary> show config-sync Admin Status : Enabled Oper Status : Up
If the operational status of Config-Sync is not
Up, you should resolve this before proceeding. -
If auto-revert is not configured, revert activity to the primary appliance from the backup appliance:
solace-backup# admin solace-backup(admin)# redundancy revert-activity solace-backup(admin)# end
-
Ensure that the primary appliance is in the correct redundancy state.
If using Active/Active redundancy mode, the output from
show redundancyon the primary appliance looks like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Active AD-Disabled Priority Reported By Mate Standby ActiveIf using Active/Standby redundancy mode, the output from
show redundancyon the primary appliance looks like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-backup ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Shutdown Routing Interface 1/6/lag1:1 VRRP VRID 50 Routing Interface Status Up VRRP Status Master VRRP Priority 250 Message Spool Status AD-Active Priority Reported By Mate StandbyThe Auto Revert value is a configurable option and may be set to
Yes, depending on the redundant system configuration. -
Ensure that the backup appliance is in the correct redundancy state.
If using Active/Active redundancy mode, the output from show redundancy on the backup appliance looks like this:
Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 197 50 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Disabled AD-Standby Priority Reported By Mate Standby ActiveIf using Active/Standby redundancy mode, the output from show redundancy on the backup appliance looks like this:
Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Standby Mate Router Name : solace-primary ADB Link To Mate : Up ADB Hello To Mate : Up Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Shutdown Mate Active Routing Interface 1/6/lag1:2 VRRP VRID 50 Routing Interface Status Up VRRP Status Backup VRRP Priority 100 Message Spool Status AD-Standby Priority Reported By Mate ActiveThe Auto Revert value is a configurable option and may be set to
Yes, depending on the redundant system configuration. -
If you are using Config-Sync, confirm that it is operationally
Upon both the primary and backup appliances.solace-primary> show config-sync Admin Status : Enabled Oper Status : Up solace-backup> show config-sync Admin Status : Enabled Oper Status : Up
You have completed this procedure.
Without Guaranteed Messaging
To upgrade the SolOS software to SolOS-TR 10.10.0 without a prolonged service outage on a redundant appliance pair that doesn't use guaranteed messaging , follow this procedure.
In the example solace-primary is the primary appliance, and solace-backup is the backup.
Before you begin
Perform the following steps to ensure the redundant pair is in the correct state before upgrading.
-
Review the appliance upgrade notices.
Appliance Upgrade Notices
Before upgrading to version 10.2.0 or later, ensure there are no queue, client-profile, or acl-profile objects configured whose name begins with #telemetry-. As a general rule, no objects should be configured that start with # since Solace uses such object names for internal use.
The following upgrade paths are not supported:
- Direct upgrades from SolOS 9.11.0 or earlier to SolOS 10.9.1 or later.
For unsupported upgrade paths, you must follow the upgrade procedure to the last SolOS-TR version that is part of a supported upgrade path from the source version, before following the upgrade procedure to the destination version.
Upgrades to or from SolOS Early Availability (EA) loads are not supported. All configuration and spooled messages may be lost during the upgrade.
Faulty or noisy serial connections can result in the appliance not booting correctly following an upgrade or restart. Ensure either serial connections are fully functional, or disconnect all serial cables from the Solace appliance prior to upgrading.
Solace recommends upgrading SolAdmin and SolGeneos to the most recent versions before upgrading the appliance to a new major or minor version.
On upgrade, some appliances that have ADB version ADB-04210M-01 will require additional message-spool disk space to support the higher scaling capabilities of this software release. This additional disk space persists and will reduce the amount of disk space available for spooling messages.
3560 appliances with ADB version ADB-04210M-01 will have 10 GB of additional space consumed on each disk partition (primary and backup).
In mixed release replication configurations between this SolOS version and older SolOS versions, config-sync may not work correctly. Running mixed release replication configurations with older SolOS versions is not recommended for extended periods of time. Once the releases are the same, the config-sync issues will clear, so upgrading both replications to the same version should be done as soon as possible. For additional information, contact Solace.
Upgrades that require changing the underlying version of SolBase will not preserve files in the root partition of the appliance’s internal file system.
Configuration changes should not be made while performing any in-service upgrade. This includes avoiding the use of administrative config-sync commands.
Before upgrading standalone appliances that use the Replication feature, follow the Performing a Controlled Failover procedure to fail over to Message VPNs at the alternate replication site.
If the message-spool is enabled as backup but no mate-router-name is configured, the event broker will fail to boot following the upgrade. Prior to upgrading, ensure that either a mate-router-name is configured or the message-spool is not enabled as backup.
The screen output examples shown in this section reflect the software release to which you are upgrading. In the steps that occur before the upgrade, the screen outputs may be formatted differently, or contain slightly different information, depending on the software release from which you are upgrading.
Before upgrading to version 10.9.1 or later, remove any LAG interface that was erroneously configured without a mode of
lacporactive-backup. Such interfaces were always non-functional, however, if they are not removed the event broker will fail to boot following the upgrade. -
Ensure that the internal disks are in a redundant state on both the primary and backup appliances.
solace-primary> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State up up RAID in fully redundant state: Yes solace-backup> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State up up RAID in fully redundant state: Yes
If the displayed output shows the RAID disk 1 and disk 2 drives to be in a non-redundant state (see example below), contact Solace Technical Support and stop this software upgrade procedure immediately to prevent software corruption on the appliance.
Some appliances contain slots for disk 3 and disk 4, however, these slots are not presently used, and the redundancy state for disk 3 and disk 4 should be ignored.
solace-primary> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State failed up RAID in fully redundant state: No OR solace-backup> show disk Reload required: No Attribute Disk 1 Disk 2 ------------------ ----------------------------- ----------------------------- Device Model ST3250820NS ST3250820NS Capacity (MB) 238475 238475 Admin State enabled enabled Operational State failed up RAID in fully redundant state: No
-
Copy the latest SolOS software from an external file server (using either SFTP or SCP) to the
/loadssubdirectory on both appliances.solace-primary# copy sftp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-primary# copy scp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-backup# copy sftp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-backup# copy scp://[<username>@]<ip-addr>/<remote-pathname> /loads
Where:
<username>,<ip-addr>, and<remote-pathname>correspond to the access information of where the new SolOS software is located. -
Copy the correct SolBase software for the latest SolOS version (the correct SolBase software is packaged with each SolOS version) from an external file server (using either SFTP or SCP) to the
/loadssubdirectory on both appliances.solace-primary# copy sftp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-primary# copy scp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-backup# copy sftp://[<username>@]<ip-addr>/<remote-pathname> /loads solace-backup# copy scp://[<username>@]<ip-addr>/<remote-pathname> /loads
Where:
<username>,<ip-addr>, and<remote-pathname>correspond to the access information of where the new SolBase software is located. -
Ensure that the primary appliance is in the correct redundancy state. The output from
show redundancyon the primary appliance looks like this:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Down ADB Hello To Mate : Down Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Disabled AD-Disabled Priority Reported By Mate None Active
The Auto Revert value is a configurable option and may be set to
Yes, depending on the redundant system configuration. Solace recommends a setting ofNofor this option, but either is valid.Ensure that the backup appliance is in the correct redundancy state. The output from
show redundancyon the backup appliance looks like this:Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-primary ADB Link To Mate : Down ADB Hello To Mate : Down Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 197 50 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Disabled AD-Disabled Priority Reported By Mate None Active
The
Auto Revertvalue is a configurable option and may be set toYes, depending on the redundant system configuration. Solace recommends a setting ofNofor this option, but either is valid. -
With the exception of the
Auto Revertvalue, if the redundancy state of either the primary or backup appliance does not correspond to the examples above, do NOT upgrade the appliances. Instead, contact Solace Technical Support for further instructions.
Before upgrading the appliance, SolAdmin and SolGeneos Agent may also need to be upgraded. See Appliance Upgrade Notices for more information.
Procedure
- Follow all steps in Before you begin. Do not proceed if you cannot confirm that the system is in the correct state.
-
Make a copy of the current SolOS configuration in the
/configssubdirectory on both appliances:solace-primary> enable solace-primary# copy current-config /configs/<old_version>_preUpgradeCfg solace-backup> enable solace-backup# copy current-config /configs/<old_version>_preUpgradeCfg
Where:
<old_version>is the version number of current SolOS software as seen in the output of the show version command. -
Ensure both appliances have auto-revert set to not enabled:
solace-primary# configure solace-primary(configure)# redundancy solace-primary(configure/redundancy)# no auto-revert solace-primary(configure/redundancy)# end solace-backup# configure solace-backup(configure)# redundancy solace-backup(configure/redundancy)# no auto-revert solace-backup(configure/redundancy)# end
-
On the primary appliance, release activity to the backup appliance:
solace-primary# configure solace-primary(configure)# redundancy solace-primary(configure/redundancy)# release-activity solace-primary(configure/redundancy)# end
-
On the primary appliance, confirm that the backup appliance has taken activity. The Activity Status for both virtual routers should be
Mate Active:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled-Released Redundancy Status : Down Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Down ADB Hello To Mate : Down Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Mate Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Backup Backup VRRP Priority 0 0 Message Spool Status AD-Disabled AD-Disabled Priority Reported By Mate Active Active
If the backup appliance has not taken activity, do NOT proceed with the upgrade. Instead, contact Solace Technical Support for further instructions.
-
If you are using MQTT retained messages in your deployment, verify that your retain cache instances are synchronized. For more information, refer to Verifying Retain Cache Redundancy.
-
Shut down the Msg-Backbone service on the primary appliance:
solace-primary# configure solace-primary(configure)# service msg-backbone solace-primary(configure/service/msg-backbone)# shutdown All SMF, WEB, and REST clients will be disconnected. Do you want to continue (y/n)? y solace-primary(configure/service/msg-backbone)# end
-
Upgrade the primary appliance:
solace-primary# boot <new_version>
Where:
<new_version>is the version number of the new SolOS software that was previously copied to the appliance. -
Respond to prompts and then wait for the primary appliance to restart using the new SolOS software. This may take several minutes. You will be disconnected from the CLI and have to reconnect to the appliance.
-
Once reconnected, confirm that the appliance has started using the new software version:
solace-primary> enable solace-primary# show version
-
Start the Msg-Backbone service that was shut down on the primary appliance:
solace-primary#configure
solace-primary(configure)# service msg-backbone
solace-primary(configure/service/msg-backbone)# no shutdown
solace-primary(configure/service/msg-backbone)# end -
Revert activity back to the primary appliance from the backup appliance.
Enter the no release-activity command on the primary appliance to allow activity to return back to it:
solace-primary# configure solace-primary(configure)# redundancy solace-primary(configure/redundancy)# no release-activity solace-primary(configure/redundancy)# end
Enter the redundancy revert-activity Admin command on the backup appliance to administratively force it to give up service:
solace-backup# admin solace-backup(admin)# redundancy revert-activity solace-backup(admin)# end
-
On the backup appliance, release activity to the primary appliance:
solace-backup# configure solace-backup(configure)# redundancy solace-backup(configure/redundancy)# release-activity solace-backup(configure/redundancy)# end
-
Confirm on the primary appliance that it has taken activity for both virtual routers. The Activity Status for both virtual routers should be
Local Active:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Down Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Down ADB Hello To Mate : Down Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Local Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Master Master VRRP Priority 250 250 Message Spool Status AD-Disabled AD-Disabled Priority Reported By Mate None None
If the primary appliance is not active for both virtual routers, do NOT proceed with the upgrade. Instead, contact Systems technical support for further instructions.
-
If you are using MQTT retained messages in your deployment, verify that your retain cache instances are synchronized. For more information, refer to Verifying Retain Cache Redundancy.
-
Shut down the Msg-Backbone service on the backup appliance:
solace-backup# configure solace-backup(configure)# service msg-backbone solace-backup(configure/service/msg-backbone)# shutdown All SMF, WEB, and REST clients will be disconnected. Do you want to continue (y/n)? y solace-backup(configure/service/msg-backbone)# end
-
Upgrade the backup appliance:
solace-backup# boot <new version>
Where:
<new_version>is the version number of new SolOS software that was previously copied to the appliance. -
Respond to prompts and then wait for the backup appliance to restart using the new SolOS software. This may take several minutes. You will be disconnected from the CLI and have to reconnect to the appliance.
-
Once reconnected to the backup appliance, confirm that the appliance has started using the new software version:
solace-backup> enable solace-backup# show version
-
Start the Msg-Backbone service that was shut down on the backup appliance:
solace-backup# configure solace-backup(configure)# service msg-backbone solace-backup(configure/service/msg-backbone)# no shutdown solace-backup(configure/service/msg-backbone)# end
-
Enter the no release-activity command on the backup appliance to allow activity to return back to it:
solace-backup# configure solace-backup(configure)# redundancy solace-backup(configure/redundancy)# no release-activity solace-backup(configure/redundancy)# end
-
Enter the redundancy revert-activity Admin command on the primary appliance to administratively force it to give up service:
solace-primary# admin solace-primary(admin)# redundancy revert-activity solace-primary(admin)# end
-
On the primary appliance, confirm that the primary appliance is active for the primary virtual router and the backup appliance is active for the backup virtual router. The Activity Status line should read
Local Activefor the primary virtual router andMate Activefor the backup virtual router:Example (Output may vary by appliance version):
solace-primary# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-backup ADB Link To Mate : Down ADB Hello To Mate : Down Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 50 197 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Disabled AD-Disabled Priority Reported By Mate None Active
If the activity status is not correct, do NOT proceed with the upgrade. Instead, contact Solace for further instructions.
-
If the redundancy auto-revert setting was set to not enabled in step 3, enable it on both appliances:
Solace recommends running redundancy with auto-revert not enabled.
solace-primary# configure solace-primary(configure)# redundancy solace-primary(configure/redundancy)# auto-revert solace-primary(configure/redundancy)# end solace-backup# configure solace-backup(configure)# redundancy solace-backup(configure/redundancy)# auto-revert solace-backup(configure/redundancy)# end
-
Ensure that the backup appliance is in the correct redundancy state.
The output from show redundancy on the backup appliance looks like this:
Example (Output may vary by appliance version):
solace-backup# show redundancy Configuration Status : Enabled Redundancy Status : Up Auto Revert : No Redundancy Mode : Active/Active Mate Router Name : solace-primary ADB Link To Mate : Down ADB Hello To Mate : Down Primary Virtual Router Backup Virtual Router ---------------------- ---------------------- Activity Status Local Active Mate Active Routing Interface 1/6/lag1:1 1/6/lag1:2 VRRP VRID 197 50 Routing Interface Status Up Up VRRP Status Master Backup VRRP Priority 250 100 Message Spool Status AD-Disabled AD-Disabled Priority Reported By Mate None Active
The
Auto Revertvalue is a configurable option and may be set toYes, depending on the redundant system configuration.
You have completed this procedure.