Upgrading Event Broker Services Using the Cloud Console

You can upgrade your event broker services whenever they are eligible for an upgrade. For more information, see Updating and Maintaining Your Event Broker Services. If your event broker service is eligible for an upgrade, you can perform a self-serve upgrade using the Cloud Console in two ways:

You use the Schedule Upgrade form in the Cloud Console to both perform immediate and scheduled upgrades. For more information, see Performing Self-Serve Upgrades for an Event Broker Service Using the Cloud Console.

If you want to schedule your upgrades, you must create maintenance windows. For more information, see Creating and Managing Maintenance Windows for Self-Serve Upgrades in the Cloud Console.

You can view information about your self-serve event broker service upgrades, including past upgrades, and scheduled upgrades, or the maintenance windows that you schedule upgrades to. For more information, see Viewing Maintenance Activity Details in the Cloud Console and Viewing the Details of Completed Maintenance Activities.

Before performing an event broker service upgrade using the Cloud Console, you should review the Considerations for Self-Serve Event Broker Service Upgrades in the Cloud Console.

You can also upgrade event broker services, create and manage maintenance windows, and view maintenance activity details using the REST API. For more information, see Upgrading Event Broker Services Using the REST API for Solace Cloud

Considerations for Self-Serve Event Broker Service Upgrades in the Cloud Console

Here are some considerations when performing both immediate, and scheduled self-serve event broker service upgrades with the Cloud Console:

  • You can only upgrade one event broker service at a time using an immediate upgrade if an upgrade slot is available. You can see availability using the Schedule Upgrade window in the Cloud Console. If there is no availability, you can try again at a later time. For more information, see Performing Self-Serve Upgrades for an Event Broker Service Using the Cloud Console

  • For event broker service upgrades scheduled in a maintenance window, you can schedule as many event broker services to the maintenance window as Solace Cloud allows. If you schedule more upgrades than the window can accommodate, Solace Cloud cancels upgrades that fall outside of the allotted time for the window.

  • Upgrading a high availability event broker service can create a short downtime of up to 1 minute during the high availability failover. For more information, see What Is the Impact to My Event Broker Services When I Upgrade?.

  • Upgrading Enterprise-100 Standalone and Standalone services requires a downtime of 3-5 minutes because there is only one software event broker. For more information, see What Is the Impact to My Event Broker Services When I Upgrade?.

  • You cannot delete a maintenance schedule that contains scheduled maintenance activities.

  • Performing self-serve event broker service upgrades requires the following permissions:

    • Performing immediate event broker service upgrades from the Cloud Console requires the Administrator or Mission Control Manager role.

    • Viewing maintenance windows and scheduling event broker service upgrades in a maintenance window requires the Administrator or Mission Control Manager role.

    • Creating and deleting maintenance schedules from the Cloud Console require the Administrator role.

Performing Self-Serve Upgrades for an Event Broker Service Using the Cloud Console

After determining whether your event broker service is illegible for an upgrade, you have two options when performing a self-serve upgrade:

  • An immediate upgrade, if space is available in the upgrade queue.

  • Schedule an upgrade using a maintenance window.

You perform either option using the Schedule Upgrade dialog, accessed from the Status page for an event broker service in Cluster Manager. To upgrade an event broker service using the Cloud Console, 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, click 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.

    Screenshot showing the elements described in the surrounding text.

  5. On the Schedule Upgrade dialog, in the Target Version field, select the event broker service version to upgrade to. Release notes for the selected version appear below the Target Version field.

  6. (Optional) Select the Specify Version checkbox to open the Specify Version menu. You can use the Specify Version menu to select specific versions (release type, build number, and revision) of the target version.

  7. Perform one of the following steps:

    • To perform an immediate upgrade if space is available, select Upgrade Now, and then click Schedule.
    • To schedule an upgrade if you have already created a maintenance window, select Upgrade in a Maintenance Window and use the field to select a maintenance window, then click Schedule.

  8. The status of the upgrade appears in the Upgrades section, including the estimated time remaining. You can view detailed information about the upgrade progress by clicking View Upgrade Logs. The owner of the event broker service also receives notifications by email of the upgrade progress.

Creating and Managing Maintenance Windows for Self-Serve Upgrades in the Cloud Console

You can create maintenance schedules and populate them with maintenance windows using the Cloud Console. After you have created maintenance windows, you can schedule your event broker service upgrades to the windows, at a time that meets your organization's requirements.

