Serverless App Engine:End-to-end canary release based on MSE cloud-native gateway

Terms

• MSE cloud-native gateway: a next-generation gateway that is compatible with Kubernetes Ingress. MSE cloud-native gateways support service discovery based on multiple sources such as Container Service for Kubernetes (ACK) and Nacos instances. MSE cloud-native gateways also support multiple logon authentication methods to provide security protection.

• Lane: an isolated environment that is defined for applications of the same version. Only requests that match specific routing rules can be routed to the tagged applications in a lane. An application can belong to multiple lanes. A lane can contain multiple applications. Applications have a many-to-many relationship with lanes.

• Lane group: a collection of lanes. A lane group is used to distinguish between different teams or scenarios.

• Base environment: an environment in which untagged applications run. Base environments provide disaster recovery for other environments.

Scenario

This topic simulates an invocation trace to demonstrate the end-to-end canary release. Without changing any code, you only need to configure tag-based routing rules for an ingress application. The tags will be propagated through the trace to subsequent applications. Traffic that meets the specified rules is routed to the canary versions based on version tags.

The deployment of each test application is as follows:

Test application: End-to-end canary release demo program.zip, which includes three backend applications: A, B, and C. These applications can be deployed as baseline or canary applications.

The traffic distribution diagram is as follows:

The call chain is as follows:

• Normal traffic invocation:

  MSE cloud-native gateway -> Application sae-a -> Application sae-b -> Application sae-c.

• Tagged traffic invocation:

  • t=g1 traffic: MSE cloud-native gateway -> Application sae-a-a1 -> Application sae-b -> Application sae-c-c1.

  • t=g2 traffic: MSE cloud-native gateway -> Application sae-a-a2 -> Application sae-b-b2 -> Application sae-c-c2.

Prerequisites

• The Microservices Governance Professional or Enterprise Edition has been activated. For more information, see Activate Microservices Governance.

• An MSE cloud-native gateway has been created. For more information, see Create an MSE cloud-native gateway.

• An MSE Nacos instance and namespace have been created. For more information, see Create an instance and Create a namespace.

Limits

• The end-to-end canary release feature is applicable only to microservice applications created on or after November 8, 2023.

• The feature is supported only in the new version of the console.

• End-to-end canary release integrates the tag-based routing feature of Microservices Governance. If you want to use the end-to-end canary release feature, do not configure canary release and tag-based routing rules for your applications.

  Limits and values

  Item	Version	Description
  Gateway service source	SAE built-in Nacos and MSE Nacos	The end-to-end canary release based on the MSE cloud-native gateway currently only supports SAE built-in Nacos and MSE Nacos as sources.
  MSE cloud-native gateway	Version 2.0.6 or later	Versions earlier than 2.0.6 need to be upgraded to the latest version. For more information, see Upgrade the MSE cloud-native gateway version.
  Spring Cloud	Spring Cloud Edgware or later	N/A
  Dubbo	2.5.3 to 2.7.8	Dubbo 3.0 and later versions are currently in canary release. If you have scenario requirements, please submit a ticket to contact MSE technical support.
  Client	Resttemplate Spring Cloud OpenFeign	N/A
  Java application JDK	JDK 6, 7, and 8 versions	JDK 11 version is in canary release. If you plan to use it, submit a ticket to contact MSE technical support.
  Load balancing	Ribbon 2.0.x or later LoadBalancer 3.0.x or later	N/A
  Spring Cloud Gateway	Spring Cloud Gateway 2.1.0.RELEASE or later	N/A

1. Deploy baseline applications and enable microservices governance

1.1 Deploy baseline applications

Create three baseline applications: sae-a, sae-b, and sae-c. This topic only covers the key steps. For more details, see Application deployment.

1. Log on to the SAE console. In the left-side navigation pane, choose Applications > Applications. Select a region in the top navigation bar and a namespace from the Namespace drop-down list, and then click Create Application.

   

2. On the Application Basic Information wizard page, configure the parameters in the Basic Information Settings and Capacity Settings sections, and then click Next: Advanced Settings.

   In this example, select to deploy the three baseline applications sae-a, sae-b, and sae-c by uploading a code package.

3. Find and expand the Service Registration and Discovery section. Select Nacos-based Registry Service and Discovery as MSE Nacos Professional Edition, and choose the target MSE Nacos Instance and Namespace. For other advanced settings, see Advanced settings.

   

   Important

   All three baseline applications use the same MSE Nacos instance and namespace.

