Resource: CustomTargetType
A CustomTargetType
resource in the Cloud Deploy API.
A CustomTargetType
defines a type of custom target that can be referenced in a Target
in order to facilitate deploying to other systems besides the supported runtimes.
JSON representation |
---|
{ "name": string, "customTargetTypeId": string, "uid": string, "description": string, "annotations": { string: string, ... }, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "etag": string, // Union field |
Fields | |
---|---|
name |
Optional. Name of the |
customTargetTypeId |
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 |
createTime |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
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. |
Union field definition . Defines the CustomTargetType renderer and deployer. definition can be only one of the following: |
|
customActions |
Configures render and deploy for the |
CustomTargetSkaffoldActions
CustomTargetSkaffoldActions represents the CustomTargetType
configuration using Skaffold custom actions.
JSON representation |
---|
{
"renderAction": string,
"deployAction": string,
"includeSkaffoldModules": [
{
object ( |
Fields | |
---|---|
renderAction |
Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via |
deployAction |
Required. The Skaffold custom action responsible for deploy operations. |
includeSkaffoldModules[] |
Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose. |
SkaffoldModules
Skaffold Config modules and their remote source.
JSON representation |
---|
{ "configs": [ string ], // Union field |
Fields | |
---|---|
configs[] |
Optional. The Skaffold Config modules to use from the specified source. |
Union field source . The source that contains the Skaffold Config modules. source can be only one of the following: |
|
git |
Remote git repository containing the Skaffold Config modules. |
googleCloudStorage |
Cloud Storage bucket containing the Skaffold Config modules. |
googleCloudBuildRepo |
Cloud Build V2 repository containing the Skaffold Config modules. |
SkaffoldGitSource
Git repository containing Skaffold Config modules.
JSON representation |
---|
{ "repo": string, "path": string, "ref": string } |
Fields | |
---|---|
repo |
Required. Git repository the package should be cloned from. |
path |
Optional. Relative path from the repository root to the Skaffold file. |
ref |
Optional. Git branch or tag to use when cloning the repository. |
SkaffoldGCSSource
Cloud Storage bucket containing Skaffold Config modules.
JSON representation |
---|
{ "source": string, "path": string } |
Fields | |
---|---|
source |
Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket". |
path |
Optional. Relative path from the source to the Skaffold file. |
SkaffoldGCBRepoSource
Cloud Build V2 Repository containing Skaffold Configs.
JSON representation |
---|
{ "repository": string, "path": string, "ref": string } |
Fields | |
---|---|
repository |
Required. Name of the Cloud Build V2 Repository. Format is projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}. |
path |
Optional. Relative path from the repository root to the Skaffold Config file. |
ref |
Optional. Branch or tag to use when cloning the repository. |
Methods |
|
---|---|
|
Creates a new CustomTargetType in a given project and location. |
|
Deletes a single CustomTargetType. |
|
Gets details of a single CustomTargetType. |
|
Gets the access control policy for a resource. |
|
Lists CustomTargetTypes in a given project and location. |
|
Updates a single CustomTargetType. |
|
Sets the access control policy on the specified resource. |