Upgrade Procedures

In this section, you'll find the procedures you need to upgrade PubSub+ software event brokers to 10.8.1 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 .

The following upgrade paths are currently not supported due to database incompatibility:

  • From version 10.0.1 to broker versions 10.1.1, 10.2.1, 10.3.1, 10.5.1.

  • From version 10.4.1 to version 10.5.1.

Downgrading a software event broker is not supported.

Before You Begin

In versions of SolOS prior to 9.12, the storage-elements were typically externalized to separate storage volumes and mounted to the container using multiple mount points. In version 9.12 and later, the storage-group is now mapped to a single mount point. For details about how to convert from storage-elements to the single storage-group, refer to Converting from Multiple Mount Points to a Single Mount Point

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.

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 redundant (HA) systems to version 10.6.1 or later, ensure that you remove all Kafka bridging configuration from versions earlier than 10.6.1.

What's your image type?

There are different upgrade procedures depending on whether you are upgrading a Machine or Docker Image. To determine which type is running on your host, do the following:

  1. Login to the host.
  2. Enter the following command: cat /etc/solace-release.
  3. If the file exists, it's a Machine Image; otherwise it's a Docker Image.

Do 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%