- Resource: Target
- Methods
Resource: Target
A Target
resource in the Cloud Deploy API.
A Target
defines a location to which a Skaffold configuration can be deployed.
JSON representation |
---|
{ "name": string, "targetId": string, "uid": string, "description": string, "annotations": { string: string, ... }, "labels": { string: string, ... }, "requireApproval": boolean, "createTime": string, "updateTime": string, "etag": string, "executionConfigs": [ { object ( |
Fields | |
---|---|
name |
Optional. Name of the |
target |
Output only. Resource id of the |
uid |
Output only. Unique identifier of the |
description |
Optional. Description of the |
annotations |
Optional. 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. An object containing a list of |
labels |
Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:
Both keys and values are additionally constrained to be <= 128 bytes. An object containing a list of |
require |
Optional. Whether or not the |
create |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. Most recent time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
etag |
Optional. 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. |
execution |
Configurations for all execution that relates to this |
deploy |
Optional. The deploy parameters to use for this target. An object containing a list of |
Union field deployment_target . Destination to which the Skaffold configuration is applied during a rollout. deployment_target can be only one of the following: |
|
gke |
Optional. Information specifying a GKE Cluster. |
anthos |
Optional. Information specifying an Anthos Cluster. |
run |
Optional. Information specifying a Cloud Run deployment target. |
multi |
Optional. Information specifying a multiTarget. |
custom |
Optional. Information specifying a Custom Target. |
GkeCluster
Information specifying a GKE Cluster.
JSON representation |
---|
{ "cluster": string, "internalIp": boolean, "proxyUrl": string } |
Fields | |
---|---|
cluster |
Optional. Information specifying a GKE Cluster. Format is |
internal |
Optional. If true, Only specify this option when |
proxy |
Optional. If set, used to configure a proxy to the Kubernetes server. |
AnthosCluster
Information specifying an Anthos Cluster.
JSON representation |
---|
{ "membership": string } |
Fields | |
---|---|
membership |
Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is |
CloudRunLocation
Information specifying where to deploy a Cloud Run Service.
JSON representation |
---|
{ "location": string } |
Fields | |
---|---|
location |
Required. The location for the Cloud Run Service. Format must be |
MultiTarget
Information specifying a multiTarget.
JSON representation |
---|
{ "targetIds": [ string ] } |
Fields | |
---|---|
target |
Required. The targetIds of this multiTarget. |
CustomTarget
Information specifying a Custom Target.
JSON representation |
---|
{ "customTargetType": string } |
Fields | |
---|---|
custom |
Required. The name of the CustomTargetType. Format must be |
ExecutionConfig
Configuration of the environment to use when calling Skaffold.
JSON representation |
---|
{ "usages": [ enum ( |
Fields | |
---|---|
usages[] |
Required. Usages when this configuration should be applied. |
worker |
Optional. The resource name of the |
service |
Optional. Google service account to use for execution. If unspecified, the project execution service account ( |
artifact |
Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used. |
execution |
Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used. A duration in seconds with up to nine fractional digits, ending with ' |
verbose |
Optional. If true, additional logging will be enabled when running builds in this execution environment. |
Union field execution_environment . Details of the environment. execution_environment can be only one of the following: |
|
default |
Optional. Use default Cloud Build pool. |
private |
Optional. Use private Cloud Build pool. |
ExecutionEnvironmentUsage
Possible usages of this configuration.
Enums | |
---|---|
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED |
Default value. This value is unused. |
RENDER |
Use for rendering. |
DEPLOY |
Use for deploying and deployment hooks. |
VERIFY |
Use for deployment verification. |
PREDEPLOY |
Use for predeploy job execution. |
POSTDEPLOY |
Use for postdeploy job execution. |
DefaultPool
Execution using the default Cloud Build pool.
JSON representation |
---|
{ "serviceAccount": string, "artifactStorage": string } |
Fields | |
---|---|
service |
Optional. Google service account to use for execution. If unspecified, the project execution service account ( |
artifact |
Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used. |
PrivatePool
Execution using a private Cloud Build pool.
JSON representation |
---|
{ "workerPool": string, "serviceAccount": string, "artifactStorage": string } |
Fields | |
---|---|
worker |
Required. Resource name of the Cloud Build worker pool to use. The format is |
service |
Optional. Google service account to use for execution. If unspecified, the project execution service account ( |
artifact |
Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used. |
Methods |
|
---|---|
|
Creates a new Target in a given project and location. |
|
Deletes a single Target. |
|
Gets details of a single Target. |
|
Gets the access control policy for a resource. |
|
Lists Targets in a given project and location. |
|
Updates the parameters of a single Target. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |