google.cloud.gcp_cloudbuildv2_repository module – Creates a GCP Cloudbuildv2.Repository resource

Note

This module is part of the google.cloud collection (version 1.12.0).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • A repository associated to a parent connection.

Requirements

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

  • python >= 3.8

  • requests >= 2.18.4

  • google-auth >= 2.25.1

Parameters

Parameter

Comments

access_token

string

The access token used to authenticate.

annotations

dictionary

Allows clients to store small amounts of arbitrary data.

auth_kind

string / required

The type of credential used.

Choices:

  • "accesstoken"

  • "application"

  • "machineaccount"

  • "serviceaccount"

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.

location

string

The location for the resource.

name

string / required

Name of the repository.

parent_connection

dictionary / required

The connection for the resource.

This field is a reference to a connection resource in GCP.

It can be specified in two ways: First, you can place a dictionary with key ‘name’ matching your resource.

Alternatively, you can add `register: name-of-resource` to a connection task and then set this field to `{{ name-of-resource }}`.

project

string

The Google Cloud Platform project to use.

remote_uri

string / required

Git Clone HTTPS URI.

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.

state

string

Whether the resource should exist in GCP.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • API Reference: https://cloud.google.com/build/docs/api/reference/rest

  • Official Documentation Guide: https://cloud.google.com/build/docs

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

  • 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 access_token using the GCP_ACCESS_TOKEN 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, service_account_file, service_account_file and access_token options are mutually exclusive.

Examples

# repository_ghe_doc

################################################################################

# repository_github_doc

Return Values

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

Key

Description

changed

boolean

Whether the resource was changed.

Returned: always

createTime

string

Output only.

Server assigned timestamp for when the connection was created.

Returned: success

etag

string

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.

Returned: success

state

string

The current state of the resource.

Returned: always

updateTime

string

Output only.

Server assigned timestamp for when the connection was updated.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)