Canceling a Pipeline Run
Follow these steps to cancel a pipeline run.
Graceful Pipeline Termination
Pipelines enhance the cancel run method by introducing an optional parameter,
terminateGracefully.
You can stop a pipeline run from any step without triggering errors or failures. Both the step and pipeline runs conclude in the 'succeeded' state. This functionality proves useful when a step logic identifies the next step as unnecessary or invalid, prompting the ending of the pipeline run. For example, if a transformation step detects insufficient or poor-quality data, the pipeline run can be stopped before proceeding to model training and deployment.
This starts custom logic within a pipeline run to halt execution and flag the run as
SUCCEEDED. This distinction is crucial for monitoring purposes, enabling
the differentiation between willingly ended runs and those canceled by the service, for
example, because of resource limitations.
- From the pipelines page, select a pipeline to delete. If you need help finding the list of pipelines, see Listing Pipelines.
- On the pipeline run details page, select Cancel.
- Select Terminate gracefully.
- Select Confirm.
Use the PipelineRun Cancel command and required parameters to gracefully stop a job:
oci data-science pipeline-run cancel --pipeline-run-id ocid1.datasciencepipelinerun.oc1.iad.amaaaaaay75uckqaqz3wv77m72wlfp6hzw7la22mzaysgz77j5vyynyqdwga --terminate-gracefully true ... [OPTIONS]For a complete list of parameters and values for CLI commands, see the CLI Command Reference.
- Run the CancelPipelineRun operation with the
terminateGracefullyparameter to stop the run gracefully. For example:/pipelineRuns/<pipeline-run-ocid>/actions/cancelPipelineRun?terminateGracefully=true