Skip to Main Content

Upgrade Environment Version

Users can refer to this documentation to upgrade their BYOC environment console version as needed while using the AutoMQ Cloud BYOC product, obtaining updates and bug fixes.

In this document, the terms AutoMQ Product Service Provider, AutoMQ Service Provider, AutoMQ, specifically refer to AntomenQiu (Hangzhou) Technology Co., Ltd.

The AutoMQ Cloud BYOC environment will generate updated versions as functions iterate, and users can view the corresponding versions according to Release Notes▸ and choose to upgrade the environment version.

Upgrade Operation​

Alibaba Cloud​

AutoMQ Cloud BYOC environment on Alibaba Cloud is deployed and managed through the Compute Nest Service, so upgrading versions also requires operations on the Compute Nest product console.

Operational Steps​

Log in to the cloud account associated with the environment console, 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 privatized deployment instance, find my service instance. Users visit the Compute Nest console, 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 details.
  1. Confirm Compute Nest service version, click Upgrade service instance.
  1. Select the target version, agree to the maintenance authorization, and click Start Upgrade.
  1. After completing the upgrade, log back into the AutoMQ environment console to check if the upgrade process meets expectations.

AWS​

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

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

Steps for Operation​

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

  1. Go to Marketplace to check the latest version. Visit the AWS Marketplace product page, select the target version you wish to upgrade to, and it is recommended to upgrade to the latest version.

  2. Acquire the updated CloudFormation Template. Check Additional Details and view the CloudFormation Template.

Download the CloudFormation Template to S3.
  1. Download the CloudFormation Template to S3. After viewing the new version of the Template in CloudFormation Designer, click the Save button on the top left to download and save the Template to S3.
Navigate to the Stack list page to find 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. Access the CloudFormation console and click on Stacks in the left navigation pane to enter the list page. Search for the Stack corresponding to the current environment, then click on Stack Actions.
Find the operations supported by the Stack
  1. Find the operations supported by the Stack and click Replace current template, creating a ChangeSet.
Modify the ImageId version to the desired version. For example, change
  1. Replace the ImageId version with the desired target version. For example, change 7.0.3 to 7.1.0.

Warning:

During the creation of the ChangeSet process, besides updating the template to the new version, the following parameters cannot be modified to avoid environment issues:

ExistingVPCId: Once the environment is installed, the VPC cannot be changed.

ExistingPublicSubnetId: After installation, the subnet where the environment's console resides cannot be modified.

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

OpsBucket: Once the environment installation is complete, OpsBucket cannot be altered.

  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.
Confirm execution of ChangeSet.
  1. Confirm execution of ChangeSet. Once the execution is complete, check if the upgrade effects meet expectations.

Google Cloud​

In the GCP AutoMQ Cloud BYOC environment, installing via the Marketplace is recommended. Since there is no console page available for upgrades in the Marketplace, we recommend using the gcloud CLI for upgrades for now.

Operational Steps​

  1. Use the gcloud CLI locally to log into the cloud account associated with the environment console or an authorized sub-account.

gcloud auth login

  1. Create a new version of the system disk. Based on the AutoMQ version record, confirm the environment version to be upgraded and create a new version of the console virtual machine system disk using the following command.

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: Users can customize the name of the system disk.

  • image: The name of the image used for the system disk. This should be filled with the appropriate value based on the version number, for example, "projects/automq-public/global/images/automq-control-center-prod-7-3-11-x86-64", with 7-3-11 replaced by the corresponding X.Y.Z version number.

  • zone: Fill in the zone name where the AutoMQ Console is located.

  1. Stop the AutoMQ Console virtual machine. Navigate to the Compute Engine console and locate the virtual machine name for AutoMQ Console. Execute the following command to shut it down.

gcloud compute instances stop $instance_name --zone $INSTANCE_ZONE

The parameters are explained as follows:

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

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

  1. Uninstall the old system disk.

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

Parameter description is as follows:

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

  • disk: Enter the name of the current system disk in 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 parameters are described as follows:

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

  • disk: Enter the name of the new system disk created in step 1 in the AutoMQ console.

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

  1. Restart the AutoMQ console.

gcloud compute instances start $INSTANCE_NAME --zone $INSTANCE_ZONE

The parameter descriptions are as follows:

  • instance_name: Specify the instance name of the AutoMQ console.

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

  1. After the upgrade is completed and the expected outcome is confirmed, you may delete the system disk of the historical version. Once deleted, it will no longer be possible to roll back to previous versions.

gcloud compute disks delete DISK_NAME --zone $INSTANCE_ZONE

Parameter descriptions are as follows:

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

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