gcp_compute_backend_bucket - Creates a GCP BackendBucket

New in version 2.6.

Synopsis

  • Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing.
  • An HTTP(S) load balancer can direct traffic to specified URLs to a backend bucket rather than a backend service. It can send requests for static content to a Cloud Storage bucket and requests for dynamic content a virtual machine instance.

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
required
    Choices:
  • machineaccount
  • serviceaccount
  • application
The type of credential used.
bucket_name
required
Cloud Storage bucket name.
description
An optional textual description of the resource; provided by the client when the resource is created.
enable_cdn
bool
    Choices:
  • no
  • yes
If true, enable Cloud CDN for this BackendBucket.
name
required
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project
The Google Cloud Platform project to use.
scopes
required
Array of scopes to be used.
service_account_email
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
The path of a Service Account JSON file if serviceaccount is selected as type.
state
required
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP

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_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 bucket
  gcp_storage_bucket:
      name: 'bucket-backendbucket'
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      scopes:
        - https://www.googleapis.com/auth/devstorage.full_control
      state: present
  register: bucket
- name: create a backend bucket
  gcp_compute_backend_bucket:
      name: testObject
      bucket_name: "{{ bucket.name }}"
      description: "A BackendBucket to connect LNB w/ Storage Bucket"
      enable_cdn: true
      project: testProject
      auth_kind: service_account
      service_account_file: /tmp/auth.pem
      scopes:
        - https://www.googleapis.com/auth/cloud-platform
      state: present

Return Values

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

Key Returned Description
bucket_name
str
 success
Cloud Storage bucket name.
creation_timestamp
str
 success
Creation timestamp in RFC3339 text format.
description
str
 success
An optional textual description of the resource; provided by the client when the resource is created.
enable_cdn
bool
 success
If true, enable Cloud CDN for this BackendBucket.
id
int
 success
Unique identifier for the resource.
name
str
 success
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • 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.6/modules/gcp_compute_backend_bucket_module.html