Serverless App Engine:Implement an end-to-end canary release by using Kubernetes Service

1.1 Deploy baseline applications

Create the following baseline applications: sae-a, sae-b, and sae-c. This section describes only the key steps. For more information, see Deploy applications.

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

2. In the Basic Information step, configure the parameters in the Basic Information Settings and Capacity Settings sections, and then click Create Application with One Click.

   Note

   • In this example, the sae-a, sae-b, and sae-c applications are deployed by uploading code packages.

   • To configure advanced settings, click Next: Advanced Settings. Then, click Create Application. For information about how to configure advanced settings, see Advanced settings.

   • The Kubernetes Service-based end-to-end canary release feature is compatible with all service registration and discovery mechanisms in the SAE console. In this example, SAE built-in Nacos registry is selected as the registry.

1.2 Enable Microservices Governance for baseline applications

On the Application List page, click the application name. In the left-side navigation pane, choose Microservices Governance > Application Overview. On the page that appears, click Enable Microservices Governance.

1 to 2 minutes are required to enable Microservices Governance.

1.3 Enable Kubernetes Service-based end-to-end canary release for baseline applications

Enable Kubernetes Service-based end-to-end canary release for the first baseline application in the traffic flow chain after traffic flows to the API gateway. In this example, the first baseline application is sae-a. Perform the following steps:

1. On the Basic Information page of the baseline application, click Deploy Application.

2. In the Service Registration and Discovery section of the Deploy Application page, enable Kubernetes Service-based Service Registry and Discovery.

   If you deploy the baseline application by using a code package, change the version number of the application in the Basic Information Settings section. If you deploy the application by using an image, you do not need to modify the version number. In this example, the baseline application is deployed by using a code package. Therefore, you must modify the version number.

   To modify other parameters, see Advanced settings.

   To configure a release policy, see Set a release policy.

   

   Note

   After you enable the Kubernetes Service-based end-to-end canary release feature, configure the Port and Protocol parameters. In this example, set Protocol to TCP. For information about how to configure the port, see the "Examples" section of this topic.

3. Click OK.

3.1 Create a Cloud-native API Gateway route

1. After you create the canary application, return to the Application List page. In the left-side navigation pane, click Namespaces. On the Namespaces page, select the namespace of the baseline and canary applications.

2. In the left-side navigation pane of the page that appears, click Gateway Routing. On the page that appears, click Create Gateway Route.

3. On the Create Route page, create a Cloud-native API Gateway route. This section describes only the key steps. For more information, see Create and manage a route for an application (API Gateway).

1. Set Gateway Type to Cloud-native API Gateway.

2. Select the gateway instance that you created for the task.

3. Set the Path matching rule to Prefix /.

4. Set Service Source to K8S Service.

   

5. Set Scenario to Single Service.

6. In the Backend Services section, set Application Name to sae-a, Service Name to sae-a-****-gray, Terms of Service to HTTP, and Port to 20001.

   

   Note

   If your baseline application uses Kubernetes Service for service access, two service name prefixes are in the Service Name drop-down list. Select the name prefix of the end-to-end canary release service. Differences between the two name prefixes:

   • Baseline application service name prefix: uses the Baseline application name--Namespace ID format. Example: sae-a-beijing-test.

   • End-to-end canary release service name prefix: uses the Baseline application name-Namespace ID-gray format. Example: sae-a-beijing-test-gray.

7. Click Save.

3.2 Check whether the service is created

After you create the cloud-native API gateway route, an SAE Kubernetes Service is automatically created in the configured cloud-native API gateway instance. For information about how to query services, see View a service.

Take note of the following points:

• Check whether the health check status is Healthy. If not, move the pointer over the anomaly and troubleshoot it based on the error message.

• Check whether the service URL is the IP addresses of the associated baseline and canary applications.

• Check whether the service source is SAE Kubernetes.

4.1 Create a lane group

1. After you create the Cloud-native API Gateway, return to the Namespaces page. In the left-side navigation pane, choose Microservices Governance > End-to-end Canary Release. On the End-to-end Canary Release page, select the namespace and click Create Lane Group and Lane.

   

2. In the Create Lane Group panel, configure the following parameters and click OK.

   1. Specify a lane group name.

   2. Set Ingress Type to Cloud-native API Gateway.

   3. Set Lane Group Traffic Ingress to the created Cloud-native API Gateway instance.

   4. Select all baseline applications for Lane Group Application.

   

4.2 Create lanes

You can create lanes by content or ratio in a lane group. After you create the first lane, you cannot change the canary release mode for subsequent lanes.

The configuration examples in the following table apply only to the scenario in this topic. In the actual production environment, adjust the configurations based on business requirements.

5.1 Perform access test

1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, click Instance. In the top navigation bar, select the region of the Cloud-native API Gateway instance that you created and click the ID of the instance.

2. On the Overview page of the Cloud-native API Gateway instance, click the Endpoint tab. On the Access Domain Name and IP Address tab, view the access domain name and instance IP address.

   

   Important

   • An access domain name is the entry point of a gateway instance. In production environments, you must CNAME the service domain name to the access domain name by using DNS. You can send a maximum of 1,000 requests per day for direct access to a gateway instance by using the access domain name. Therefore, you can use this access method only for testing.

   • The instance IP address is the one used by the gateway to provide external services. However, do not directly map the service domain name to the instance IP address. We recommend that you CNAME the business domain name to the access domain name. This way, the access domain name balances loads across multiple IP addresses to avoid single-IP-address-single-zone failures. We recommend using the instance IP address only for domain name registration or for configuring an IP address blacklist or whitelist.

3. Copy the access domain name or public IP address and perform an access test in a browser.

   Sample URL format for access by using the domain name: http://<Access domain name>/<Access path>. Example: http://env-cu2c******/a.

   Sample URL format for access by using the public IP address: http://<Internet: 80>/<Access path>. Example: http://8.147.XX.XX:80/a.

   

5.2 Verify traffic routed to canary applications

#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.3 Microservices Governance observability

Go to the End-to-end Canary Release page in the SAE console. In the Lane Groups and Involved Applications section, click the application name. In the Application QPS Monitoring section, you can view the traffic information of the baseline and canary applications of the lane. Select a playback time to display the corresponding metric data.