Canary Deployment

The user can add a canary deployment.

Adding a canary means configuring two Helm releases together so that a canary test can be performed.

Only two Helm releases that have the same Project, Cluster, Release Type, Chart Name, Chart Version, and Development Classification can be grouped.

Getting Started with Canary Deployment

To start using Canary, follow these steps.

1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.

   Item	Explanation
   Name	Displays the Canary name. Click to view detailed information.
   cluster	Displays the deployed cluster.
   (operation)	Displays the currently running Helm release.
   (Canary)	Displays the HelmRelease that is in Canary.
   Exit	Shutting down Canary.

   Table. Kubernetes deployment screen Canary card items
3. On the Kubernetes deployment page, click the name of the canary you want to use in the deployment list. You will be taken to the deployment details page.

Add Canary

To add a canary, follow these steps.

1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
2. Click the Build/Deploy > Kubernetes Deploy menu in the left sidebar. You will be taken to the Kubernetes Deploy page.
3. Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup opens.
4. Add Canary In the popup window, after entering the information, click the Save button to complete adding the canary.

   Item	Explanation
   Category	Select Development or Operations. The actions each role can perform differ depending on whether it is Development or Operations. (Table. Permissions by role within the project (2))
   Canary name	Enter the canary name.
   Operation	Release name: Select the name of the currently deployed Helm release from the list. Jenkins Job: Select the Jenkins job for building/deploying the currently deployed Helm release from the list.
   Canary	Release name: Select the name of the Helm release that will be the next version in operation from the list. Jenkins Job: Select the Jenkins job that will build/deploy the Helm release for the next operational version from the list.
   K8S cluster	Displays the K8S cluster where the Helm release is installed.
   Ingress annotation	Enter the annotation item you want to apply among the Canary annotations provided by nginx-ingress.

   Table. Canary Additional Input Items

Check Canary’s Ingress YAML

Operational Ingress YAML used in Canary, to view the Canary Ingress YAML, follow these steps.

1. On the Deployment Details page, click the View icon for Production Ingress YAML and Canary Ingress YAML. The Ingress YAML popup opens.
2. Ingress YAML Check the contents in the popup window and click the Confirm button to exit.

Managing Canary’s Jenkins Job

View Jenkins Job log

To view the Jenkins Job log, follow these steps.

1. On the Deployment Details page, click the Log button in the Jenkins Job entry for the desired release. The Pipeline Log popup window will open.
2. Pipeline Log After confirming the log in the popup window, click the Confirm button.

Running a Jenkins Job

To run a Jenkins job, follow these steps.

1. On the Deployment Details page, click the Run button in the Jenkins Job entry for the desired release. The Enter Pipeline Execution Parameters popup will open.
2. Pipeline Execution Parameter Input In the popup window, enter or select each item, then click the Confirm button to complete the Jenkins job execution.

Modify Canary

To modify the canary, follow these steps.

1. On the Deployment Details page, click the Edit button. The Canary Edit popup window opens.
2. Canary Edit In the popup window, modify the desired items and click the Save button to complete the edit.

Recover Canary

If the ingress annotation data for the production and canary releases fails to operate correctly due to a Helm release change, restore it so it works properly again.

To restore the canary, follow these steps.

1. On the Deployment Details page, click the Restore button. The Restore popup window opens.
2. In the Recovery popup, click the Confirm button to complete the recovery.

Delete Canary (termination)

To shut down Canary, follow these steps.

1. On the Deployment Details page, click the Terminate button. The Canary Termination popup window opens.
2. Canary termination In the popup window, select the desired item and click the Confirm button to complete the termination.

   item	Explanation
   Canary release	Select Canary Release Rollback Ingress Host: Restores the Ingress host of the Helm release used for the canary to its original value. Delete Helm Release: Deletes the Helm release that was used for the canary.
   Production Release	Select the production release Upgrade to the canary image: Upgrade the production Helm release to the image used in the canary. You can modify the Values.yaml file. No action: End the canary without any changes to the production Helm release.

   Table. Canary termination selection items