This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Canary Deployment

    Users can add canary deployments.

    Canary addition refers to setting up two Helm releases to be bundled for canary testing.

    Project, Cluster, Release Type, Chart Name, Chart Version, and Development Classification must all be the same for two Helm releases to be bundled.

    Getting Started with Canary Deployment

    To start using canary deployment, follow these steps:

    1. Click the Project card on the Main page to go to the Project Dashboard page.
    2. Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
      ItemDescription
      NameDisplays the canary name. Click to view detailed information.
      ClusterDisplays the deployed cluster.
      (Operation)Displays the currently operating Helm release.
      (Canary)Displays the canary Helm release.
      TerminateTerminates the canary.
      Table. Kubernetes Deployment Screen Canary Card Items
    3. Click the name of the canary you want to use on the Kubernetes Deployment page’s deployment list to go to the Deployment Details page.

    Adding a Canary

    To add a canary, follow these steps:

    Note

    Canary is supported in the following environments. Check before adding a canary.

    • Kubernetes v1.17 or higher
    • nginx-ingress v0.29.0 or higher
    Guide
    To add a canary, you need two Helm releases installed using the same chart.
    1. Click the Project card on the Main page to go to the Project Dashboard page.
    2. Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
    3. Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup window opens.
    4. Enter information in the Add Canary popup window and click the Save button to complete adding the canary.
    ItemDescription
    ClassificationSelect development or operation.
    Canary NameEnter the canary name.
    Operation
    • Release Name: Select the name of the currently operating Helm release from the list.
    • Jenkins Job: Select the Jenkins job for building and deploying the currently operating Helm release from the list.
    Canary
    • Release Name: Select the name of the next operating Helm release from the list.
    • Jenkins Job: Select the Jenkins job for building and deploying the next operating Helm release from the list.
    K8S ClusterDisplays the K8S cluster where the Helm release is installed.
    Ingress AnnotationEnter the annotation item you want to apply from the canary annotation provided by nginx-ingress.
    Table. Add Canary Input Items
    Note
    For detailed guidance on each item of nginx-ingress ingress annotations, see the next page.

    Checking Ingress YAML of Canary

    To check the operating Ingress YAML and canary Ingress YAML used by the canary, follow these steps:

    1. Click the View icon for Operating Ingress YAML or Canary Ingress YAML on the Deployment Details page. The Ingress YAML popup window opens.
    2. Check the contents in the Ingress YAML popup window and click the OK button to close it.

    Managing Jenkins Job of Canary

    Viewing Jenkins Job Log

    To view the Jenkins job log, follow these steps:

    1. Click the Log button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Log popup window opens.
    2. Check the log in the Pipeline Log popup window and click the OK button.

    Running Jenkins Job

    To run a Jenkins job, follow these steps:

    1. Click the Run button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Run Parameter Input popup window opens.
    2. Enter or select each item in the Pipeline Run Parameter Input popup window and click the OK button to complete running the Jenkins job.

    Modifying Canary

    To modify a canary, follow these steps:

    1. Click the Modify button on the Deployment Details page. The Modify Canary popup window opens.
    2. Modify the desired items in the Modify Canary popup window and click the Save button to complete the modification.

    Recovering Canary

    When the ingress annotation information of the operating release and canary release does not work normally due to changes in the Helm release, recover it to work again.

    To recover a canary, follow these steps:

    1. Click the Recover button on the Deployment Details page. The Recover popup window opens.
    2. Click the OK button in the Recover popup window to complete the recovery.

    Terminating (Deleting) Canary

    To terminate a canary, follow these steps:

    1. Click the Terminate button on the Deployment Details page. The Terminate Canary popup window opens.
    2. Select the desired items in the Terminate Canary popup window and click the OK button to complete the termination.
    Item
    Description
    Canary ReleaseSelect the canary release
    • Ingress Host Reversion: Reverts the ingress host of the Helm release used for the canary to its original value.
    • Helm Release Deletion: Deletes the Helm release used for the canary.
    Operation ReleaseSelect the operation release
    • Canary Image Upgrade: Upgrades the operation Helm release to the image used by the canary. You can modify the Values.yaml file.
    • No Action: Terminates the canary without changing the operation Helm release.
    Table. Canary Termination Selection Items