Skip to content

Create a canary release task

Based on the open source project Argo Rollout, Workbench provides powerful grayscale publishing capabilities. Grayscale release can release new application versions without affecting the old version. According to the pre-defined rules, the traffic is gradually switched to the new version. When the new version runs without problems, all traffic will be automatically migrated from the old version to the new version.

prerequisites

  1. Create a workspace and a user, the user needs to join the workspace and have the Workspace Editor role.

  2. Create an application and enable Grayscale Release, refer to Build microservice application based on Git repository, Deploy Java application based on Jar package.

  3. Istiod and Argo Rollout have been installed on the cluster where the object is published. For specific installation methods, refer to Managing Helm Apps.

Steps

  1. Enter the Workbench module, click Gray Release in the left navigation bar, and then click Create Release Task->Canary Release in the upper right corner of the page.

  2. Fill in the basic information with reference to the following requirements, and then click Next.

    • Name: Fill in the name of the publishing task. Maximum 63 characters, can only contain lowercase letters, numbers, and a separator ("-"), and must start and end with a lowercase letter or number
    • Cluster: Select the cluster where the published object resides. You need to make sure that the cluster has Istio and Argo Rollout deployed.
    • Namespace: Select the namespace where the object to be published is located, and the application that has enabled "Grayscale Publishing" has been deployed in this namespace.

    • Stateless payload: select specific publishing objects.

  3. Refer to the following instructions to configure publishing rules.

    • Number of instances: the number of copies applied when performing grayscale publishing tasks.

    • Traffic scheduling strategy:

      • Release traffic ratio in the current stage: the traffic ratio for the grayscale version in each traffic cycle.

      • Waiting time after reaching the flow rate: increase the flow period for the grayscale version, that is, how long to wait before automatically entering the next grayscale flow rate.

        If set to 0 or not filled in, the publishing task will be permanently suspended when it reaches this step.

    • Monitoring and analysis: Once enabled, you can use the capabilities of Prometheus for monitoring. Automatically perform monitoring analysis throughout the release process based on pre-defined monitoring metrics and collection intervals. If the defined rules are not met, it will automatically roll back to the old version, and grayscale publishing will fail.

  4. Click Create and update application at the bottom of the page, then set the mirror address of the grayscale version in the pop-up box and click OK.

    At this point, the number of copies of the original workload will be set to 0.

  5. The system automatically jumps to the task list page of the grayscale release, prompting updated version successful.

Comments