ApsaraMQ for RocketMQ provides a fully managed version management service. When a broker is updated, the system automatically completes the upgrade in the background without affecting message sending and receiving or impacting your services. You can change the execution time and maintenance window for these upgrades based on your peak and off-peak hours.
Limitations
Version management is only available for Enterprise Platinum Edition instances.
Impact of upgrades
An upgrade typically completes within 30 minutes. If an upgrade takes longer, you can submit a ticket. For Enterprise Platinum Edition instances, you can also seek immediate support through the dedicated DingTalk group. During an upgrade, brokers are restarted in batches, which may cause transient client connection interruptions but does not affect message sending or receiving.
Messages may be redelivered during an upgrade. Therefore, your applications must be designed to handle message idempotence.
During a version upgrade, you cannot unsubscribe from an instance, release an instance, perform instance scaling, or other upgrade operations. However, you can still renew an instance. If you need to perform management operations in the console, such as creating or deleting topics, schedule these activities outside the upgrade period.
You cannot roll an instance back to a previous version after an upgrade.
Scope of version upgrades
An instance's full version number uses the x.y-rmq-yyyymmdd format. The components are defined as follows:
x.y: Corresponds to the open source Apache RocketMQ version x.y.z, where z represents the latest patch release. For example, 5.1 corresponds to the latest 5.1.z version of Apache RocketMQ.
yyyymmdd: Corresponds to the ApsaraMQ for RocketMQ version number, such as 20230329. This part indicates commercial features, enhancements, and bug fixes.
The following are examples of upgrades:
Upgrade from 5.0-rmq-20230329 to 5.1-rmq-20230329
Upgrade from 5.0-rmq-20230329 to 5.0-rmq-20230411
For details about the changes in each version, see 5.x series version release notes.
Upgrade rules
Upgrade method
Automatic upgrade: By default, ApsaraMQ for RocketMQ automatically upgrades instance versions. After a new ApsaraMQ for RocketMQ broker version is released, the system automatically creates a pending upgrade task and completes the upgrade in the background.
Pending upgrade tasks
Pending upgrade tasks are created automatically by ApsaraMQ for RocketMQ. You can view task details, such as the status and scheduled execution time, in the console. You can also change the scheduled time for a pending task. For more information, see Modify the execution time of an upgrade task.
Task source | Scheduled execution time | Latest execution time | Cancellable | Schedule modifiable | Task generation time |
Automatic version upgrade | Starts during the first available maintenance window after the new version is released. | Scheduled execution time + 7 days | No | Yes | The task is generated when the upgrade announcement is published. |
Maintenance window
Automatic upgrades occur during the default maintenance window, from 02:00 to 06:00.
You can customize the maintenance window. For more information, see Modify the maintenance window.
A modified maintenance window applies only to new upgrade tasks. Existing tasks are not affected.
If the start time and end time of the maintenance window are the same, the upgrade can occur at any time.
If the end time is earlier than the start time, the maintenance window spans across midnight. For example, a window from 23:00 to 02:00 runs from 23:00 on one day to 02:00 on the next.
Version validity period
ApsaraMQ for RocketMQ versions are valid for 12 months.
When a version is about to expire, a non-cancelable upgrade task is generated. You have one month to choose a specific time for the upgrade.
Upgrade target version
By default, an instance is upgraded directly to the latest available version, skipping any intermediate versions.
Modify task execution time
Log on to the ApsaraMQ for RocketMQ console. In the left-side navigation pane, click Instances.
In the top navigation bar, select a region, such as China (Hangzhou). On the Instances page, click the name of the instance that you want to manage.
On the Instance Details page, click the Version Management tab.
On the Version Management page, click the Pending Tasks tab.
In the list of pending tasks, find the task that you want to modify and click Modify Time in the Actions column.
In the Modify Pending Task Update Time panel, set the Newly Scheduled Update Time and click OK.
Modify the maintenance window
Log on to the ApsaraMQ for RocketMQ console. In the left-side navigation pane, click Instances.
In the top navigation bar, select a region, such as China (Hangzhou). On the Instances page, click the name of the instance that you want to manage.
On the Instance Details page, click the Version Management tab, then click Update Configuration in the upper-right corner.
In the Modify Version Update Configurations panel, modify the maintenance window and click OK.
Related documents
See the 5.x series version release notes for details about the changes in each broker version of ApsaraMQ for RocketMQ.