Creates a new Release in a given project and location.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: clouddeploy1 --scope <scope> projects locations-delivery-pipelines-releases-create ...

Required Scalar Argument

• <parent> (string)
  • Required. The parent collection in which the Release should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Release:
  abandoned: boolean
  annotations: { string: string }
  condition:
    release-ready-condition:
      status: boolean
    skaffold-supported-condition:
      maintenance-mode-time: string
      skaffold-support-state: string
      status: boolean
      support-expiration-time: string
  create-time: string
  delivery-pipeline-snapshot:
    annotations: { string: string }
    condition:
      pipeline-ready-condition:
        status: boolean
        update-time: string
      targets-present-condition:
        missing-targets: [string]
        status: boolean
        update-time: string
      targets-type-condition:
        error-details: string
        status: boolean
    create-time: string
    description: string
    etag: string
    labels: { string: string }
    name: string
    suspended: boolean
    uid: string
    update-time: string
  deploy-parameters: { string: string }
  description: string
  etag: string
  labels: { string: string }
  name: string
  render-end-time: string
  render-start-time: string
  render-state: string
  skaffold-config-path: string
  skaffold-config-uri: string
  skaffold-version: string
  uid: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . abandoned=false
  • Output only. Indicates whether this is an abandoned release.
• annotations=key=dolore
  • User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
  • the value will be associated with the given key

• condition.release-ready-condition status=false

  • True if the Release is in a valid state. Otherwise at least one condition in ReleaseCondition 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 Release.

• ..skaffold-supported-condition maintenance-mode-time=amet.

  • The time at which this release's version of Skaffold will enter maintenance mode.
• skaffold-support-state=ea
  • The Skaffold support state for this release's version of Skaffold.
• status=false
  • True if the version of Skaffold used by this release is supported.

• support-expiration-time=lorem

  • The time at which this release's version of Skaffold will no longer be supported.

• ... create-time=invidunt

  • Output only. Time at which the Release was created.
• delivery-pipeline-snapshot annotations=key=no
  • User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
  • the value will be associated with the given key
• condition.pipeline-ready-condition status=true
  • 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.

• update-time=sit

  • Last time the condition was updated.

• ..targets-present-condition missing-targets=et

  • The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.
  • Each invocation of this argument appends the given value to the array.
• status=true
  • True if there aren't any missing Targets.

• update-time=aliquyam

  • Last time the condition was updated.

• ..targets-type-condition error-details=ipsum

  • Human readable error message.

• status=true

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

• ... create-time=est

  • Output only. Time at which the pipeline was created.
• description=sed
  • Description of the DeliveryPipeline. Max length is 255 characters.
• etag=diam
  • 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.
• labels=key=dolores
  • 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.
  • the value will be associated with the given key
• name=dolores
  • Optional. Name of the DeliveryPipeline. Format is projects/{project}/locations/{location}/deliveryPipelines/a-z{0,62}.
• suspended=true
  • When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
• uid=sed
  • Output only. Unique identifier of the DeliveryPipeline.

• update-time=no

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

• .. deploy-parameters=key=et

  • Optional. The deploy parameters to use for all targets in this release.
  • the value will be associated with the given key
• description=elitr
  • Description of the Release. Max length is 255 characters.
• etag=sed
  • 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.
• labels=key=no
  • 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.
  • the value will be associated with the given key
• name=nonumy
  • Optional. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/a-z{0,62}.
• render-end-time=at
  • Output only. Time at which the render completed.
• render-start-time=sadipscing
  • Output only. Time at which the render began.
• render-state=aliquyam
  • Output only. Current state of the render operation.
• skaffold-config-path=dolores
  • Filepath of the Skaffold config inside of the config URI.
• skaffold-config-uri=sadipscing
  • Cloud Storage URI of tar.gz archive containing Skaffold configuration.
• skaffold-version=erat
  • The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
• uid=aliquyam
  • Output only. Unique identifier of the Release.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p release-id=string

  • Required. ID of the Release.

• -p request-id=string

  • Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

• -p validate-only=boolean

  • Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").