Specify the agent version to ensure compatibility - Microservices Engine

This topic describes how to specify the agent version of Microservices Engine (MSE) Microservices Governance.

Specify the MSE agent version by using the ack-onepilot component

Prerequisites

The ack-onepilot component of a version later than 3.0.15 is installed. If the version of the ack-onepilot component is 3.0.15 or earlier, upgrade the component by following the instructions in Update the Microservices Governance component.

Procedure

If you do not specify the MSE agent version, the MSE agent of the latest stable version is used. If you specify an MSE agent version, use the MSE agent of the specified version to enable Microservices Governance for your application. You can download the MSE agent from one of the following endpoints:

Public endpoint: http://arms-apm-${regionId}.oss-${regionId}.aliyuncs.com/${agentVersion}/ArmsAgent.zip
Internal endpoint: http://arms-apm-${regionId}.oss-${regionId}-internal.aliyuncs.com/${agentVersion}/ArmsAgent.zip

For the pod in which your application resides, configure aliyun.com/agent-version: agent version in labels to specify the MSE agent version.
For example, if you want to use the MSE agent of 3.1.4 for a pod, add the labels in the following sample code to the YAML file of the deployment:
```
spec:
 template:
   metadata:
     labels:
       aliyun.com/agent-version: "3.1.4"
       mseNamespace: "default" # The MSE microservice namespace to which your application belongs. 
       msePilotCreateAppName: "<yourAppName>" # Replace <yourAppName> with the actual name of your application.
```
Note
- For more information about the MSE agent versions and features, see MSE agent release notes.
- We recommend that you manually download the MSE agent and confirm that the MSE agent version exists before you configure the labels.
After you specify the MSE agent version, run the cat /home/admin/.opt/ArmsAgent/version command on the pod to check whether the MSE agent in use is of the specified version.

Specify the MSE agent version for applications deployed on an ECS instance

If you want to enable Microservices Governance for applications that are deployed on an Elastic Compute Service (ECS) instance, you can download the agent of the specified version and enable Microservices Governance for your application. For more information, see Connect microservice applications on ECS instances to Microservices Governance.

You can download the MSE agent from one of the following endpoints:

Public endpoint: http://arms-apm-${regionId}.oss-${regionId}.aliyuncs.com/${agentVersion}/ArmsAgent.zip
Internal endpoint: http://arms-apm-${regionId}.oss-${regionId}-internal.aliyuncs.com/${agentVersion}/ArmsAgent.zip

Note

In the endpoints, RegionId specifies the ID of the region. Examples: cn-hangzhou or ap-southeast-1. For more information, see Supported regions.
AgentVersion specifies the MSE agent version. Example: 3.1.4. For more information, see MSE agent release notes.
If your application is deployed in an Alibaba Cloud virtual private cloud (VPC), you can download the MSE agent from the internal endpoint. Otherwise, download the MSE agent from the public endpoint.
To download the MSE agent of the specified version for applications in the China East 1 Finance region, submit a ticket.