Create and enable canary release rules for SAE applications for small-scale verification - Serverless App Engine

Prerequisites

Deployed an application.
Enabled MSE microservice administration Professional Edition.

Note
MSE is billed separately. For MSE billing details, see Billing overview for microservice administration.

Limitations

This feature is available only for microservice applications created on or after November 8, 2023.

Access the feature

On the Applications page, select a region and namespace at the top, and then click the target application name to open the application details page.
In the navigation pane on the left, choose Microservice Governance > Traffic Governance, and then click the Canary Release Rule tab.

Create a canary release rule

On the Canary Release Rule page, click Create Canary Release Rule. In the Create Canary Release Rule panel, configure the settings and then click OK.

Note

If this is your first time using this feature, you must click Enable Microservice Governance on this page and then refresh the page before you can configure a canary release rule.

Parameter	Description
Rule type	Layer-7 Traffic Canary Release (K8s Ingress): Routes tagged Layer-7 traffic to instances in the canary batch. Microservice Traffic: Routes tagged traffic to instances in the canary batch.
Rule name	Enter a name for the canary release rule.
Description	Optional. A description of the canary release rule.
Canary release type	Content-based canary release.
Gateway instance (ALB Ingress)	Required if Rule type is set to Layer-7 Traffic Canary Release (K8s Ingress). SAE uses an ALB-based Ingress to route traffic to different applications based on domain names and paths. You must configure an ALB instance for your application and create routing rules. For more information, see Configure routing rules for an application (ALB Ingress).
Service for canary release	Required if Rule type is set to Layer-7 Traffic Canary Release (K8s Ingress). Select the application and its corresponding port for the canary release.
Framework type	Required if Rule type is set to Microservice Traffic. Select the framework your application uses. Spring Cloud: You must set the Path. Dubbo: You must select the Service Method.
Condition mode	Required if Rule type is set to Microservice Traffic. Select Meet All Following Conditions (AND logic) or Meet One of Following Conditions (OR logic).
Condition list	Click + Add Condition to add one or more conditions. Microservice canary traffic Spring Cloud: Select a parameter type (Cookie, Header, or Parameter), and then set the corresponding Parameter, Condition, and Value. Dubbo: Set the Parameter, Parameter Value Expression, Condition, and Value. Layer-7 traffic canary release Select a parameter type (Cookie, Header, or Source IP), and then set the corresponding Parameter and Value.

For Microservice Traffic, you can also click "+ New Traffic Rule" to create multiple inbound traffic rules. Multiple rules can be active simultaneously, and newly created rules are added to the rule list.

Edit or delete a canary release rule

On the Canary Release Rule page, find the target rule and, in the Actions column, click Edit or Delete.

After you enable MSE microservice governance, MSE continues to incur charges even if you delete the canary release rules.

To stop MSE charges, disable microservice governance. On the application's Basic Information page, choose More > Disable Microservice Governance in the upper-right corner and follow the on-screen instructions.

Note

Disabling microservice governance also disables graceful online/offline, canary rules, and rate limiting/degradation, and restarts the application. Evaluate the business impact before proceeding.

Next steps

After you create a canary release rule, configure a canary release for your application to test a new version. For a Spring Cloud example in SAE, see Canary release for an application.