How to pause pipelines for manual approval
The approval step allows you to pause a pipeline and wait for human intervention before going on.
Some example scenarios for using the approval step:
- Pause before deploying to production
- Pause before destroying an environment
- Pause for some manual smoke tests or metric collection
||The free-text display name of the step.||Optional|
||A basic, free-text description of the step.||Optional|
||Parent group of this step. See using stages for more information.||Optional|
||Define a set of conditions that need to be satisfied in order to execute this step. You can find more information in the Conditional Execution of Steps article.||Optional|
Pausing the pipeline
Once the pipeline reaches an approval step it will stop. At this point it does not consume any resources. In the codefresh UI you will see the Approve/Reject buttons.
Once you click any of them the pipeline will continue. Further steps in the pipeline can be enabled/disabled according to the approval result.
Getting the approval result
As also explained in step dependencies all steps in the Codefresh pipeline belong to a global object
steps (indexed by name). You can read the
result property for an approval step to see if it was approved or rejected.
Here is an example:
In this example the second step that is destroying an environment will only run if the user approves the first step. In case of rejection the second step will be skipped.
You can follow the same pattern for running steps when an approval step was rejected. Here is a full example with both cases.
Here is the pipeline state after a rejection:
You can see that only two steps were ignored. If you rerun the pipeline and approve it, the other two steps will be ignored.
If you also enable Slack integration in Codefresh you will have the choice of approving/rejecting a pipeline via a Slack channel
To enable this behavior you need to activate it in the Slack settings page:
Also if you run a pipeline manually that includes an approval step you should check the “Report notification of pipeline execution” checkbox as explained in Monitoring Pipelines.