Upgrade Procedures

In this section, you'll find the procedures you need to upgrade PubSub+ software event brokers to 10.12.0 or earlier supported versions.

You may upgrade any release that is in full support or technical support to any newer release that is in full support. You may upgrade to a Preview Release until such Preview Release is replaced by its Production Release. For more information, see solace.com/support .

Downgrading a software event broker is not supported.

Before You Begin

Perform the following before upgrading.

Review the Upgrade Notices

Review the following upgrade notices before upgrading your software event broker:

  • If the message-spool is enabled as backup but a mate-router-name cannot be determined from the configured HA redundancy group nodes, the event broker will fail to boot following the upgrade. Prior to upgrading, ensure that either the HA redundancy group nodes are correctly configured, or the message-spool is not enabled as backup.

  • Before upgrading to version 10.9.1 or later, remove any LAG interface that was erroneously configured without a mode of lacp or active-backup. Such interfaces were always non-functional, however, if they are not removed the event broker will fail to boot following the upgrade.

  • If you are using DMR in your deployment, do not upgrade directly from version 9.13.1 or earlier to version 10.11.0. First upgrade to an intermediary version, for example 10.8.1, before upgrading to version 10.11.0. Failure to do so will prevent the DMR clusters on your event brokers from synchronizing subscriptions, which will prevent the clusters from becoming operational.

  • In mixed release configurations between this version and earlier versions, config-sync may not work correctly. Running mixed release configurations with earlier versions is not recommended for extended periods of time. Once the versions are the same, the config-sync issues will clear, so upgrading both configurations to the same version should be done as soon as possible. For additional information, contact Solace.

Verify That You Have Enough Free Space

You need to verify there's enough free space on all event brokers that you're going to upgrade.

Carefully review the System Resource Requirements and ensure adequate resources are available before beginning the upgrade procedure.

During a Docker image upgrade, installing the new PubSub+ software event broker will not succeed if sufficient thin pool minimum free space is not available. Executing the docker info command in the Docker host will show both Space Available and Thin Pool Minimum Free Space. Refer to the Docker documentation for more information on managing available space in Docker.

To free up disk space, consider the following options:

  • Unspool some spooled messages
  • Delete some spooled messages (messages cannot be recovered once deleted)
  • Migrate to a larger message-spool

To check the amount of free space available, do the following:

  1. Run the show storage-element * CLI command.

  2. Verify that the spool storage-element reports at least 2.2 Mi in the available column.

    solace> show storage-element *

Last Refreshed           : Feb 22 2024 18:41:07

Storage Element      Device             1K-blocks    Used         Available    Use%
-------------------- ------------------ ------------ ------------ ------------ -----
root                 /dev/dm-6            6.0 Mi       1.2 Mi       4.8 Mi     20%
spool-cache          /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%
spool-cache-backup   /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%
config               /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%
diagnostics          /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%
jail                 /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%
spool                /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%
var                  /dev/dm-0            9.8 Mi       1.1 Mi       8.7 Mi     11%

Upgrade to Version 10.1.1 or Later

Use this table to choose the procedure to follow for upgrading your Solace PubSub+ software event brokers to SolOS-TR version 10.1.1 or later (the current version is 10.12.0).

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.

Image Version Configuration Procedure to follow
Docker 10.0.1+ Standalone Upgrade a Standalone Docker Image from Version 10.0.1+
Docker 10.0.1+ Redundant

Upgrade a Redundant Docker Image Group from Version 10.0.1+

Upgrade a Redundant Docker Image Group from Version 10.0.1+ Using an Orchestration Tool

AWS Cloud All Standalone Upgrade a Standalone AWS Cloud Image
AWS Cloud All Redundant Upgrade a Redundant AWS Cloud Image Group