REST Resource: projects.locations.deliveryPipelines

Resource: DeliveryPipeline

A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

JSON representation 
{
  "name": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "condition": {
    object (PipelineCondition)
  },
  "etag": string,
  "suspended": boolean,

  // Union field pipeline can be only one of the following:
  "serialPipeline": {
    object (SerialPipeline)
  }
  // End of list of possible types for union field pipeline.
}
Fields
name

string

Optional. Name of the DeliveryPipeline. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}. The deliveryPipeline component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
uid

string

Output only. Unique identifier of the DeliveryPipeline.
description

string

Description of the DeliveryPipeline. Max length is 255 characters.
annotations

map (key: string, value: string)

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. Time at which the pipeline was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Most recent time at which the pipeline was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
condition

object (PipelineCondition)

Output only. Information around the state of the Delivery Pipeline.
etag

string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
suspended

boolean

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
Union field pipeline. The ordering configuration of the DeliveryPipeline. pipeline can be only one of the following:
serialPipeline

object (SerialPipeline)

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

SerialPipeline

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

JSON representation 
{
  "stages": [
    {
      object (Stage)
    }
  ]
}
Fields
stages[]

object (Stage)

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

Stage

Stage specifies a location to which to deploy.

JSON representation 
{
  "targetId": string,
  "profiles": [
    string
  ],
  "strategy": {
    object (Strategy)
  },
  "deployParameters": [
    {
      object (DeployParameters)
    }
  ]
}
Fields
targetId

string

The targetId to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.
profiles[]

string

Skaffold profiles to use when rendering the manifest for this stage's Target.
strategy

object (Strategy)

Optional. The strategy to use for a Rollout to this stage.
deployParameters[]

object (DeployParameters)

Optional. The deploy parameters to use for the target in this stage.

Strategy

Strategy contains deployment strategy information.

JSON representation 
{

  // Union field deployment_strategy can be only one of the following:
  "standard": {
    object (Standard)
  },
  "canary": {
    object (Canary)
  }
  // End of list of possible types for union field deployment_strategy.
}
Fields
Union field deployment_strategy. Deployment strategy details. deployment_strategy can be only one of the following:
standard

object (Standard)

Standard deployment strategy executes a single deploy and allows verifying the deployment.
canary

object (Canary)

Canary deployment strategy provides progressive percentage based deployments to a Target.

Standard

Standard represents the standard deployment strategy.

JSON representation 
{
  "verify": boolean,
  "predeploy": {
    object (Predeploy)
  },
  "postdeploy": {
    object (Postdeploy)
  }
}
Fields
verify

boolean

Whether to verify a deployment.
predeploy

object (Predeploy)

Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.
postdeploy

object (Postdeploy)

Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.

Predeploy

Predeploy contains the predeploy job configuration information.

JSON representation 
{
  "actions": [
    string
  ]
}
Fields
actions[]

string

Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.

Postdeploy

Postdeploy contains the postdeploy job configuration information.

JSON representation 
{
  "actions": [
    string
  ]
}
Fields
actions[]

string

Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.

Canary

Canary represents the canary deployment strategy.

JSON representation 
{
  "runtimeConfig": {
    object (RuntimeConfig)
  },

  // Union field mode can be only one of the following:
  "canaryDeployment": {
    object (CanaryDeployment)
  },
  "customCanaryDeployment": {
    object (CustomCanaryDeployment)
  }
  // End of list of possible types for union field mode.
}
Fields
runtimeConfig

object (RuntimeConfig)

Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
Union field mode. The mode to use for the canary deployment strategy. mode can be only one of the following:
canaryDeployment

object (CanaryDeployment)

Configures the progressive based deployment for a Target.
customCanaryDeployment

object (CustomCanaryDeployment)

Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.

RuntimeConfig

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

JSON representation 
{

  // Union field runtime_config can be only one of the following:
  "kubernetes": {
    object (KubernetesConfig)
  },
  "cloudRun": {
    object (CloudRunConfig)
  }
  // End of list of possible types for union field runtime_config.
}
Fields
Union field runtime_config. The runtime configuration details. runtime_config can be only one of the following:
kubernetes

object (KubernetesConfig)

Kubernetes runtime configuration.
cloudRun

object (CloudRunConfig)

Cloud Run runtime configuration.

KubernetesConfig

KubernetesConfig contains the Kubernetes runtime configuration.

JSON representation 
{

  // Union field service_definition can be only one of the following:
  "gatewayServiceMesh": {
    object (GatewayServiceMesh)
  },
  "serviceNetworking": {
    object (ServiceNetworking)
  }
  // End of list of possible types for union field service_definition.
}
Fields
Union field service_definition. The service definition configuration. service_definition can be only one of the following:
gatewayServiceMesh

object (GatewayServiceMesh)

Kubernetes Gateway API service mesh configuration.
serviceNetworking

object (ServiceNetworking)

Kubernetes Service networking configuration.

GatewayServiceMesh

Information about the Kubernetes Gateway API service mesh configuration.

