REST Resource: projects.locations.deliveryPipelines.releases

Resource: Release

A Release resource in the Google Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

JSON representation
{
  "name": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "renderStartTime": string,
  "renderEndTime": string,
  "skaffoldConfigUri": string,
  "skaffoldConfigPath": string,
  "buildArtifacts": [
    {
      object (BuildArtifact)
    }
  ],
  "deliveryPipelineSnapshot": {
    object (DeliveryPipeline)
  },
  "targetSnapshots": [
    {
      object (Target)
    }
  ],
  "renderState": enum (RenderState),
  "etag": string,
  "skaffoldVersion": string,
  "targetArtifacts": {
    string: {
      object (TargetArtifact)
    },
    ...
  },
  "targetRenders": {
    string: {
      object (TargetRender)
    },
    ...
  }
}
Fields
name

string

Optional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/[a-z][a-z0-9-]{0,62}.

uid

string

Output only. Unique identifier of the Release.

description

string

Description of the Release. 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 Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

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 Google Cloud Deploy. Labels must meet the following constraints: Each resource is limited to 64 labels. Keys must conform to the regexp: [a-zA-Z][a-zA-Z0-9_-]{0,62}. Values must conform to the regexp: [a-zA-Z0-9_-]{0,63}. Both keys and values are additionally constrained to be <= 128 bytes in size.

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 Release 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".

renderStartTime

string (Timestamp format)

Output only. Time at which the render began.

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".

renderEndTime

string (Timestamp format)

Output only. Time at which the render completed.

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".

skaffoldConfigUri

string

Cloud Storage URI of tar.gz archive containing Skaffold configuration.

skaffoldConfigPath

string

Filepath of the Skaffold config inside of the config URI.

buildArtifacts[]

object (BuildArtifact)

List of artifacts to pass through to Skaffold command.

deliveryPipelineSnapshot

object (DeliveryPipeline)

Output only. Snapshot of the parent pipeline taken at release creation time.

targetSnapshots[]

object (Target)

Output only. Snapshot of the parent pipeline's targets taken at release creation time.

renderState

enum (RenderState)

Output only. Current state of the render operation.

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.

skaffoldVersion

string

The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Google Cloud Deploy supports a specific set of versions.

If unset, the most recent supported Skaffold version will be used.

targetArtifacts

map (key: string, value: object (TargetArtifact))

Output only. Map from target ID to the target artifacts created during the render operation.

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

targetRenders

map (key: string, value: object (TargetRender))

Output only. Map from target ID to details of the render operation for that target.

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

BuildArtifact

Description of an a image to use during Skaffold rendering.

JSON representation
{
  "image": string,
  "tag": string
}
Fields
image

string

Image name in Skaffold configuration.

tag

string

Image tag to use. This will generally be the full path to an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123".

RenderState

Valid states of the render operation.

Enums
RENDER_STATE_UNSPECIFIED The render state is unspecified.
SUCCEEDED All rendering operations have completed successfully.
FAILED All rendering operations have completed, and one or more have failed.
IN_PROGRESS Rendering has started and is not complete.

TargetArtifact

The artifacts produced by a target render operation.

JSON representation
{
  "skaffoldConfigPath": string,
  "manifestPath": string,
  "artifactUri": string
}
Fields
skaffoldConfigPath

string

Output only. File path of the resolved Skaffold configuration relative to the URI.

manifestPath

string

Output only. File path of the rendered manifest relative to the URI.

artifactUri

string

Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.

TargetRender

Details of rendering for a single target.

JSON representation
{
  "renderingBuild": string,
  "renderingState": enum (TargetRenderState)
}
Fields
renderingBuild

string

Output only. The resource name of the Cloud Build Build object that is used to render the manifest for this target. Format is projects/{project}/locations/{location}/builds/{build}.

renderingState

enum (TargetRenderState)

Output only. Current state of the render operation for this Target.

TargetRenderState

Valid states of the render operation.

Enums
TARGET_RENDER_STATE_UNSPECIFIED The render operation state is unspecified.
SUCCEEDED The render operation has completed successfully.
FAILED The render operation has failed.
IN_PROGRESS The render operation is in progress.

Methods

create

Creates a new Release in a given project and location.

get

Gets details of a single Release.

list

Lists Releases in a given project and location.