4. Click Create Application.

1.2 Enable microservices governance for baseline applications

On the Application List page, click the application name. In the left-side navigation pane, select Microservices governance > Application Overview, and click Enable Microservices Governance.

The enabling process takes 1 to 2 minutes. Please wait patiently.

2. Deploy canary applications

Deploy canary applications based on baseline applications:

• Two canary applications, sae-a-a1 and sae-a-a2, on application sae-a.

• One canary application sae-b-b1 on application sae-b.

• Two canary applications, sae-c-c1 and sae-c-c2, on application sae-c

The procedure is as follows.

1. On the Application List page, click the icon on the right side of the baseline application, and then click Create Canary Application.

   Note

   If microservice governance is not activated for the baseline application, you cannot create a canary application.

2. On the Basic Information wizard page, configure the following information, and click Next: Advanced Settings.

   1. In the Basic Information Settings section, set the canary Application Name and choose to deploy the canary application by image or code package. For more information, see Application deployment.

      Note

      • The Namespace configurations of the canary applications inherit from the baseline applications, so no modifications are needed.

      • The Application Deployment Method also inherits from the baseline applications. In this example, re-uploading the code package is not required. But you can adjust this parameter as needed in a production environment.

   2. In the Canary Tag section, set the Value for the tag. See Scenario for the tag configurations.

      

   3. In the Capacity Settings section, configure the resource specifications and number of instances.

3. On the Advanced Settings wizard page, configure the features as needed. For more information, see Advanced configuration.

   Note

   The Service Discovery Feature of the canary application will automatically inherit the configurations of the baseline application. Manual modification is not required.

4. Click Create Application.

3. Create MSE cloud-native gateway routing

1. After creating the canary application, return to the Application List page, and select Namespace in the left-side navigation pane. On the Namespace page, click the name of the namespace where the baseline and canary applications are located.

2. After entering the target namespace, click Gateway Routing in the left-side navigation pane, and click Create Gateway Route.

3. Create an MSE cloud-native gateway routing on the Create Route page. This topic only describes the key steps. For more details, see Create and manage a route for an application (MSE).

   Note

   The configurations are only applicable to this example. Adjust the settings as needed in the production environment.

   1. Select Gateway Type as MSE Cloud-native Gateway.

   2. Select the gateway instance created in the prerequisites in Gateway Instance.

   3. Select Path as Prefix/.

   4. Select Service Source as MSE Nacos.

   5. Select the same MSE Nacos instance and namespace as the baseline application for MSE Nacos Instance and Namespace of MSE Nacos Instance.

      

   6. Select Scenario as Single Service scenario.

   7. Select sae-a as Application Name for Backend Service, enter sc-A in Service Name, choose HTTP as Service Protocol, and set Service Port to 20001.

4. Click Save.

4. Create lane groups and lanes

4.1 Create lane groups

1. After the MSE cloud-native gateway is created, return to the Namespace page. In the left-side navigation pane, select Microservices governance > End-to-end Canary Release. On the End-to-end Canary Release page, select the target namespace, and then click Create Lane Groups and Lanes.

   

2. In the pop-up Create Lane Group panel, configure the following parameters, and then click OK.

   1. Customize the Lane Group Name.

   2. Select Ingress Type as MSE Cloud-native Gateway.

   3. Select the cloud-native API gateway instance created in the prerequisites as Lane Group Traffic Ingress.

   4. Select all baseline applications as Lane Group Application.

   

4.2 Create lanes

When creating lanes, you can choose either Canary Release by Content or Canary Release by Ratio. However, once the first lane is created, you cannot change the mode for subsequent lanes.

The following table provides configuration examples for this scenario. Adjust according to your needs in a production environment.

5. Verify results

5.1 Test canary release traffic

# Test command
curl 8.130.XX.XX/a
# Test result
A[192.168.XX.XX][config=base] -> B[192.168.XX.XX] -> C[192.168.XX.XX]
A${tag}[192.168.XX.XX][config=base] -> B[192.168.XX.XX] -> C${tag}[192.168.XX.XX]

5.2 Microservices governance observability

Log on to the SAE console. On the End-to-end Canary Release page, In the Lane Group and Involved Applications section, click the target application. In the Application QPS Monitoring section, view the lane traffic of baseline and canary versions. Select the playback time to display the data within the specific time frame.