JSON representation 
{
  "httpRoute": string,
  "service": string,
  "deployment": string,
  "routeUpdateWaitTime": string,
  "stableCutbackDuration": string,
  "podSelectorLabel": string,
  "routeDestinations": {
    object (RouteDestinations)
  }
}
Fields
httpRoute

string

Required. Name of the Gateway API HTTPRoute.
service

string

Required. Name of the Kubernetes Service.
deployment

string

Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
routeUpdateWaitTime

string (Duration format)

Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
stableCutbackDuration

string (Duration format)

Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
podSelectorLabel

string

Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
routeDestinations

object (RouteDestinations)

Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.

RouteDestinations

Information about route destinations for the Gateway API service mesh.

JSON representation 
{
  "destinationIds": [
    string
  ],
  "propagateService": boolean
}
Fields
destinationIds[]

string

Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster.
propagateService

boolean

Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.

ServiceNetworking

Information about the Kubernetes Service networking configuration.

JSON representation 
{
  "service": string,
  "deployment": string,
  "disablePodOverprovisioning": boolean,
  "podSelectorLabel": string
}
Fields
service

string

Required. Name of the Kubernetes Service.
deployment

string

Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
disablePodOverprovisioning

boolean

Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.
podSelectorLabel

string

Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.

CloudRunConfig

CloudRunConfig contains the Cloud Run runtime configuration.

JSON representation 
{
  "automaticTrafficControl": boolean,
  "canaryRevisionTags": [
    string
  ],
  "priorRevisionTags": [
    string
  ],
  "stableRevisionTags": [
    string
  ]
}
Fields
automaticTrafficControl

boolean

Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
canaryRevisionTags[]

string

Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
priorRevisionTags[]

string

Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
stableRevisionTags[]

string

Optional. A list of tags that are added to the final stable revision when the stable phase is applied.

CanaryDeployment

CanaryDeployment represents the canary deployment configuration

JSON representation 
{
  "percentages": [
    integer
  ],
  "verify": boolean,
  "predeploy": {
    object (Predeploy)
  },
  "postdeploy": {
    object (Postdeploy)
  }
}
Fields
percentages[]

integer

Required. The percentage based deployments that will occur as a part of a Rollout. List is expected in ascending order and each integer n is 0 <= n < 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
verify

boolean

Whether to run verify tests after each percentage deployment.
predeploy

object (Predeploy)

Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
postdeploy

object (Postdeploy)

Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.

CustomCanaryDeployment

CustomCanaryDeployment represents the custom canary deployment configuration.

JSON representation 
{
  "phaseConfigs": [
    {
      object (PhaseConfig)
    }
  ]
}
Fields
phaseConfigs[]

object (PhaseConfig)

Required. Configuration for each phase in the canary deployment in the order executed.

PhaseConfig

PhaseConfig represents the configuration for a phase in the custom canary deployment.

JSON representation 
{
  "phaseId": string,
  "percentage": integer,
  "profiles": [
    string
  ],
  "verify": boolean,
  "predeploy": {
    object (Predeploy)
  },
  "postdeploy": {
    object (Postdeploy)
  }
}
Fields
phaseId

string

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
percentage

integer

Required. Percentage deployment for the phase.
profiles[]

string

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.
verify

boolean

Whether to run verify tests after the deployment.
predeploy

object (Predeploy)

Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
postdeploy

object (Postdeploy)

Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.

DeployParameters

DeployParameters contains deploy parameters information.

JSON representation 
{
  "values": {
    string: string,
    ...
  },
  "matchTargetLabels": {
    string: string,
    ...
  }
}
Fields
values

map (key: string, value: string)

Required. Values are deploy parameters in key-value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
matchTargetLabels

map (key: string, value: string)

Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PipelineCondition

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

JSON representation 
{
  "pipelineReadyCondition": {
    object (PipelineReadyCondition)
  },
  "targetsPresentCondition": {
    object (TargetsPresentCondition)
  },
  "targetsTypeCondition": {
    object (TargetsTypeCondition)
  }
}
Fields
pipelineReadyCondition

object (PipelineReadyCondition)

Details around the Pipeline's overall status.
targetsPresentCondition

object (TargetsPresentCondition)

Details around targets enumerated in the pipeline.
targetsTypeCondition

object (TargetsTypeCondition)

Details on the whether the targets enumerated in the pipeline are of the same type.

PipelineReadyCondition

PipelineReadyCondition contains information around the status of the Pipeline.

JSON representation 
{
  "status": boolean,
  "updateTime": string
}
Fields
status

boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
updateTime

string (Timestamp format)

Last time the condition was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

TargetsTypeCondition

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

JSON representation 
{
  "status": boolean,
  "errorDetails": string
}
Fields
status

boolean

True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters.
errorDetails

string

Human readable error message.

Methods

create

 Creates a new DeliveryPipeline in a given project and location.

delete

 Deletes a single DeliveryPipeline.

get

 Gets details of a single DeliveryPipeline.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists DeliveryPipelines in a given project and location.

patch

 Updates the parameters of a single DeliveryPipeline.

rollbackTarget

 Creates a Rollout to roll back the specified target.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.