Pipeline
- Erick Jones
- Chandresh Patel
- Karl Henselin
A pipeline is a workflow which orchestrates the delivery of snapshots across the stages/environments. While a deploy workflow defines the implementation for the delivery of a single build artifact into an environment, the pipeline operates at a higher level, and orchestrates the propagation of many deployments across many stages/environments. The pipeline includes facilities for approvals, manual tasks, scheduling, deployments, and much more.
See Creating/Editing a Pipeline Version to manage pipeline details.
A sample pipeline definition with three stages, see Example Pipeline for additional example.
The pipeline above has three stages, Development, QA, and Production. The Development stage does not have any gates, which means the steps begin execution immediately. The "Deploy All Projects" step deploys all of the project versions in a snapshot into the Development environment, which utilizes the deploy workflows of the underlying projects to facilitate this work. The QA stage has three gates. The "Dev Quality Check" gate verifies that tests for the projects in the snapshot in Development meet the configured qualifier metrics. If the qualifier metrics did not pass then the gate fails, otherwise, the gate completes and it transitions to the next gate. The "QA Manager Approval" gate creates an approval task for the QA Manager group and blocks execution until approved. Once approved, the "Every Day at Noon" scheduled gate blocks execution until 12pm. When the schedule is reached, the "Deploy All Projects" step for QA is executed. When the deployment is complete, the pipeline execution transitions to the Production stage and executes its gates and steps (similar to QA).
In a typical release, most of the snapshots will not make it very far through the pipeline. The approval gates are either rejected, or the snapshot is simply "out dated" by a newer one. Depending on the size and complexity of a release, there may be dozens or even hundreds of iterations in the lower stages before the first snapshot is promoted to the later stages. In fact, it is possible that only one snapshot for the release ultimately makes its way all the way to production. At such time, the release may be ended, and a new one is created. However, if desired, the same release can be used to deliver additional fixes or updates.
Gate Types
Type | Description |
|---|---|
Creates an approval task for the defined group, and blocks transition until the task is approved. If the task is rejected, the stage execution is marked as failed, and execution is terminated. | |
| External Approval | Creates an approval task tied to an external system (e.g. ServiceNow), and blocks transition until the task is approved. If the task is rejected, the stage execution is marked as failed, and execution is terminated. |
Blocks transition until the defined schedule is reached, or overridden by a user with appropriate privileges. | |
Evaluates the test qualifiers for any tests which were executed for the same snapshot in the configured environment. The gate is successful if the qualifiers determine success, or fails otherwise. | |
| Custom Gate | Executes custom groovy based implementation of gate. |
Step Types
Type | Description |
|---|---|
| Deploys a single project version from the snapshot to the current stage. | |
| Deploys all project versions from the snapshot to the current stage, using the deploy priorities configured on the release. | |
| Executes tests in the current stage for a single project, according to the defined strategy (on the project). | |
| Executes tests in the current stage for all projects in the snapshot, according to the defined strategy (on the projects). | |
| Custom Step | Executes custom groovy based implementation of step. |
| Utility | Executes a single utility workflow in the current stage. |
| Execute All Utility | Executes all utility projects in the release for the current stage according to the deploy priorities. |
| Notification | Sends an email to provided email address, FlexDeploy User, or FlexDeploy Group. |
| Group | A container for other steps to be executed serially. Useful to execute the entire group in parallel to another step or group. |
| Wait | Halts execution for a configured number of seconds, or until a particular date and time. |
| Manual | Halts execution waiting for the task to be marked complete by a user in the defined group. |
| Schedule | Halts execution until the date/time evaluated by the given cron expression is reached. |
| Execute All | Deploys all projects versions in the snapshot and executes all utility workflows defined in the release, using the configured deploy priorities. |
Related content
- style