Skip to Main Content

Upgrade Environment Version

Users can refer to this document to upgrade the BYOC environment console version as needed while using the AutoMQ Cloud BYOC product to obtain updates and bug fixes.

In this document, the terms AutoMQ product service provider, AutoMQ service provider, and AutoMQ specifically refer to AutoMQ HK Limited.

The AutoMQ Cloud BYOC environment will have updated versions as functionality iterates. Users can refer to the Release Notes▸ to view the corresponding versions and choose to upgrade the environment version.

Upgrade Operations​

Upgrading the Environment from Alibaba Cloud Compute Nest​

On Alibaba Cloud, the AutoMQ Cloud BYOC environment is deployed and managed through the Compute Nest Service, so version upgrades also need to be performed in the Compute Nest Product Console.

Operation Steps​

Log in to the environment console's associated cloud account or a sub-account with authorized operational capabilities, and go to the Compute Nest Product Console.

  1. Go to the service instance list page, select the private deployment instance, and locate my service instance. Users should access the Compute Nest console, click on Service Instances in the left navigation bar, and go to the list page. Search for the service instance corresponding to the current environment and click on details.
  1. Confirm the Compute Nest service version, and click upgrade service instance.
  1. Select the target version, agree to the operations authorization, and click start upgrade.
  1. After the upgrade is complete, log back into the AutoMQ environment console and verify that the upgrade process met expectations.

Upgrading the Environment from AWS CloudFormation​

On AWS Cloud, if the AutoMQ Cloud BYOC environment was installed via Marketplace CloudFormation, the upgrade must also be performed in CloudFormation.

Steps to Operate​

Log in to the cloud account associated with the environment console, or a sub-account with authorized operation capabilities, and go to the Marketplace console.

  1. Go to the Marketplace to view the latest version. Users can visit the AWS Marketplace product page and select the desired version for the upgrade. It is recommended to upgrade to the latest version.
  1. Obtain the updated CloudFormation Template. Go to Additional Details and view the CloudFormation Template.
  1. Download the CloudFormation Template to S3. After viewing the new version of the template in the CloudFormation Designer, click the save button at the top left to download and save the template to S3.
  1. Go to the Stack list page and locate the Stack deployed for the AutoMQ BYOC environment. Users can visit the CloudFormation console, click Stacks in the left navigation bar to enter the list page. Search for the Stack corresponding to the current environment and click Stack Actions.
  1. Find the operations supported by the Stack and click Replace current template and create ChangeSet.

Warning:

During the ChangeSet creation process, apart from updating to the new version of the template, the following parameters are not supported for modification, as it will result in environment anomalies:

ExistingVPCId: After the environment is installed, VPC modification is not allowed.

ExistingPublicSubnetId: After the environment is set up, the subnet where the environment console resides cannot be modified.

MsgBucket: After the environment is set up, the MsgBucket cannot be modified.

OpsBucket: After the environment is set up, the OpsBucket cannot be modified.

  1. Submit changes step by step for preview. After confirming submission, you can view the scope of resource changes involved in the current version upgrade.
  1. Confirm to execute the ChangeSet. After waiting for the execution to complete, observe whether the upgrade effect meets expectations.