Overview
This article introduces the basic concepts of Zadig workflows. Zadig workflows support flexible orchestration of workflow processes, custom execution steps, and also possess capabilities such as configuration changes, data changes, and grayscale releases.
# Basic Concepts
Workflows consist of stages and tasks:
- Stage: Logically group the tasks of the workflow, such as the build stage, the deployment stage... Multiple stages run in series, and one stage can include multiple tasks.
- Task: An independent and complete operation, such as building, deploying, testing, custom tasks... Multiple tasks can be executed serially or concurrently. Tasks are divided into two types:
- Custom tasks: Interact with third-party systems through the development of custom tasks. For specific development methods, see Custom Tasks
- Official tasks: Zadig officially provides tasks that can meet complex needs for building, deploying, testing, and releasing. The specific task types are as follows:
| Task Type | Task Name | Description | Configuration |
|---|---|---|---|
| Build | Build | You can directly reference the configuration in the "Project"-"Build" module | Check |
| Deploy | Container Service Deployment | Update service images, variables, and service configurations in Zadig environments | Check |
| Container Service Restart | Restart container services in Zadig environments | Check | |
| Host Service Deployment | Update the host service version in the Zadig environment | Check | |
| K8s Service Deployment | Update container images in Kubernetes | Check | |
| K8s YAML Update | Use native Kubernetes Patch capabilities to update YAML | Check | |
| Service Offline | Delete service-related resources from the specified environment | Check | |
| Verification | Code Scanning | You can directly reference the configuration in the "Project"-"Code Scan" module | Check |
| Test Execution | You can directly reference the test configuration in the "Project"-"Test" module | Check | |
| Process Control | Manual Approval | Follow-up operations can only be performed after approval | Check |
| Send Notification | Send notifications during workflow execution | Check | |
| Release and Rollback | Blue-Green Environment Deployment | Deploy blue-green environments based on the configuration in the "Service" module | Check |
| Blue-Green Release | Combined with the preceding "Blue-Green Environment Deployment", perform blue-green releases | Check | |
| Canary Environment Deployment | Deploy canaries based on Kubernetes native capabilities | Check | |
| Canary Release | Combined with the preceding "Canary Environment Deployment" task, perform canary releases | Check | |
| Grayscale Release | Perform grayscale releases based on Kubernetes native capabilities | Check | |
| Grayscale Rollback | Perform rollback tasks based on Kubernetes native capabilities, rolling back to the state before grayscale | Check | |
| Istio Release | Perform the release process based on Istio | Check | |
| Istio Rollback | Perform rollback tasks based on Istio, rolling back to the state before the Istio release | Check | |
| Istio Grayscale Policy Update | Update the configuration of Istio grayscale policy in the environment | Check | |
| MSE Grayscale Release | Create full-link grayscale publishing resources based on MSE | Check | |
| MSE Grayscale Service Offline | Delete MSE specified grayscale tag-related resources from the environment | Check | |
| Helm Chart Deployment | Directly deploy Charts from the Helm repository to the environment | Check | |
| Agent | AI Release Specialist | Perform AI risk analysis based on change and release context, and output conclusions and recommendations | Check |
| AI Task | Connect to a custom Agent or AI model and automatically execute intelligent tasks based on the prompt | Check | |
| Project Collaboration | Feishu Work Item Status Change | Modify the status of the specified Feishu project work item | Check |
| JIRA Issue Status Change | Modify the status of the specified JIRA issue | Check | |
| PingCode Work Item Status Change | Modify the status of the specified PingCode project work item | Check | |
| Tapd Work Item Status Change | Modify the status of the specified Tapd project work item | Check | |
| Configuration Changes | Nacos Configuration Change | Update the specified Nacos configuration | Check |
| Apollo Configuration Change | Update and publish the specified Apollo configuration | Check | |
| Data Changes | SQL Change Execution | Perform data changes for the specified database | Check |
| DMS Ticket Execution | Select an existing work order on DMS for execution and wait for the result | Check | |
| Gateway Changes | APISIX Gateway Changes | Update the configuration of the specified APISIX gateway | Check |
| Service Monitoring | Grafana Service Monitoring | Use Grafana to monitor whether services are healthy | Check |
| CI/CD Integration | Jenkins Job Execution | Execute multiple Jenkins jobs simultaneously and obtain corresponding logs | Check |
| BlueKing Job Execution | Trigger the execution plan of the BlueKing Job Platform | Check | |
| General Tools | General Script Execution | Support functions such as pulling code, executing shell scripts, file storage, etc. | Check |
| Image Distribution | Push the retagged image to the image repository | Check | |
| Workflow Trigger | Trigger other workflows | Check | |
| Custom Tasks | Custom task implementation, supporting interaction with third-party systems | Check |
# Trigger
Supported trigger types:
| Type | Description | Configuration and Usage |
|---|---|---|
| Git Trigger | Automatically trigger the workflow after code changes | Check |
| Timer | Schedule the workflow to trigger at a specific time | Check |
| JIRA Trigger | Automatically trigger the workflow after JIRA issue status changes | Check |
| Feishu Project Trigger | Automatically trigger the workflow after Feishu project status changes | Check |
| Universal Trigger | Third-party systems can automatically trigger the workflow through webhooks | Check |
# Notification
Workflows support notifications to Feishu, Enterprise WeChat, and DingTalk groups. For specific configuration and usage, see Workflow Notifications
# Workflow View
Organize workflows in different views for quick preview and use.
Enter the project -> workflow, click the View tab to view the workflow information in the current view, and click the + button to create a new view.
- Only system administrators and project administrators can perform
Create View,Edit View, andDelete Viewoperations - The
Allview contains all workflows under the current project and cannot be deleted - After creating a new workflow in a view, the workflow will automatically belong to the current view
