The delivery pipeline configuration file can include
target definitions, or those can be in a separate file or
files. By convention, a file containing both the delivery pipeline config and
the target configs is called
clouddeploy.yaml, and a pipeline config without
targets is called
delivery-pipeline.yaml. But you can give these files any
name you want.
What goes where
Google Cloud Deploy uses two main configuration files:
- Delivery pipeline definition
- Target definition
These can be separate files, or the delivery pipeline and targets can be configured in the same file.
Structure of a delivery pipeline configuration file
The following configuration includes a target definition:
apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: annotations: labels: description: serialPipeline: stages: - targetId: profiles:  - targetId: profiles:  --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: annotations: labels: description: requireApproval: gke: cluster: projects/[project_name]/locations/[location]/clusters/[cluster_name] internalIp: executionConfigs: - usages: - [RENDER | DEPLOY] workerPool: serviceAccount: artifactStorage: executionTimeout: ---
This YAML has two main components:
The main delivery pipeline and progression
The configuration file can include any number of pipeline definitions.
The target definitions
For simplicity, only one target is shown in this example, but there can be any number of them. Also, targets can be defined in a separate file or files.
These components are defined in the rest of this document.
Pipeline definition and progression
In addition to pipeline metadata, such as
name, the main pipeline definition
includes a list of references to targets in
deployment sequence order. That is, the first target listed is the first
deployment target. After you've deployed to that target, promoting the release
deploys to the next target in the list.
The following are the configuration properties for a delivery pipeline, not including target definitions.
name field takes a string that must be unique per project and location.
Delivery pipeline configuration can include annotations and labels. Annotations and labels are stored with the delivery pipeline resource after the pipeline has been registered.
For more information, see Using labels and annotations with Google Cloud Deploy.
An arbitrary string describing this delivery pipeline. This description is shown in the delivery pipeline details in Google Cloud console.
A list of all targets to which this delivery pipeline is configured to deploy.
The list must be in the order of the delivery sequence you want. For example,
if you have targets called
production, list them in that
same order, so that your first deployment is to
dev, and your final deployment
stages.targetId field with the value of the
field in the corresponding target definition. And under
serialPipeline: stages: - targetId: profiles: 
Identifies the specific target to use for this stage of the delivery pipeline.
The value is the
metadata.name property from the target definition.
Takes a list of zero or more Skaffold profile names, from
Google Cloud Deploy uses the profile with
when creating the release. Skaffold profiles let you vary configuration between
targets while using a single configuration file.
The delivery pipeline definition file can contain target definitions, or you can specify targets in a separate file. You can repeat Target names within a project, but they must be unique within a delivery pipeline.
You can reuse targets among multiple delivery pipelines. However, you can only reference a target once from within a single delivery pipeline's progression.
For GKE targets
The following YAML shows how to configure a target that deploys to a GKE cluster:
apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: annotations: labels: description: requireApproval: gke: cluster: projects/[project_name]/locations/[location]/clusters/[cluster_name] internalIp: executionConfigs: - usages: - [RENDER | DEPLOY] workerPool: serviceAccount: artifactStorage: executionTimeout:
The name of this target. This name must be globally unique.
Annotations and labels are stored with the target resource. For more information, see Using labels and annotations with Google Cloud Deploy.
This field takes an arbitrary string that describes the use of this target.
Whether promotion to this target requires manual approval. Can be
This property is optional. The default is
For GKE clusters only, the resource path identifying the cluster where your application will be deployed:
gke: cluster: projects/[project_name]/locations/[location]/clusters/[cluster_name]
The Google Cloud project in which the cluster lives.
The location where the cluster lives. For example,
us-central1. The cluster can also be zonal (
The name of the cluster, as it appears in your list of clusters in Google Cloud console.
Here's an example:
gke: cluster: projects/cd-demo-01/locations/us-central1/clusters/prod
executionConfigs, in this article, for descriptions
of the execution environment properties.
Whether or not the specified GKE cluster uses a private
IP address. This property is optional. By default, Google Cloud Deploy uses
the publicly available IP address for the cluster. If there's a private IP
address and you want to use it, set this to
For Anthos targets
Target configuration for deploying to an Anthos cluster is the similar to
configuring a target for a GKE target,
except that the property is
anthosCluster.membership, instead of
the resource path is different, and
internalIp is not applicable.
anthosCluster: membership: projects/[project_name]/locations/global/memberships/[membership_name]
The Google Cloud project in which the Anthos cluster lives.
The location where the cluster is registered.
global, in all cases.
The name of the Anthos cluster membership.
Here's an example:
anthosCluster: membership: projects/cd-demo-01/locations/global/memberships/prod
For more information about deploying to Anthos clusters, see Deploying to Anthos user clusters.
A set of fields to specify a non-default execution environment for this target.
DEPLOYor both, indicating which of those operations to perform for this target using this execution environment. To indicate that a custom execution environment is to be used for both rendering and deployment, you would configure it as follows:
usages: - RENDER - DEPLOY
Configuration for the worker pool to use. This takes a resource path identifying the Cloud Build worker pool to use for this target. For example:
To use the default Cloud Build pool, omit this property.
A given target can have two
workerPools (one for
RENDERand one for
DEPLOY). When configuring the default pool, you can specify an alternate service account or storage location or both.
The name of the service account to use for this operation (
DEPLOY) for this target.
The Cloud Storage bucket to use for this operation (
DEPLOY) for this target, instead of the default bucket.
Optional. Sets the timeout, in seconds, for operations that Cloud Build performs for Google Cloud Deploy. By default this is
3600seconds (1 hour).
Alternative supported syntax
executionConfigs configuration described in this document is new. The
previous syntax is still supported:
executionConfigs: - privatePool: workerPool: serviceAccount: artifactStorage: usages: - [RENDER | DEPLOY] - defaultPool: serviceAccount: artifactStorage: usages: - [RENDER | DEPLOY]
Find out more about how Google Cloud Deploy works.
Learn how to set up a delivery pipeline for your application.
Learn how to manage your manifests.
Avoid mismatches between your release and your delivery pipeline by learning about pipeline instances.