Upgrading Event Broker Services in Customer-Controlled Containers

You can upgrade event broker services deployed to Customer-Controlled Containers using the Cloud Console. Unlike automated upgrades for event broker services deployed to Kubernetes clusters, you must download a regenerated event broker bundle and redeploy the Customer-Controlled Container hosting your event broker services yourself. Solace Cloud does not execute the upgrade for you. You report the success, failure, or if you choose to skip the upgrade to the Cloud Console.

For information about upgrading event broker services deployed to Kubernetes, see Upgrading Event Broker Services Using the Cloud Console.

Considerations for Upgrading Event Broker Services in Customer-Controlled Containers

Be aware of the following considerations when upgrading event broker services in Customer-Controlled Containers:

  • The same version-path rules apply as for Kubernetes-based event broker services. You can only upgrade to new event broker versions allowed by your current event broker version. For more information about upgrade paths, see Updating and Maintaining Your Event Broker Services.

  • You must perform the upgrade yourself by downloading the regenerated event broker bundle from the Cloud Console and redeploying the Customer-Controlled Containers hosting the event broker services.

  • Your existing secrets and certificate locations are preserved in the regenerated event broker bundle.

  • Certificate rotation is not part of the upgrade process. If you want to rotate the certificates for your event broker services, see Managing TLS Certificates for Event Broker Services in Customer-Controlled Containers.

  • Upgrading a standalone class event broker service requires a downtime of several minutes. Client applications experience an outage until the Customer-Controlled Container and its event broker service are in a running state. For more information, see What Is the Impact to My Event Broker Services When I Upgrade?

  • Performing self-serve event broker service upgrades requires the Administrator or Mission Control Manager role.

Performing an Upgrade for an Event Broker Service in a Customer-Controlled Container

To upgrade an event broker service in a Customer-Controlled Container, perform these steps:

  1. Log in to the Solace Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the Solace Cloud Console.

  2. On the navigation bar, select Cluster Manager .
  3. On the Services page, select the event broker service that is eligible for an upgrade. If the event broker service is not listed, make sure you have the right environment selected. For more information, see Selecting Environments.

  4. On the Status page, click Schedule Upgrade.

  5. In the Target Version field, select the event broker version to upgrade to. Release notes for the selected version appear below the Target Version field.

  6. (Optional) Select the Specify Version checkbox to select a specific build number and revision.

  7. Select Upgrade Now or Upgrade in a Maintenance Window, then click Schedule. For more information about maintenance windows, see Creating and Managing Maintenance Windows for Self-Serve Upgrades in the Cloud Console.

  8. Wait for the pre-maintenance checks to complete. If a check fails, resolve the issue and click Re-Run Pre-Maintenance Check. You cannot proceed until all checks pass. If you scheduled the upgrade in a maintenance window, the pre-maintenance checks don't run until the maintenance window occurs. For more information, see Event Broker Service Maintenance Validation Checks.

  9. After the pre-maintenance checks pass, click the Maintenance tab and then click Download Event Broker Bundle to download the regenerated bundle. If you scheduled the upgrade in a maintenance window, the regenerated maintenance bundle isn't available until the maintenance window occurs.

  10. On your container host, extract the bundle and navigate to the directory:

    tar -xf <serviceId>.tar && cd <serviceId>
  11. Pull the updated container images and redeploy:

    docker compose pull
    docker compose up -d
  12. Verify that the containers are running:

    docker compose ps

    You should see the event broker service and monitoring agent containers in a running state. Once the event broker service is running, Solace Cloud runs post-upgrade validation checks on the event broker service to ensure the upgrade was successful.

  13. Return to the Cloud Console and review the results of the validation checks. If the results aren't visible, the post-maintenance checks are still completing. Wait a few minutes and try again.

  14. After reviewing the results, set the upgrade status to one of the following:

    • Success: The upgrade finished successfully.

    • Failed: The upgrade encountered an error. Depending on the post-maintenance validation results, you may be able to fix the issue yourself and re-run the post-maintenance checks. You may have to contact Solace. For more information, see Post-Maintenance Validation Checks.

    • Skipped: You chose not to perform the upgrade.

The upgrade is recorded in the Cloud Console as a maintenance activity. For more information, see Viewing the Details of Completed Maintenance Activities.