Suspend a delivery pipeline

This page describes how to suspend a Cloud Deploy delivery pipeline.

You can suspend a delivery pipeline. Suspending a pipeline means that it can no longer be used for the following:

  • Create a release

  • Promote a release

  • Roll back a release

  • Redeploy a release

  • Approve or reject a rollout

Here are some possible reasons for suspending a delivery pipeline:

  • There's a problem with a release and you want to prevent further action on that pipeline until the problem is found.

  • Your organization observes a holiday freeze, for example during peak holiday shopping season.

To suspend a delivery pipeline:

  1. In the delivery pipeline configuration file, include the following property:

    suspended: true
    

    This property goes at the top level, as shown:

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
     Name: my-app
    description: main application pipeline
    suspended: true
    serialPipeline:
     stages:
       - targetId: dev
         profiles: []
       - targetId: staging
         profiles: []
       - targetId: prod
         profiles: []
    
  2. Register the delivery pipeline:

    gcloud deploy apply