gcp_sourcerepo_repository – Creates a GCP Repository

From Get docs
Ansible/docs/2.9/modules/gcp sourcerepo repository module


gcp_sourcerepo_repository – Creates a GCP Repository

New in version 2.8.


Synopsis

  • A repository (or repo) is a Git repository storing versioned source content.

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

  • 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.

name

string / required

Resource name of the repository, of the form projects/Template:Project/repos/Template:Repo.

The repo name may contain slashes. eg, projects/myproject/repos/name/with/slash .

project

string

The Google Cloud Platform project to use.

scopes

list

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

  • present

  • absent

Whether the given object should exist in GCP



Notes

Note

  • API Reference: https://cloud.google.com/source-repositories/docs/reference/rest/v1/projects.repos
  • Official Documentation: https://cloud.google.com/source-repositories/
  • for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
  • for authentication, you can set service_account_contents using the c(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: create a repository
  gcp_sourcerepo_repository:
    name: test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

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

Key Returned Description

name

string

success

Resource name of the repository, of the form projects/Template:Project/repos/Template:Repo.

The repo name may contain slashes. eg, projects/myproject/repos/name/with/slash .


size

integer

success

The disk usage of the repo, in bytes.


url

string

success

URL to clone the repository from Google Cloud Source Repositories.





Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_sourcerepo_repository_module.html