Updates to the Broker application as well as Broker Plugins are delivered as release bundles via Buttonwood Updates Services. When an update bundle is applied, the packages are automatically downloaded and deployed, and update services will automatically restart Broker services.
This article describes the steps required to perform a Broker update, which include:
- Enabling Broker maintenance mode
- Performing the Broker update
- Exiting maintenance mode
Entering maintenance mode ensures that any running tasks are completed prior to Broker services being disrupted for updates. Any requests received while maintenance mode is active are queued until the maintenance mode is disabled.
Note: It is advised to perform a virtual machine/instance snapshot or backup after entering maintenance mode to ensure that a rollback can be performed if required. A configuration checkpoint can also be initiated to take a configuration snapshot at this time.
Prerequisites
- Administrative access to the Broker UI
Enter Maintenance Mode
- Log into the Broker UI as an administrative user
- Navigate to Admin > System
- Select the Configuration tab
- Expand the Advanced section
- Enable the option Enable Maintenance Mode for System Updates
Note: The option Exit maintenance mode on restart is enabled by default - Click Save
- The following alert is displayed on all Broker screens
Perform the Update
- Log into the Broker UI as an administrative user
- Navigate to Admin > System
- Ensure that Maintenance Mode has been enabled
- Ensure that there are no currently active requests
- It is advised to perform a virtual machine/instance snapshot and configuration checkpoint at this time
- Select the Status tab
- Click Check for Updates
- The latest release bundle with its components is listed
- Click Update
- The Broker begins its update process
- Once complete, click Go back to Broker
- The new build version is reflected in the Status tab
Exit Maintenance Mode
This step is not required if the option Exit maintenance mode on restart was checked during a Broker update.
- Log into the Broker UI as an administrative user
- Navigate to Admin > System
- Select the Configuration tab
- Expand the Advanced section
- Disable the option Enable Maintenance Mode for System Updates
- Click Save