Upgrade Procedures

In this section, you'll find the procedures you need to upgrade PubSub+ Software Event Brokers to 10.25 or earlier supported versions.

You may upgrade your event broker when all of these conditions are met:

  • The target version is numerically higher than your current version

  • The target version was released after your current version

  • The target version was released while your current version was still within its active support period

For example, upgrading from version 10.10.1.189 (June 2025) to 10.11.0.132 (January 2025) is not supported. Although the upgrade is to a higher numbered version, and was released while the source version was within its active support period, the target version was released before the source version.

To check the release date for specific versions, see the release notes for that version at products.solace.com.

To check the support period for specific versions, see Support Dates for Release Versions.

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:

  • In the following versions, basic and client certificate authentication for replication Config-Sync bridge connections has been deprecated and replaced with pre-shared key authentication. To allow an upgraded event broker with replication enabled to make insecure connections to an event broker using all the deprecated configuration from before the upgrade, the event broker enters insecure upgrade mode. After upgrading both replication sites, configure a pre-shared key and then disable insecure upgrade mode on each messaging node. For more information, see Configuring Insecure Upgrade Mode.

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

  • 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.25 or Earlier Supported Versions

Use this table to choose the procedure to follow for upgrading your PubSub+ Software Event Brokers to SolOS-TR version 10.25 or earlier supported versions. To view the support dates for specific versions, see Support Dates for Release Versions .

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 Configuration Procedure to follow
Docker Standalone

Upgrade a Standalone Docker Image

Docker Redundant

Upgrade a Redundant Docker Image Group

Upgrade a Redundant Docker Image Group Using an Orchestration Tool