ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-06 10:50:28 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
google.cloud/plugins/modules/gcp_compute_backend_bucket.py
The Magician fe79a8b1e1
Add generator information to generated resources (#5016) (#449) 
Signed-off-by: Modular Magician <magic-modules@google.com>
2021-07-29 18:41:37 -05:00

637 lines
22 KiB
Python
Raw Blame History

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017 Google
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** Type: MMv1 ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file at
# https://www.github.com/GoogleCloudPlatform/magic-modules
#
# ----------------------------------------------------------------------------
from __future__ import absolute_import, division, print_function
__metaclass__ = type
################################################################################
# Documentation
################################################################################
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}
DOCUMENTATION = '''
---
module: gcp_compute_backend_bucket
description:
- 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 to a virtual machine instance.
short_description: Creates a GCP BackendBucket
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
options:
state:
description:
- Whether the given object should exist in GCP
choices:
- present
- absent
default: present
type: str
bucket_name:
description:
- Cloud Storage bucket name.
required: true
type: str
cdn_policy:
description:
- Cloud CDN configuration for this Backend Bucket.
required: false
type: dict
suboptions:
signed_url_cache_max_age_sec:
description:
- Maximum number of seconds the response to a signed URL request will be considered
fresh. After this time period, the response will be revalidated before being
served.
- 'When serving responses to signed URL requests, Cloud CDN will internally
behave as though all responses from this backend had a "Cache-Control: public,
max-age=[TTL]" header, regardless of any existing Cache-Control header.
The actual headers served in responses will not be altered.'
required: false
type: int
default_ttl:
description:
- Specifies the default TTL for cached content served by this origin for responses
that do not have an existing valid TTL (max-age or s-max-age).
required: false
type: int
max_ttl:
description:
- Specifies the maximum allowed TTL for cached content served by this origin.
required: false
type: int
client_ttl:
description:
- Specifies the maximum allowed TTL for cached content served by this origin.
required: false
type: int
negative_caching:
description:
- Negative caching allows per-status code TTLs to be set, in order to apply
fine-grained caching for common errors or redirects.
required: false
type: bool
negative_caching_policy:
description:
- Sets a cache TTL for the specified HTTP status code. negativeCaching must
be enabled to configure negativeCachingPolicy.
- Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's
default cache TTLs.
elements: dict
required: false
type: list
suboptions:
code:
description:
- The HTTP status code to define a TTL against. Only HTTP status codes
300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values,
and you cannot specify a status code more than once.
required: false
type: int
ttl:
description:
- The TTL (in seconds) for which to cache responses with the corresponding
status code. The maximum allowed value is 1800s (30 minutes), noting
that infrequently accessed objects may be evicted from the cache before
the defined TTL.
required: false
type: int
cache_mode:
description:
- Specifies the cache setting for all responses from this backend.
- 'The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC
.'
- 'Some valid choices include: "USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"'
required: false
type: str
serve_while_stale:
description:
- Serve existing content from the cache (if available) when revalidating content
with the origin, or when an error is encountered when refreshing the cache.
required: false
type: int
custom_response_headers:
description:
- Headers that the HTTP/S load balancer should add to proxied responses.
elements: str
required: false
type: list
description:
description:
- An optional textual description of the resource; provided by the client when
the resource is created.
required: false
type: str
enable_cdn:
description:
- If true, enable Cloud CDN for this BackendBucket.
required: false
type: bool
name:
description:
- 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.
required: true
type: str
project:
description:
- The Google Cloud Platform project to use.
type: str
auth_kind:
description:
- The type of credential used.
type: str
required: true
choices:
- application
- machineaccount
- serviceaccount
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a
JSON string that represents it.
type: jsonarg
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
service_account_email:
description:
- An optional service account email address if machineaccount is selected and
the user does not wish to use the default email.
type: str
scopes:
description:
- Array of scopes to be used
type: list
elements: str
env_type:
description:
- 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.
type: str
notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/v1/backendBuckets)'
- 'Using a Cloud Storage bucket as a load balancer backend: U(https://cloud.google.com/compute/docs/load-balancing/http/backend-bucket)'
- 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 C(GCP_SERVICE_ACCOUNT_EMAIL)
env variable.
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
- Environment variables values will only be used if the playbook values are not set.
- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
'''
EXAMPLES = '''
- name: create a bucket
google.cloud.gcp_storage_bucket:
name: bucket-backendbucket
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: bucket
- name: create a backend bucket
google.cloud.gcp_compute_backend_bucket:
name: test_object
bucket_name: "{{ bucket.name }}"
description: A BackendBucket to connect LNB w/ Storage Bucket
enable_cdn: 'true'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
'''
RETURN = '''
bucketName:
description:
- Cloud Storage bucket name.
returned: success
type: str
cdnPolicy:
description:
- Cloud CDN configuration for this Backend Bucket.
returned: success
type: complex
contains:
signedUrlCacheMaxAgeSec:
description:
- Maximum number of seconds the response to a signed URL request will be considered
fresh. After this time period, the response will be revalidated before being
served.
- 'When serving responses to signed URL requests, Cloud CDN will internally
behave as though all responses from this backend had a "Cache-Control: public,
max-age=[TTL]" header, regardless of any existing Cache-Control header. The
actual headers served in responses will not be altered.'
returned: success
type: int
defaultTtl:
description:
- Specifies the default TTL for cached content served by this origin for responses
that do not have an existing valid TTL (max-age or s-max-age).
returned: success
type: int
maxTtl:
description:
- Specifies the maximum allowed TTL for cached content served by this origin.
returned: success
type: int
clientTtl:
description:
- Specifies the maximum allowed TTL for cached content served by this origin.
returned: success
type: int
negativeCaching:
description:
- Negative caching allows per-status code TTLs to be set, in order to apply
fine-grained caching for common errors or redirects.
returned: success
type: bool
negativeCachingPolicy:
description:
- Sets a cache TTL for the specified HTTP status code. negativeCaching must
be enabled to configure negativeCachingPolicy.
- Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's
default cache TTLs.
returned: success
type: complex
contains:
code:
description:
- The HTTP status code to define a TTL against. Only HTTP status codes 300,
301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values,
and you cannot specify a status code more than once.
returned: success
type: int
ttl:
description:
- The TTL (in seconds) for which to cache responses with the corresponding
status code. The maximum allowed value is 1800s (30 minutes), noting that
infrequently accessed objects may be evicted from the cache before the
defined TTL.
returned: success
type: int
cacheMode:
description:
- Specifies the cache setting for all responses from this backend.
- 'The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC
.'
returned: success
type: str
serveWhileStale:
description:
- Serve existing content from the cache (if available) when revalidating content
with the origin, or when an error is encountered when refreshing the cache.
returned: success
type: int
customResponseHeaders:
description:
- Headers that the HTTP/S load balancer should add to proxied responses.
returned: success
type: list
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional textual description of the resource; provided by the client when the
resource is created.
returned: success
type: str
enableCdn:
description:
- If true, enable Cloud CDN for this BackendBucket.
returned: success
type: bool
id:
description:
- Unique identifier for the resource.
returned: success
type: int
name:
description:
- 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.
returned: success
type: str
'''
################################################################################
# Imports
################################################################################
from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import (
navigate_hash,
GcpSession,
GcpModule,
GcpRequest,
remove_nones_from_dict,
replace_resource_dict,
)
import json
import time
################################################################################
# Main
################################################################################
def main():
"""Main function"""
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
bucket_name=dict(required=True, type='str'),
cdn_policy=dict(
type='dict',
options=dict(
signed_url_cache_max_age_sec=dict(type='int'),
default_ttl=dict(type='int'),
max_ttl=dict(type='int'),
client_ttl=dict(type='int'),
negative_caching=dict(type='bool'),
negative_caching_policy=dict(type='list', elements='dict', options=dict(code=dict(type='int'), ttl=dict(type='int'))),
cache_mode=dict(type='str'),
serve_while_stale=dict(type='int'),
),
),
custom_response_headers=dict(type='list', elements='str'),
description=dict(type='str'),
enable_cdn=dict(type='bool'),
name=dict(required=True, type='str'),
)
)
if not module.params['scopes']:
module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
state = module.params['state']
kind = 'compute#backendBucket'
fetch = fetch_resource(module, self_link(module), kind)
changed = False
if fetch:
if state == 'present':
if is_different(module, fetch):
update(module, self_link(module), kind)
fetch = fetch_resource(module, self_link(module), kind)
changed = True
else:
delete(module, self_link(module), kind)
fetch = {}
changed = True
else:
if state == 'present':
fetch = create(module, collection(module), kind)
changed = True
else:
fetch = {}
fetch.update({'changed': changed})
module.exit_json(**fetch)
def create(module, link, kind):
auth = GcpSession(module, 'compute')
return wait_for_operation(module, auth.post(link, resource_to_request(module)))
def update(module, link, kind):
auth = GcpSession(module, 'compute')
return wait_for_operation(module, auth.put(link, resource_to_request(module)))
def delete(module, link, kind):
auth = GcpSession(module, 'compute')
return wait_for_operation(module, auth.delete(link))
def resource_to_request(module):
request = {
u'kind': 'compute#backendBucket',
u'bucketName': module.params.get('bucket_name'),
u'cdnPolicy': BackendBucketCdnpolicy(module.params.get('cdn_policy', {}), module).to_request(),
u'customResponseHeaders': module.params.get('custom_response_headers'),
u'description': module.params.get('description'),
u'enableCdn': module.params.get('enable_cdn'),
u'name': module.params.get('name'),
}
return_vals = {}
for k, v in request.items():
if v or v is False:
return_vals[k] = v
return return_vals
def fetch_resource(module, link, kind, allow_not_found=True):
auth = GcpSession(module, 'compute')
return return_if_object(module, auth.get(link), kind, allow_not_found)
def self_link(module):
return "https://compute.googleapis.com/compute/v1/projects/{project}/global/backendBuckets/{name}".format(**module.params)
def collection(module):
return "https://compute.googleapis.com/compute/v1/projects/{project}/global/backendBuckets".format(**module.params)
def return_if_object(module, response, kind, allow_not_found=False):
# If not found, return nothing.
if allow_not_found and response.status_code == 404:
return None
# If no content, return nothing.
if response.status_code == 204:
return None
try:
module.raise_for_status(response)
result = response.json()
except getattr(json.decoder, 'JSONDecodeError', ValueError):
module.fail_json(msg="Invalid JSON response with error: %s" % response.text)
if navigate_hash(result, ['error', 'errors']):
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
return result
def is_different(module, response):
request = resource_to_request(module)
response = response_to_hash(module, response)
# Remove all output-only from response.
response_vals = {}
for k, v in response.items():
if k in request:
response_vals[k] = v
request_vals = {}
for k, v in request.items():
if k in response:
request_vals[k] = v
return GcpRequest(request_vals) != GcpRequest(response_vals)
# Remove unnecessary properties from the response.
# This is for doing comparisons with Ansible's current parameters.
def response_to_hash(module, response):
return {
u'bucketName': response.get(u'bucketName'),
u'cdnPolicy': BackendBucketCdnpolicy(response.get(u'cdnPolicy', {}), module).from_response(),
u'customResponseHeaders': response.get(u'customResponseHeaders'),
u'creationTimestamp': response.get(u'creationTimestamp'),
u'description': response.get(u'description'),
u'enableCdn': response.get(u'enableCdn'),
u'id': response.get(u'id'),
u'name': module.params.get('name'),
}
def async_op_url(module, extra_data=None):
if extra_data is None:
extra_data = {}
url = "https://compute.googleapis.com/compute/v1/projects/{project}/global/operations/{op_id}"
combined = extra_data.copy()
combined.update(module.params)
return url.format(**combined)
def wait_for_operation(module, response):
op_result = return_if_object(module, response, 'compute#operation')
if op_result is None:
return {}
status = navigate_hash(op_result, ['status'])
wait_done = wait_for_completion(status, op_result, module)
return fetch_resource(module, navigate_hash(wait_done, ['targetLink']), 'compute#backendBucket')
def wait_for_completion(status, op_result, module):
op_id = navigate_hash(op_result, ['name'])
op_uri = async_op_url(module, {'op_id': op_id})
while status != 'DONE':
raise_if_errors(op_result, ['error', 'errors'], module)
time.sleep(1.0)
op_result = fetch_resource(module, op_uri, 'compute#operation', False)
status = navigate_hash(op_result, ['status'])
return op_result
def raise_if_errors(response, err_path, module):
errors = navigate_hash(response, err_path)
if errors is not None:
module.fail_json(msg=errors)
class BackendBucketCdnpolicy(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'signedUrlCacheMaxAgeSec': self.request.get('signed_url_cache_max_age_sec'),
u'defaultTtl': self.request.get('default_ttl'),
u'maxTtl': self.request.get('max_ttl'),
u'clientTtl': self.request.get('client_ttl'),
u'negativeCaching': self.request.get('negative_caching'),
u'negativeCachingPolicy': BackendBucketNegativecachingpolicyArray(self.request.get('negative_caching_policy', []), self.module).to_request(),
u'cacheMode': self.request.get('cache_mode'),
u'serveWhileStale': self.request.get('serve_while_stale'),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'signedUrlCacheMaxAgeSec': self.request.get(u'signedUrlCacheMaxAgeSec'),
u'defaultTtl': self.request.get(u'defaultTtl'),
u'maxTtl': self.request.get(u'maxTtl'),
u'clientTtl': self.request.get(u'clientTtl'),
u'negativeCaching': self.request.get(u'negativeCaching'),
u'negativeCachingPolicy': BackendBucketNegativecachingpolicyArray(self.request.get(u'negativeCachingPolicy', []), self.module).from_response(),
u'cacheMode': self.request.get(u'cacheMode'),
u'serveWhileStale': self.request.get(u'serveWhileStale'),
}
)
class BackendBucketNegativecachingpolicyArray(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = []
def to_request(self):
items = []
for item in self.request:
items.append(self._request_for_item(item))
return items
def from_response(self):
items = []
for item in self.request:
items.append(self._response_from_item(item))
return items
def _request_for_item(self, item):
return remove_nones_from_dict({u'code': item.get('code'), u'ttl': item.get('ttl')})
def _response_from_item(self, item):
return remove_nones_from_dict({u'code': item.get(u'code'), u'ttl': item.get(u'ttl')})
if __name__ == '__main__':
main()
Reference in a new issue View git blame Copy permalink