Skip to Main Content

Upgrade Environment Version

When using the AutoMQ Cloud BYOC product, users can refer to this document to upgrade the BYOC environment console version as needed to receive updates and fix bugs.

Info

The terms AutoMQ product service provider, AutoMQ service provider, and AutoMQ mentioned in this document specifically refer to Antomqiu (Hangzhou) Technology Co., Ltd.

The AutoMQ Cloud BYOC environment will release updated versions as features iterate, and users can view the corresponding versions by visiting the Release Notes▸ to choose to upgrade the environment version.

Upgrade Operation​

Alibaba Cloud​

AutoMQ Cloud BYOC environments are deployed and managed on Alibaba Cloud through the Compute Nest Service. Therefore, upgrading versions also requires operations in the Compute Nest Product Console.

Steps to Follow​

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

  1. Go to the service instances list page, select the privatized deployment instance, and locate your service instance. Users should access the Compute Nest Console, click on Service Instances in the left navigation bar to enter the list page. Search to find the service instance corresponding to the current environment and click on details.
  1. Confirm the Compute Nest service version and click to upgrade the service instance.
  1. Select the target version, agree to the operational authorization, and click 'Start Upgrade'.
  1. After the upgrade is completed, log back into the AutoMQ Environment Console and verify if the upgrade process meets expectations.

AWS​

If the AutoMQ Cloud BYOC environment is installed on AWS via Marketplace CloudFormation, the upgrade version must also be handled through CloudFormation.

Tip

If the BYOC environment is installed via Terraform, go to the Terraform Module's Release Note page to update the Terraform Module version and upgrade the software version of the environment console.

Steps for Operation​

Log in to the cloud account associated with the Console or a sub-account with authorization capabilities, and navigate to the Marketplace Console.

  1. Go to the Marketplace to check the latest version. Visit the AWS Marketplace product page, select the target version you wish to upgrade to; it is recommended to upgrade to the most recent 'Latest' version.
Obtain the updated CloudFormation Template.
  1. Acquire the updated CloudFormation Template. View Additional Details and then check CloudFormation Template.
Download the CloudFormation Template to S3.
  1. Download CloudFormation Template to S3. After reviewing the new version of the Template in CloudFormation Designer, click the save button in the top left corner to download and save the Template to S3.
Navigate to the Stack list page to locate the Stack for deploying the AutoMQ BYOC environment.
  1. Navigate to the Stack list page to locate the Stack for deploying the AutoMQ BYOC environment. Users can access the CloudFormation console, click on Stacks in the left navigation bar, and enter the list page. Search for the Stack corresponding to the current environment, and click on Stack Actions.
Identify supported actions for the Stack
  1. Identify the supported operations for the Stack, and click Replace the current template to create a ChangeSet.
Change the version of the ImageId to the target version. For example, replace
  1. Update the ImageId to the target version. For example, substitute 7.0.3 with 7.1.0.
Danger

Warning:

When creating the ChangeSet, aside from the new version Template update, the following parameters cannot be changed; otherwise, the environment may become unstable:

ExistingVPCId: After the environment is set up, the VPC cannot be altered.

ExistingPublicSubnetId: Once the environment installation is complete, you cannot modify the subnet where the environment console resides.

MsgBucket: Once the environment installation is complete, the MsgBucket cannot be changed.

OpsBucket: After the installation of the environment is finalized, the OpsBucket is not alterable.

Submit changes step-by-step for a preview.
  1. Submit changes step-by-step for a preview. After confirming the submission, you can review the scope of resources affected by the current version upgrade.
Confirm execution of ChangeSet.
  1. Confirm the execution of the ChangeSet. Wait for the execution to complete and verify whether the upgrade results align with expectations.

Google Cloud​

In the AutoMQ Cloud BYOC environment on GCP via Marketplace installation, since Marketplace does not currently offer a console page for upgrades, it is advised to upgrade versions using the gcloud CLI.

Steps​

  1. Locally, use the gcloud CLI to log into the cloud account linked with the environment console, or a sub-account with authorized operational capabilities.

gcloud auth login

  1. Create New Version System Disk. Check the AutoMQ version logs to determine the environment version that needs an upgrade. Use the following command as a guideline to create a system disk for the new version of the console VM.

gcloud compute disks create $disk_name  \
--image projects/mpi-automq-public/global/images/automq-control-center-prod-$version-x86-64 \
--zone $zone

The parameter descriptions are as follows:

    • disk_name: You can customize the name of the system disk.
    • image: The name of the image used by the system disk. This should be filled in with the appropriate value according to different version numbers, such as "projects/automq-public/global/images/automq-control-center-prod-7-3-11-x86-64", replacing 7-3-11 with the corresponding X.Y.Z version number.
    • zone: Input the name of the zone where the AutoMQ console is located.
  1. Stop the AutoMQ Console Virtual Machine. Go to the Compute Engine console and find the virtual machine named AutoMQ Console. Run the following command to power it off.

gcloud compute instances stop $instance_name --zone $INSTANCE_ZONE

The parameter instructions are as follows:

  • instance_name: Provide the name of the AutoMQ Console instance.

  • zone: Specify the zone name where the AutoMQ Console is located.

  1. Unmount the Old System Disk.

gcloud compute instances detach-disk $\{Your VM Instance\} \
    --disk=$\{Your Original System Disk\} --zone $INSTANCE_ZONE

The parameter descriptions are as follows:

  • instance_name: Enter the instance name from the AutoMQ Console.

  • disk: Enter the current system disk name from the AutoMQ Console.

  1. Mount the new system disk.

gcloud compute instances attach-disk $INSTANCE_NAME \
    --disk $NEW_DISK_NAME \
    --zone $INSTANCE_ZONE \
    --boot

The parameter descriptions are as follows:

  • instance_name: Enter the instance name from the AutoMQ Console.

  • disk: Enter the new system disk name from the AutoMQ Console. This is the name of the system disk created in step 1.

  • zone: Enter the zone name where the AutoMQ Console is located.

  1. Restart the AutoMQ Console.

gcloud compute instances start $INSTANCE_NAME --zone $INSTANCE_ZONE

The explanations for the parameters are as follows:

  • instance_name: Enter the instance name in the AutoMQ console.

  • zone: Enter the zone name where the AutoMQ console is located.

  1. Once the upgrade is complete and verified to meet expectations, you can delete the system disk of the previous version. After deletion, rolling back to the previous version will not be possible.

gcloud compute disks delete DISK_NAME --zone $INSTANCE_ZONE

The parameter descriptions are as follows:

  • disk_name: Enter the system disk name of the previous version in the AutoMQ console.

  • Zone: Enter the name of the zone where the AutoMQ console is located.