google.cloud.gcp_cloudbuild_trigger_info – Gather info for GCP Trigger

Note

This plugin is part of the google.cloud collection (version 1.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_cloudbuild_trigger_info.

Synopsis

  • Gather info for GCP Trigger

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
env_type
string
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
project
string
The Google Cloud Platform project to use.
scopes
list / elements=string
Array of scopes to be used
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email
string
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
path
The path of a Service Account JSON file if serviceaccount is selected as type.

Notes

Note

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: get info on a trigger
  gcp_cloudbuild_trigger_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
resources
complex
always
List of resources

 
build
complex
success
Contents of the build template. Either a filename or build template must be provided.

   
artifacts
complex
success
Artifacts produced by the build that should be uploaded upon successful completion of all build steps.

     
images
list / elements=string
success
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.

     
objects
complex
success
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.

       
location
string
success
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.

       
paths
list / elements=string
success
Path globs used to match files in the build's workspace.

       
timing
complex
success
Output only. Stores timing information for pushing all artifact objects.

         
endTime
string
success
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".

         
startTime
string
success
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".

   
images
list / elements=string
success
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.

   
logsBucket
string
success
Google Cloud Storage bucket where logs should be written. Logs file names will be of the format ${logsBucket}/log-${build_id}.txt.

   
options
complex
success
Special options for this build.

     
diskSizeGb
integer
success
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.

     
dynamicSubstitutions
boolean
success
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.

     
env
list / elements=string
success
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".

     
logging
string
success
Option to specify the logging mode, which determines if and where build logs are stored.

     
logStreamingOption
string
success
Option to define build log streaming behavior to Google Cloud Storage.

     
machineType
string
success
Compute Engine machine type on which to run the build.

     
requestedVerifyOption
string
success
Requested verifiability options.

     
secretEnv
list / elements=string
success
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.

     
sourceProvenanceHash
list / elements=string
success
Requested hash for SourceProvenance.

     
substitutionOption
string
success
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.

     
volumes
complex
success
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.

       
name
string
success
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.

       
path
string
success
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.

     
workerPool
string
success
Option to specify a WorkerPool for the build. Format projects/{project}/workerPools/{workerPool} This field is experimental.

   
queueTtl
string
success
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".

   
secrets
complex
success
Secrets to decrypt using Cloud Key Management Service.

     
kmsKeyName
string
success
Cloud KMS key name to use to decrypt these envs.

     
secretEnv
dictionary
success
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.

   
source
complex
success
The location of the source files to build.

     
repoSource
complex
success
Location of the source in a Google Cloud Source Repository.

       
branchName
string
success
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 .

       
commitSha
string
success
Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided.

       
dir
string
success
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.

       
invertRegex
boolean
success
Only trigger a build if the revision regex does NOT match the revision regex.

       
projectId
string
success
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

       
repoName
string
success
Name of the Cloud Source Repository.

       
substitutions
dictionary
success
Substitutions to use in a triggered build. Should only be used with triggers.run .

       
tagName
string
success
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 .

     
storageSource
complex
success
Location of the source in an archive file in Google Cloud Storage.

       
bucket
string
success
Google Cloud Storage bucket containing the source.

       
generation
string
success
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used .

       
object
string
success
Google Cloud Storage object containing the source.
This object must be a gzipped archive file (.tar.gz) containing source to build.

   
steps
complex
success
The operations to be performed on the workspace.

     
args
list / elements=string
success
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.

     
dir
string
success
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.

     
entrypoint
string
success
Entrypoint to be used instead of the build step image's default entrypoint.
If unset, the image's default entrypoint is used .

     
env
list / elements=string
success
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".

     
id
string
success
Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.

     
name
string
success
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.

     
secretEnv
list / elements=string
success
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`.

     
timeout
string
success
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.

     
timing
string
success
Output only. Stores timing information for executing this build step.

     
volumes
complex
success
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.

       
name
string
success
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.

       
path
string
success
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.

     
waitFor
list / elements=string
success
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.

   
substitutions
dictionary
success
Substitutions data for Build resource.

   
tags
list / elements=string
success
Tags for annotation of a Build. These are not docker tags.

   
timeout
string
success
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).

 
createTime
string
success
Time when the trigger was created.

 
description
string
success
Human-readable description of the trigger.

 
disabled
boolean
success
Whether the trigger is disabled or not. If true, the trigger will never result in a build.

 
filename
string
success
Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.

 
github
complex
success
Describes the configuration of a trigger that creates a build whenever a GitHub event is received.

   
name
string
success
Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".

   
owner
string
success
Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".

   
pullRequest
complex
success
filter to match changes in pull requests. Specify only one of pullRequest or push.

     
branch
string
success
Regex of branches to match.

     
commentControl
string
success
Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator.

     
invertRegex
boolean
success
If true, branches that do NOT match the git_ref will trigger a build.

   
push
complex
success
filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push.

     
branch
string
success
Regex of branches to match. Specify only one of branch or tag.

     
invertRegex
boolean
success
When true, only trigger a build if the revision regex does NOT match the git_ref regex.

     
tag
string
success
Regex of tags to match. Specify only one of branch or tag.

 
id
string
success
The unique identifier for the trigger.

 
ignoredFiles
list / elements=string
success
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.

 
includedFiles
list / elements=string
success
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.

 
name
string
success
Name of the trigger. Must be unique within the project.

 
substitutions
dictionary
success
Substitutions data for Build resource.

 
tags
list / elements=string
success
Tags for annotation of a BuildTrigger .

 
triggerTemplate
complex
success
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.

   
branchName
string
success
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.

   
commitSha
string
success
Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

   
dir
string
success
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.

   
invertRegex
boolean
success
Only trigger a build if the revision regex does NOT match the revision regex.

   
projectId
string
success
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

   
repoName
string
success
Name of the Cloud Source Repository. If omitted, the name "default" is assumed.

   
tagName
string
success
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.



Authors

  • Google Inc. (@googlecloudplatform)