CloudBuildTrigger
Property | Value |
---|---|
Google Cloud Service Name | Cloud Build |
Google Cloud Service Documentation | /cloud-build/docs/ |
Google Cloud REST Resource Name | v1.projects.triggers |
Google Cloud REST Resource Documentation | /cloud-build/docs/reference/rest/v1/projects.triggers |
Config Connector Resource Short Names | gcpcloudbuildtrigger gcpcloudbuildtriggers cloudbuildtrigger |
Config Connector Service Name | cloudbuild.googleapis.com |
Config Connector Resource Fully Qualified Name | cloudbuildtriggers.cloudbuild.cnrm.cloud.google.com |
Can Be Referenced by IAMPolicy/IAMPolicyMember | No |
Config Connector Default Average Reconcile Interval In Seconds | 600 |
Custom Resource Definition Properties
Annotations
Fields | |
---|---|
cnrm.cloud.google.com/project-id |
Spec
Schema
approvalConfig:
approvalRequired: boolean
bitbucketServerTriggerConfig:
bitbucketServerConfigResourceRef:
external: string
name: string
namespace: string
projectKey: string
pullRequest:
branch: string
commentControl: string
invertRegex: boolean
push:
branch: string
invertRegex: boolean
tag: string
repoSlug: string
build:
artifacts:
images:
- string
objects:
location: string
paths:
- string
timing:
- endTime: string
startTime: string
availableSecrets:
secretManager:
- env: string
versionRef:
external: string
name: string
namespace: string
images:
- string
logsBucketRef:
external: string
name: string
namespace: string
options:
diskSizeGb: integer
dynamicSubstitutions: boolean
env:
- string
logStreamingOption: string
logging: string
machineType: string
requestedVerifyOption: string
secretEnv:
- string
sourceProvenanceHash:
- string
substitutionOption: string
volumes:
- name: string
path: string
workerPool: string
queueTtl: string
secret:
- kmsKeyRef:
external: string
name: string
namespace: string
secretEnv:
string: string
source:
repoSource:
branchName: string
commitSha: string
dir: string
invertRegex: boolean
projectId: string
repoRef:
external: string
name: string
namespace: string
substitutions:
string: string
tagName: string
storageSource:
bucketRef:
external: string
name: string
namespace: string
generation: string
object: string
step:
- allowExitCodes:
- integer
allowFailure: boolean
args:
- string
dir: string
entrypoint: string
env:
- string
id: string
name: string
script: string
secretEnv:
- string
timeout: string
timing: string
volumes:
- name: string
path: string
waitFor:
- string
substitutions:
string: string
tags:
- string
timeout: string
description: string
disabled: boolean
filename: string
filter: string
gitFileSource:
bitbucketServerConfigRef:
external: string
name: string
namespace: string
githubEnterpriseConfigRef:
external: string
name: string
namespace: string
path: string
repoType: string
repositoryRef:
external: string
name: string
namespace: string
revision: string
uri: string
github:
enterpriseConfigResourceNameRef:
external: string
name: string
namespace: string
name: string
owner: string
pullRequest:
branch: string
commentControl: string
invertRegex: boolean
push:
branch: string
invertRegex: boolean
tag: string
ignoredFiles:
- string
includeBuildLogs: string
includedFiles:
- string
location: string
pubsubConfig:
serviceAccountRef:
external: string
name: string
namespace: string
state: string
subscription: string
topicRef:
external: string
name: string
namespace: string
repositoryEventConfig:
pullRequest:
branch: string
commentControl: string
invertRegex: boolean
push:
branch: string
invertRegex: boolean
tag: string
repository: string
serviceAccountRef:
external: string
name: string
namespace: string
sourceToBuild:
bitbucketServerConfigRef:
external: string
name: string
namespace: string
githubEnterpriseConfigRef:
external: string
name: string
namespace: string
ref: string
repoType: string
repositoryRef:
external: string
name: string
namespace: string
uri: string
substitutions:
string: string
tags:
- string
triggerTemplate:
branchName: string
commitSha: string
dir: string
invertRegex: boolean
repoRef:
external: string
name: string
namespace: string
tagName: string
webhookConfig:
secretRef:
external: string
name: string
namespace: string
state: string
Fields | |
---|---|
Optional |
Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. |
Optional |
Whether or not approval is needed. If this is set on a build, it will become pending when run, and will need to be explicitly approved to start. |
Optional |
BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. |
Required* |
Only `external` field is supported to configure the reference. The full resource name of the bitbucket server config. Format: projects/{project}/locations/{location}/bitbucketServerConfigs/{id}. |
Optional |
Allowed value: The `name` field of a `CloudBuildBitbucketServerConfig` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Required* |
Key of the project that the repo is in. For example: The key for https://mybitbucket.server/projects/TEST/repos/test-repo is "TEST". |
Optional |
Filter to match changes in pull requests. |
Required* |
Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
Optional |
Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values: ["COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"]. |
Optional |
If true, branches that do NOT match the git_ref will trigger a build. |
Optional |
Filter to match changes in refs like branches, tags. |
Optional |
Regex of branches to match. Specify only one of branch or tag. |
Optional |
When true, only trigger a build if the revision regex does NOT match the gitRef regex. |
Optional |
Regex of tags to match. Specify only one of branch or tag. |
Required* |
Slug of the repository. A repository slug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL. For example, if the repository name is 'test repo', in the URL it would become 'test-repo' as in https://mybitbucket.server/projects/TEST/repos/test-repo. |
Optional |
Contents of the build template. Either a filename or build template must be provided. |
Optional |
Artifacts produced by the build that should be uploaded upon successful completion of all build steps. |
Optional |
A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. |
Optional |
|
Optional |
A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. |
Optional |
Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. |
Optional |
Path globs used to match files in the build's workspace. |
Optional |
|
Optional |
Output only. Stores timing information for pushing all artifact objects. |
Optional |
|
Optional |
End of time span. 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". |
Optional |
Start of time span. 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". |
Optional |
Secrets and secret environment variables. |
Required* |
Pairs a secret environment variable with a SecretVersion in Secret Manager. |
Required* |
|
Required* |
Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. |
Required* |
|
Optional |
Allowed value: The `name` field of a `SecretManagerSecretVersion` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE. |
Optional |
|
Optional |
Google Cloud Storage bucket where logs should be written. Logs file names will be of the format ${logsBucket}/log-${build_id}.txt. |
Optional |
Allowed value: The `url` field of a `StorageBucket` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Special options for this build. |
Optional |
Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. |
Optional |
Option to specify whether or not to apply bash style string operations to the substitutions. NOTE this is always enabled for triggered builds and cannot be overridden in the build configuration file. |
Optional |
A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
Optional |
|
Optional |
Option to define build log streaming behavior to Google Cloud Storage. Possible values: ["STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF"]. |
Optional |
Option to specify the logging mode, which determines if and where build logs are stored. Possible values: ["LOGGING_UNSPECIFIED", "LEGACY", "GCS_ONLY", "STACKDRIVER_ONLY", "CLOUD_LOGGING_ONLY", "NONE"]. |
Optional |
Compute Engine machine type on which to run the build. |
Optional |
Requested verifiability options. Possible values: ["NOT_VERIFIED", "VERIFIED"]. |
Optional |
A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build. |
Optional |
|
Optional |
Requested hash for SourceProvenance. Possible values: ["NONE", "SHA256", "MD5"]. |
Optional |
|
Optional |
Option to specify behavior when there is an error in the substitution checks. NOTE this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. Possible values: ["MUST_MATCH", "ALLOW_LOOSE"]. |
Optional |
Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. |
Optional |
|
Optional |
Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
Optional |
Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
Optional |
Option to specify a WorkerPool for the build. Format projects/{project}/workerPools/{workerPool} This field is experimental. |
Optional |
TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from createTime. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". |
Optional |
Secrets to decrypt using Cloud Key Management Service. |
Optional |
|
Required* |
KMS crypto key to use to decrypt these envs. |
Optional |
Allowed value: The `selfLink` field of a `KMSCryptoKey` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. |
Optional |
The location of the source files to build. One of 'storageSource' or 'repoSource' must be provided. |
Optional |
Location of the source in a Google Cloud Source Repository. |
Optional |
Regex matching branches to build. Exactly one a of branch name, tag, or commit SHA must be provided. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
Optional |
Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided. |
Optional |
Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution. |
Optional |
Only trigger a build if the revision regex does NOT match the revision regex. |
Optional |
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
Required* |
The desired Cloud Source Repository. If omitted, "default" is assumed. |
Optional |
Allowed value: The `name` field of a `SourceRepoRepository` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Substitutions to use in a triggered build. Should only be used with triggers.run. |
Optional |
Regex matching tags to build. Exactly one a of branch name, tag, or commit SHA must be provided. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
Optional |
Location of the source in an archive file in Google Cloud Storage. |
Required* |
Google Cloud Storage bucket containing the source. |
Optional |
Allowed value: The `name` field of a `StorageBucket` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
Required* |
Google Cloud Storage object containing the source. This object must be a gzipped archive file (.tar.gz) containing source to build. |
Required* |
The operations to be performed on the workspace. |
Required* |
|
Optional |
Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If 'allowFailure' is also specified, this field will take precedence. |
Optional |
|
Optional |
Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the 'failureDetail' field. 'allowExitCodes' takes precedence over this field. |
Optional |
A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. |
Optional |
|
Optional |
Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a 'volume' for that path is specified. If the build specifies a 'RepoSource' with 'dir' and a step with a 'dir', which specifies an absolute path, the 'RepoSource' 'dir' is ignored for the step's execution. |
Optional |
Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. |
Optional |
A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
Optional |
|
Optional |
Unique identifier for this build step, used in 'wait_for' to reference this build step as a dependency. |
Required* |
The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders for images and examples). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. |
Optional |
A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. |
Optional |
A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's 'Secret'. |
Optional |
|
Optional |
Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. |
Optional |
Output only. Stores timing information for executing this build step. |
Optional |
List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. |
Optional |
|
Required* |
Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
Required* |
Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
Optional |
The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in 'wait_for' have completed successfully. If 'wait_for' is empty, this build step will start when all previous build steps in the 'Build.Steps' list have completed successfully. |
Optional |
|
Optional |
Substitutions data for Build resource. |
Optional |
Tags for annotation of a Build. These are not docker tags. |
Optional |
|
Optional |
Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT. This timeout must be equal to or greater than the sum of the timeouts for build steps within the build. The expected format is the number of seconds followed by s. Default time is ten minutes (600s). |
Optional |
Human-readable description of the trigger. |
Optional |
Whether the trigger is disabled or not. If true, the trigger will never result in a build. |
Optional |
Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided. Set this only when using trigger_template or github. When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. |
Optional |
A Common Expression Language string. Used only with Pub/Sub and Webhook. |
Optional |
The file source describing the local or remote Build template. |
Optional |
Only `external` field is supported to configure the reference. The full resource name of the bitbucket server config. Format: projects/{project}/locations/{location}/bitbucketServerConfigs/{id}. |
Optional |
Allowed value: The `name` field of a `CloudBuildBitbucketServerConfig` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Only `external` field is supported to configure the reference. The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. |
Optional |
Allowed value: The `name` field of a `CloudBuildGithubEnterpriseConfig` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Required* |
The path of the file, with the repo root as the root of the path. |
Required* |
The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER"]. |
Optional |
Only `external` field is supported to configure the reference. The fully qualified resource name of the Repo API repository. The fully qualified resource name of the Repo API repository. If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path. |
Optional |
Allowed value: The `name` field of a `CloudBuildV2Repository` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path. |
Optional |
The URI of the repo (optional). If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path. |
Optional |
Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of 'trigger_template', 'github', 'pubsub_config' or 'webhook_config' must be provided. |
Optional |
Only `external` field is supported to configure the reference. The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. |
Optional |
Allowed value: The `name` field of a `CloudBuildGithubEnterpriseConfig` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
Optional |
Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
Optional |
filter to match changes in pull requests. Specify only one of 'pull_request' or 'push'. |
Required* |
Regex of branches to match. |
Optional |
Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator. Possible values: ["COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"]. |
Optional |
If true, branches that do NOT match the git_ref will trigger a build. |
Optional |
filter to match changes in refs, like branches or tags. Specify only one of 'pull_request' or 'push'. |
Optional |
Regex of branches to match. Specify only one of branch or tag. |
Optional |
When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
Optional |
Regex of tags to match. Specify only one of branch or tag. |
Optional |
ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for '**'. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build. |
Optional |
|
Optional |
Build logs will be sent back to GitHub as part of the checkrun result. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or INCLUDE_BUILD_LOGS_WITH_STATUS Possible values: ["INCLUDE_BUILD_LOGS_UNSPECIFIED", "INCLUDE_BUILD_LOGS_WITH_STATUS"]. |
Optional |
ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for '**'. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build. |
Optional |
|
Optional |
Immutable. The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger. If not specified, "global" is used. |
Optional |
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. |
Optional |
Service account that will make the push request. |
Optional |
Allowed value: The `email` field of an `IAMServiceAccount` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. |
Optional |
Output only. Name of the subscription. |
Required* |
The name of the topic from which this subscription is receiving messages. |
Optional |
Allowed value: string of the format `projects/{{project}}/topics/{{value}}`, where {{value}} is the `name` field of a `PubSubTopic` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
The configuration of a trigger that creates a build whenever an event from Repo API is received. |
Optional |
Contains filter properties for matching Pull Requests. |
Optional |
Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
Optional |
Configure builds to run whether a repository owner or collaborator need to comment '/gcbrun'. Possible values: ["COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"]. |
Optional |
If true, branches that do NOT match the git_ref will trigger a build. |
Optional |
Contains filter properties for matching git pushes. |
Optional |
Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
Optional |
If true, only trigger a build if the revision regex does NOT match the git_ref regex. |
Optional |
Regex of tags to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax. |
Optional |
The resource name of the Repo API resource. |
Optional |
The service account used for all user-controlled operations including triggers.patch, triggers.run, builds.create, and builds.cancel. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. When populating via the external field, the following format is supported: projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL} |
Optional |
Allowed value: string of the format `projects/{{project}}/serviceAccounts/{{value}}`, where {{value}} is the `email` field of an `IAMServiceAccount` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. |
Optional |
Only `external` field is supported to configure the reference. The full resource name of the bitbucket server config. Format: projects/{project}/locations/{location}/bitbucketServerConfigs/{id}. |
Optional |
Allowed value: The `name` field of a `CloudBuildBitbucketServerConfig` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Only `external` field is supported to configure the reference. The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. |
Optional |
Allowed value: The `name` field of a `CloudBuildGithubEnterpriseConfig` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Required* |
The branch or tag to use. Must start with "refs/" (required). |
Required* |
The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER"]. |
Optional |
Only `external` field is supported to configure the reference. The qualified resource name of the Repo API repository. Either uri or repository can be specified and is required. |
Optional |
Allowed value: The `name` field of a `CloudBuildV2Repository` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
The URI of the repo. |
Optional |
Substitutions data for Build resource. |
Optional |
Tags for annotation of a BuildTrigger. |
Optional |
|
Optional |
Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of 'trigger_template', 'github', 'pubsub_config', 'webhook_config' or 'source_to_build' must be provided. |
Optional |
Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression. |
Optional |
Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided. |
Optional |
Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution. |
Optional |
Only trigger a build if the revision regex does NOT match the revision regex. |
Optional |
The Cloud Source Repository to build. If omitted, the repo with name "default" is assumed. |
Optional |
Allowed value: The `name` field of a `SourceRepoRepository` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression. |
Optional |
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. |
Required* |
The secret required |
Optional |
Allowed value: The `name` field of a `SecretManagerSecretVersion` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. |
* Field is required when parent field is specified
Status
Schema
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createTime: string
observedGeneration: integer
triggerId: string
Fields | |
---|---|
conditions |
Conditions represent the latest available observation of the resource's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
createTime |
Time when the trigger was created. |
observedGeneration |
ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. |
triggerId |
The unique identifier for the trigger. |
Sample YAML(s)
Build Trigger For Cloud Source Repo
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: cloudbuild.cnrm.cloud.google.com/v1beta1
kind: CloudBuildTrigger
metadata:
name: cloudbuildtrigger-sample-cloudsourcerepo
spec:
description: Cloud Build Trigger for building the master branch of the referenced Cloud Source Repository.
disabled: false
triggerTemplate:
repoRef:
name: cloudbuildtrigger-dep-cloudsourcerepo
dir: "team-a/service-b"
branchName: master
ignoredFiles:
- "**/*.md"
includedFiles:
- "src/**"
substitutions:
"_SERVICE_NAME": "service-name"
build:
# Note: $PROJECT_ID and $COMMIT_SHA are variables that are expanded by the
# Cloud Build API when the build is created. More info:
# https://cloud.google.com/cloud-build/docs/configuring-builds/substitute-variable-values
images: ["gcr.io/$PROJECT_ID/${_SERVICE_NAME}:$COMMIT_SHA"]
tags: ["team-a", "service-b"]
timeout: 1800s
step:
- id: "download_zip"
name: gcr.io/cloud-builders/gsutil
args: ["cp", "gs://mybucket/remotefile.zip", "localfile.zip"]
timeout: 300s
- id: "build_package"
name: gcr.io/cloud-builders/go
args: ["build", "my_package"]
dir: directory
env:
- "ENV1=one"
- "ENV2=two"
secretEnv:
- "SECRET_ENV1"
timeout: 300s
- id: "build_docker_image"
name: gcr.io/cloud-builders/docker
args: ["build", "-t", "gcr.io/$PROJECT_ID/${_SERVICE_NAME}:$COMMIT_SHA", "-f", "Dockerfile", "."]
timeout: 300s
availableSecrets:
secretManager:
- env: SECRET1
versionRef:
name: cloudbuildtrigger-dep-cloudsourcerepo
---
apiVersion: secretmanager.cnrm.cloud.google.com/v1beta1
kind: SecretManagerSecret
metadata:
name: cloudbuildtrigger-dep-cloudsourcerepo
spec:
replication:
automatic: true
---
apiVersion: secretmanager.cnrm.cloud.google.com/v1beta1
kind: SecretManagerSecretVersion
metadata:
name: cloudbuildtrigger-dep-cloudsourcerepo
spec:
enabled: true
secretData:
value: c2VjcmV0MQ==
secretRef:
name: cloudbuildtrigger-dep-cloudsourcerepo
---
apiVersion: sourcerepo.cnrm.cloud.google.com/v1beta1
kind: SourceRepoRepository
metadata:
name: cloudbuildtrigger-dep-cloudsourcerepo
Build Trigger For GitHub Repo
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: cloudbuild.cnrm.cloud.google.com/v1beta1
kind: CloudBuildTrigger
metadata:
name: cloudbuildtrigger-sample-github
spec:
# Cloud Build Triggers for GitHub repositories require that you first connect
# your GCP project to your GitHub repository. More info:
# https://cloud.google.com/cloud-build/docs/automating-builds/create-github-app-triggers
description: Cloud Build Trigger for building the master branch of the GitHub repository at github.com/owner_name/repo_name
disabled: false
github:
owner: owner_name
name: repo_name
push:
branch: master
ignoredFiles:
- "**/*.md"
includedFiles:
- "src/**"
substitutions:
"_SERVICE_NAME": "service-name"
build:
# Note: $PROJECT_ID and $COMMIT_SHA are variables that are expanded by the
# Cloud Build API when the build is created. More info:
# https://cloud.google.com/cloud-build/docs/configuring-builds/substitute-variable-values
images: ["gcr.io/$PROJECT_ID/${_SERVICE_NAME}:$COMMIT_SHA"]
tags: ["team-a", "service-b"]
timeout: 1800s
step:
- id: "download_zip"
name: gcr.io/cloud-builders/gsutil
args: ["cp", "gs://mybucket/remotefile.zip", "localfile.zip"]
timeout: 300s
- id: "build_package"
name: gcr.io/cloud-builders/go
args: ["build", "my_package"]
dir: directory
env:
- "ENV1=one"
- "ENV2=two"
secretEnv:
- "SECRET_ENV1"
timeout: 300s
- id: "build_docker_image"
name: gcr.io/cloud-builders/docker
args: ["build", "-t", "gcr.io/$PROJECT_ID/${_SERVICE_NAME}:$COMMIT_SHA", "-f", "Dockerfile", "."]
timeout: 300s
Build Trigger With Template File
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: cloudbuild.cnrm.cloud.google.com/v1beta1
kind: CloudBuildTrigger
metadata:
name: cloudbuildtrigger-sample-withtemplatefile
spec:
description: Cloud Build Trigger with a build template file. Builds the master branch of the referenced Cloud Source Repository.
disabled: false
triggerTemplate:
repoRef:
name: cloudbuildtrigger-dep-withtemplatefile
dir: "team-a/service-b"
branchName: master
ignoredFiles:
- "**/*.md"
includedFiles:
- "src/**"
substitutions:
"_SERVICE_NAME": "service-name"
filename: "cloudbuild.yaml"
serviceAccountRef:
name: cbt-dep-withtemplatefile
---
apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMServiceAccount
metadata:
name: cbt-dep-withtemplatefile
---
apiVersion: sourcerepo.cnrm.cloud.google.com/v1beta1
kind: SourceRepoRepository
metadata:
name: cloudbuildtrigger-dep-withtemplatefile