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:
- Click the Project card on the Main page to go to the Project Dashboard page.
- Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
Item Description Name Displays the canary name. Click to view detailed information. Cluster Displays the deployed cluster. (Operation) Displays the currently operating Helm release. (Canary) Displays the canary Helm release. Terminate Terminates the canary. Table. Kubernetes Deployment Screen Canary Card Items - 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:
Canary is supported in the following environments. Check before adding a canary.
Kubernetesv1.17or highernginx-ingressv0.29.0or higher
- Click the Project card on the Main page to go to the Project Dashboard page.
- Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
- Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup window opens.
- Enter information in the Add Canary popup window and click the Save button to complete adding the canary.
| Item | Description |
|---|---|
| Classification | Select development or operation.
|
| Canary Name | Enter the canary name. |
| Operation |
|
| Canary |
|
| K8S Cluster | Displays the K8S cluster where the Helm release is installed. |
| Ingress Annotation | Enter the annotation item you want to apply from the canary annotation provided by nginx-ingress. |
Checking Ingress YAML of Canary
To check the operating Ingress YAML and canary Ingress YAML used by the canary, follow these steps:
- Click the View icon for Operating Ingress YAML or Canary Ingress YAML on the Deployment Details page. The Ingress YAML popup window opens.
- 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:
- Click the Log button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Log popup window opens.
- 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:
- 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.
- 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:
- Click the Modify button on the Deployment Details page. The Modify Canary popup window opens.
- 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:
- Click the Recover button on the Deployment Details page. The Recover popup window opens.
- Click the OK button in the Recover popup window to complete the recovery.
Terminating (Deleting) Canary
To terminate a canary, follow these steps:
- Click the Terminate button on the Deployment Details page. The Terminate Canary popup window opens.
- Select the desired items in the Terminate Canary popup window and click the OK button to complete the termination.
Item | Description |
|---|---|
| Canary Release | Select the canary release
|
| Operation Release | Select the operation release
|