After you have created a maintenance window, you can:

Creating a Maintenance Window

To create a schedule and populate it with maintenance windows, do the following:

  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. Click User & Account and select Maintenance Activities to open the Maintenance Activities page.

  3. By default, the page shows maintenance for all environments. Click the Showing field and select a environment to view environment-specific maintenance activities. For more information about environments, see Creating and Managing Environments.

  4. Click Manage Windows.

  5. Click Create Window.

  6. In the Create Maintenance Window dialog, complete the fields as outlined in the following table:

    Field Description
    Environment Select the environment to you want to create the maintenance window for. For more information, see Creating and Managing Environments.
    Frequency

    Select the occurrence frequency of the maintenance window. You can select either Weekly or Monthly. The choice you make in this field effects the options you have in the Day field.

    • WEEKLY—The maintenance window repeats at a weekly frequency, as defined by the recurrenceDayWeekly variable, on the day defined by the recurrenceDayOfWeek variable.

    • MONTHLY—The maintenance window repeats once per month, on a specific day as defined by the recurrenceDayOfWeek variable, during a specific week of the month, as defined by the recurrenceDayOfWeekMonthly variable.
    Day

    Use the two Day fields to select the day you want the maintenance window to occur on. The choice you made in the Frequency field effects the options you have in the first of the two Day fields.

    • In the first Day field:

      • If you selected WEEKLY, choose how often the maintenance window repeats by selecting one of the following values:

        • EVERY—Every week on the selected day.

        • EVERY_OTHER—Every second week, on the selected day.

        • EVERY_THREE—Every third week on the selected day.

        • EVERY_FOUR—Every four weeks on the selected day.

      • If you selected MONTHLY, choose how often the maintenance window repeats by selecting one of the following values:

        • FIRST—First occurrence of the selected day within a month, for example, the first Monday of December, January, and so on.

        • SECOND—The second occurrence of a selected day within a month, for example, the second Tuesday of December, January, and so on.

        • THIRD—The third occurrence of a selected day within a month, for example, the third Wednesday of December, and January, and so on.

        • LAST—The last occurrence of a day within a month, for example, the last Thursday of December, and January, and so on.

    • Use the second Day field to select the day of the week the window occurs on.

    Start Time The time the maintenance window begins. The time is displayed in both your local and UTC time zones.
    Duration

    The duration of the maintenance window, in hours.

  7. Click Create.

    The maintenance window is added to the list of available maintenance windows under the day of the week selected in the second Day field. The details of the maintenance window appear in the panel on the right.

Scheduling Event Broker Service Upgrades in a Maintenance Window

After creating a maintenance window, you can schedule event broker service upgrades in the maintenance window. You can also schedule event broker service upgrades in existing maintenance windows.

For more information, see Performing Self-Serve Upgrades for an Event Broker Service Using the Cloud Console.

Canceling a Planned Upgrade

You may want to cancel an event broker service upgrade that is scheduled in a maintenance window, or you may want to move the scheduled upgrade to another time. In these situations, you can cancel a planned upgrade. You can cancel a planned event broker service upgrade at any time before the upgrade happens.

To cancel or remove a scheduled event broker service upgrade, do the following:

  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. Click User & Account and select Maintenance Activities to open the Maintenance: Activities page on the Planned Activities tab.

  3. For the planned event broker service upgrade you want to cancel, click Actions and select Cancel Activity. If the planned maintenance activity you want to cancel is not listed, make sure you have the right environment selected in the Showing field. For more information, see Selecting Environments.

    You can not cancel a planned activity for an event broker service while it is undergoing pre-maintenance checks. If canceling your planned activity fails, wait for the pre-maintenance check to complete and try again.

Deleting a Maintenance Window

You may want to delete a maintenance window entirely, for example, after you decide to move all event broker service upgrades from Fridays to Sundays. If you no longer need a maintenance window, you can delete it after removing all currently scheduled event broker service upgrades from the maintenance window.

You must cancel all planned event broker service upgrades in the maintenance window before you can delete the maintenance window.

To delete a maintenance window, 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. Click User & Account and select Maintenance Activities to open the Maintenance: Activities page.

  3. Click Manage Windows.

  4. On the maintenance window you want to delete, click Actions and select Delete. If the maintenance window you want to view is not listed, make sure you have the right environment selected in the Showing field. For more information, see Selecting Environments.

