Skip to Main Content

Upgrade Environment Version

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

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

AutoMQ Cloud BYOC environments will have updated versions with feature iterations. Users can refer to the Release Notes▸ to check the corresponding version and choose to upgrade the environment version.

Upgrade Procedure​

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 the version upgrade also needs to be performed via the Compute Nest Product Console.

Steps to Follow​

Log in to the cloud account associated with the environment console, or use 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 access the Computing Nest console and click on Service Instances in the left navigation bar to enter the list page. Search for the service instance corresponding to the current environment and click on details.
  1. Confirm the Computing Nest service version, and click to upgrade the service instance.
  1. Select the target version, agree to the maintenance authorization, and click to start the upgrade.
  1. After the upgrade is complete, log back into the AutoMQ environment console and check if the upgrade process meets expectations.

Upgrading the Environment from AWS CloudFormation​

On AWS Cloud, if the AutoMQ Cloud BYOC environment is installed through Marketplace CloudFormation, then the upgrade must also be performed via CloudFormation.

Steps to Follow​

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

  1. Go to the Marketplace to view the latest version. On the AWS Marketplace product page, select the target version you wish to upgrade to. It is recommended to upgrade to the Latest version.
  1. Obtain the updated CloudFormation Template. Check Additional Details, and view the CloudFormation Template.
  1. Download the CloudFormation Template to S3. After viewing the new version's Template in CloudFormation Designer, click the save button in the upper left corner to download and save the Template to S3.
  1. Navigate to the Stack list page and find the Stack deploying the AutoMQ BYOC environment. Users access the CloudFormation console, click Stacks on 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 supported operations of the Stack, click Replace existing template and create ChangeSet.

Warning:

During the creation of the ChangeSet, besides the Template update for the new version, the following parameters are not allowed to be modified, otherwise it will cause environment anomalies:

ExistingVPCId: The VPC is not allowed to be modified once the environment installation is completed.

ExistingPublicSubnetId: The subnet where the environment console is located is not allowed to be modified once the environment installation is completed.

MsgBucket: MsgBucket is not allowed to be modified once the environment installation is completed.

OpsBucket: OpsBucket is not allowed to be modified once the environment installation is completed.

  1. Submit changes step by step for preview. After submission confirmation, you can view the scope of resource changes involved in the current version upgrade.
  1. Confirm the execution of the ChangeSet. After the execution is completed, observe whether the upgrade effect meets expectations.