REST Resource: projects.locations.releases

Resource: Release

A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation via Artifact Registry.

JSON representation
{
  "name": string,
  "unitKind": string,
  "blueprint": {
    object (Blueprint)
  },
  "releaseRequirements": {
    object (ReleaseRequirements)
  },
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "outputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "inputVariableDefaults": [
    {
      object (UnitVariable)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/releases/{release}"

unitKind

string

Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).

blueprint

object (Blueprint)

Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.

releaseRequirements

object (ReleaseRequirements)

Optional. Set of requirements to be fulfilled on the Unit when using this Release.

inputVariables[]

object (UnitVariable)

Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec

outputVariables[]

object (UnitVariable)

Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status

inputVariableDefaults[]

object (UnitVariable)

Optional. Mapping of input variables to default values. Maximum 100

labels

map (key: string, value: string)

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

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

annotations

map (key: string, value: string)

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: https://kubernetes.io/docs/user-guide/annotations

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

uid

string

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

etag

string

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Blueprint

Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (Terraform, for example) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev).

JSON representation
{
  "package": string,
  "engine": string,
  "version": string
}
Fields
package

string

Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set).

engine

string

Output only. Type of the engine used to actuate the blueprint. (Terraform, for example)

version

string

Output only. Version metadata if present on the blueprint.

ReleaseRequirements

Set of requirements to be fulfilled on the Unit when using this Release.

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

string

Optional. A list of releases from which a unit can be upgraded to this one (optional). If left empty no constraints will be applied. When provided, unit upgrade requests to this release will check and enforce this constraint.

Methods

create

Create a new release.

delete

Delete a single release.

get

Retrieve a single release.

list

Retrieve a collection of releases.

patch

Update a single release.