Viewing Maintenance Activity Details in the Cloud Console

You may want to view the details of your maintenance windows, including how frequently they occur, and when the next window is planned. For more information, see Viewing the Details of a Maintenance Window.

You may want to view the details of a planned or past event broker service upgrades to review upcoming upgrades, or the logs from completed upgrades. For more information, see:

Viewing the Details of a Maintenance Window

You can view the details of a maintenance window, including all event broker service upgrades currently scheduled in a maintenance window using the Cloud Console

To view the details of a maintenance window, including a list of upgrades scheduled in the maintenance window, 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. Click User & Account and select Maintenance Activities to open the Maintenance: Activities page on the Planned Activities tab.

  3. Click Manage Windows to open the Maintenance Windows page. If the Maintenance Window you want to view is not listed, make sure you have the right environment selected. For more information, see Selecting Environments.

  4. Select the maintenance window you want to view details for to open the Window Details panel.

    The Window Details panel shows the following information:

    Field Description
    Scope The environment the maintenance window is part of.
    Schedule The schedule for the maintenance window, including the day of the week the window occurs, and start and end times of the window in both local and UTC time zones.
    Upcoming Activities

    A list of event broker service upgrades scheduled for the maintenance window, including:

    • the times and dates of the scheduled event broker service upgrade

    • the identifier of the event broker service scheduled for upgrading

Viewing the Details of Planned Maintenance Activities

You can view the details of both planned and completed maintenance activities for your event broker services using the Cloud Console.

To view the details of planned and completed maintenance activities, 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. Click User & Account and select Maintenance Activities to open the Maintenance: Activities page on the Planned Activities tab. The Planned Activities tab shows a list of all planned event broker service upgrades. If the planned maintenance activity you want to view is not listed, make sure you have the right environment selected. For more information, see Selecting Environments.

  3. Select the maintenance window you want to view details for to open the Window Details panel.

    The Window Details panel shows the following information:

    Field Description
    Scope The environment the maintenance window is part of.
    Schedule The schedule for the planned upgrade, including the day of the week, and start and end duration for the planned upgrade both local and UTC hours.
    Status

    The status of the upgrade. The status can be:

    • Pre-Maintenance—Pre-maintenance checks are running, or have completed.

    • Maintenance—The event broker service is currently upgrading.

    • Post-Maintenance—Post-maintenance checks are running, or have been completed.
    Created

    The time the maintenance activity was created.
    Updated The time the maintenance activity was last updated.

  4. Click View Logs to view the logs for the upgrade in the Maintenance Status dialog. You can select the logs you want to view using the tabs on the dialog. The logs show a list of events and checks that occurred during the selected part of the upgrade.

    If a pre-maintenance check failed , click Re-Run Pre-Maintenance Check on the Pre-Maintenance tab to run the post-maintenance check again.

  5. Click Close to close the View Logs dialog.

Viewing the Details of Completed Maintenance Activities

You can view the details of completed maintenance activities for your event broker services using the Cloud Console.

To view the details of a planned and completed maintenance activities, 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. Click User & Account and select Maintenance Activities to open the Maintenance: Activities page on the Planned Activities tab.

  3. Select Completed Activities. The Completed Activities tab shows a list of all completed and failed event broker service upgrades. If the planned maintenance activity you want to view is not listed, make sure you have the right environment selected. For more information, see Selecting Environments. The table on the Completed Activities tab shows the following information:

    Field Description
    Activity Object The name of the event broker service that was upgraded.
    Environment The environment the upgraded event broker service is part of.
    Activity Type The type of upgrade that occurred.
    Status

    The status of the upgrade. The status can be:

    • Completed—The event broker service upgrade completed successfully.

    • Failed—The event broker service failed to upgrade.

    Activity Start Time

    The time the upgrade activity started.
    Updated The time the upgrade activity ended.

  4. On the completed or failed upgrade you want to view logs for, click Actions and select View Logs to open the Maintenance Status dialog. You can select the logs you want to view using the tabs on the dialog. The logs show a list of events and checks that occurred during the selected part of the upgrade.

    If a post-maintenance check failed, click Re-Run Post-Maintenance Check on the Post-Maintenance tab to run the post-maintenance check again.

  5. Click Close to close the Maintenance Status dialog.