From 1522603078b848223c52ef44955dccb35973f6db Mon Sep 17 00:00:00 2001 From: The Magician Date: Mon, 7 Oct 2019 10:22:26 -0700 Subject: [PATCH] New Module: gcp_compute_region_backend_service (#63154) --- .../gcp_compute_region_backend_service.py | 579 ++++++++++++++++++ .../aliases | 2 + .../meta/main.yml | 0 .../tasks/autogen.yml | 164 +++++ .../tasks/main.yml | 2 + 5 files changed, 747 insertions(+) create mode 100644 lib/ansible/modules/cloud/google/gcp_compute_region_backend_service.py create mode 100644 test/integration/targets/gcp_compute_region_backend_service/aliases create mode 100644 test/integration/targets/gcp_compute_region_backend_service/meta/main.yml create mode 100644 test/integration/targets/gcp_compute_region_backend_service/tasks/autogen.yml create mode 100644 test/integration/targets/gcp_compute_region_backend_service/tasks/main.yml diff --git a/lib/ansible/modules/cloud/google/gcp_compute_region_backend_service.py b/lib/ansible/modules/cloud/google/gcp_compute_region_backend_service.py new file mode 100644 index 00000000000..96b5ec2add2 --- /dev/null +++ b/lib/ansible/modules/cloud/google/gcp_compute_region_backend_service.py @@ -0,0 +1,579 @@ +#!/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 *** AUTO GENERATED CODE *** +# +# ---------------------------------------------------------------------------- +# +# 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_region_backend_service +description: +- A Region Backend Service defines a regionally-scoped group of virtual machines that + will serve traffic for load balancing. +- Region backend services can only be used when using internal load balancing. +- For external load balancing, use a global backend service instead. +short_description: Creates a GCP RegionBackendService +version_added: '2.10' +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 + 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 + health_checks: + description: + - The list of HealthChecks for checking the health of the backend service. + - Currently at most one health check can be specified, and a health check is required. + required: true + type: list + backends: + description: + - The list of backends that serve this RegionBackendService. + required: false + type: list + suboptions: + description: + description: + - An optional description of this resource. + - Provide this property when you create the resource. + required: false + type: str + group: + description: + - The fully-qualified URL of an Instance Group. This defines the list of instances + that serve traffic. Member virtual machine instances from each instance + group must live in the same zone as the instance group itself. No two backends + in a backend service are allowed to use same Instance Group resource. + - Note that you must specify an Instance Group resource using the fully-qualified + URL, rather than a partial URL. + - The instance group must be within the same region as the BackendService. + required: false + type: str + description: + description: + - An optional description of this resource. + required: false + type: str + protocol: + description: + - The protocol this BackendService uses to communicate with backends. + - The possible values are TCP and UDP, and the default is TCP. + - 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "SSL", "TCP", "UDP"' + required: false + type: str + session_affinity: + description: + - Type of session affinity to use. The default is NONE. + - Can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. + - When the protocol is UDP, this field is not used. + - 'Some valid choices include: "NONE", "CLIENT_IP", "CLIENT_IP_PROTO", "CLIENT_IP_PORT_PROTO"' + required: false + type: str + region: + description: + - The region where the regional backend service resides. + required: false + type: str + timeout_sec: + description: + - How many seconds to wait for the backend before considering it a failed request. + Default is 30 seconds. Valid range is [1, 86400]. + required: false + type: int + connection_draining: + description: + - Settings for connection draining . + required: false + type: dict + suboptions: + draining_timeout_sec: + description: + - Time for which instance will be drained (not accept new connections, but + still work to finish started). + required: false + type: int + load_balancing_scheme: + description: + - This signifies what the ForwardingRule will be used for and can only be INTERNAL + for RegionBackendServices . + - 'Some valid choices include: "INTERNAL"' + required: false + default: INTERNAL + 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 + 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/latest/regionBackendServices)' +- 'Internal TCP/UDP Load Balancing: U(https://cloud.google.com/compute/docs/load-balancing/internal/)' +- 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 health check + gcp_compute_health_check: + name: "{{ resource_name }}" + type: TCP + tcp_health_check: + port: 80 + check_interval_sec: 1 + timeout_sec: 1 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: present + register: healthcheck + +- name: create a region backend service + gcp_compute_region_backend_service: + name: test_object + region: us-central1 + health_checks: + - "{{ healthcheck.selfLink }}" + connection_draining: + draining_timeout_sec: 10 + session_affinity: CLIENT_IP + project: test_project + auth_kind: serviceaccount + service_account_file: "/tmp/auth.pem" + state: present +''' + +RETURN = ''' +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 +healthChecks: + description: + - The list of HealthChecks for checking the health of the backend service. + - Currently at most one health check can be specified, and a health check is required. + returned: success + type: list +backends: + description: + - The list of backends that serve this RegionBackendService. + returned: success + type: complex + contains: + description: + description: + - An optional description of this resource. + - Provide this property when you create the resource. + returned: success + type: str + group: + description: + - The fully-qualified URL of an Instance Group. This defines the list of instances + that serve traffic. Member virtual machine instances from each instance group + must live in the same zone as the instance group itself. No two backends in + a backend service are allowed to use same Instance Group resource. + - Note that you must specify an Instance Group resource using the fully-qualified + URL, rather than a partial URL. + - The instance group must be within the same region as the BackendService. + returned: success + type: str +description: + description: + - An optional description of this resource. + returned: success + type: str +fingerprint: + description: + - Fingerprint of this resource. A hash of the contents stored in this object. This + field is used in optimistic locking. + returned: success + type: str +protocol: + description: + - The protocol this BackendService uses to communicate with backends. + - The possible values are TCP and UDP, and the default is TCP. + returned: success + type: str +sessionAffinity: + description: + - Type of session affinity to use. The default is NONE. + - Can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. + - When the protocol is UDP, this field is not used. + returned: success + type: str +region: + description: + - The region where the regional backend service resides. + returned: success + type: str +timeoutSec: + description: + - How many seconds to wait for the backend before considering it a failed request. + Default is 30 seconds. Valid range is [1, 86400]. + returned: success + type: int +connectionDraining: + description: + - Settings for connection draining . + returned: success + type: complex + contains: + drainingTimeoutSec: + description: + - Time for which instance will be drained (not accept new connections, but still + work to finish started). + returned: success + type: int +loadBalancingScheme: + description: + - This signifies what the ForwardingRule will be used for and can only be INTERNAL + for RegionBackendServices . + returned: success + type: str +''' + +################################################################################ +# Imports +################################################################################ + +from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, remove_nones_from_dict, replace_resource_dict +import json +import re +import time + +################################################################################ +# Main +################################################################################ + + +def main(): + """Main function""" + + module = GcpModule( + argument_spec=dict( + state=dict(default='present', choices=['present', 'absent'], type='str'), + name=dict(required=True, type='str'), + health_checks=dict(required=True, type='list', elements='str'), + backends=dict(type='list', elements='dict', options=dict(description=dict(type='str'), group=dict(type='str'))), + description=dict(type='str'), + protocol=dict(type='str'), + session_affinity=dict(type='str'), + region=dict(type='str'), + timeout_sec=dict(type='int'), + connection_draining=dict(type='dict', options=dict(draining_timeout_sec=dict(type='int'))), + load_balancing_scheme=dict(default='INTERNAL', type='str'), + ) + ) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/compute'] + + state = module.params['state'] + kind = 'compute#backendService' + + 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#backendService', + u'name': module.params.get('name'), + u'healthChecks': module.params.get('health_checks'), + u'backends': RegionBackendServiceBackendsArray(module.params.get('backends', []), module).to_request(), + u'description': module.params.get('description'), + u'protocol': module.params.get('protocol'), + u'sessionAffinity': module.params.get('session_affinity'), + u'region': region_selflink(module.params.get('region'), module.params), + u'timeoutSec': module.params.get('timeout_sec'), + u'connectionDraining': RegionBackendServiceConnectiondraining(module.params.get('connection_draining', {}), module).to_request(), + u'loadBalancingScheme': module.params.get('load_balancing_scheme'), + } + 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://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{name}".format(**module.params) + + +def collection(module): + return "https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices".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'name': module.params.get('name'), + u'healthChecks': response.get(u'healthChecks'), + u'backends': RegionBackendServiceBackendsArray(response.get(u'backends', []), module).from_response(), + u'description': response.get(u'description'), + u'fingerprint': response.get(u'fingerprint'), + u'protocol': response.get(u'protocol'), + u'sessionAffinity': response.get(u'sessionAffinity'), + u'region': region_selflink(module.params.get('region'), module.params), + u'timeoutSec': response.get(u'timeoutSec'), + u'connectionDraining': RegionBackendServiceConnectiondraining(response.get(u'connectionDraining', {}), module).from_response(), + u'loadBalancingScheme': response.get(u'loadBalancingScheme'), + } + + +def region_selflink(name, params): + if name is None: + return + url = r"https://www.googleapis.com/compute/v1/projects/.*/regions/.*" + if not re.match(url, name): + name = "https://www.googleapis.com/compute/v1/projects/{project}/regions/%s".format(**params) % name + return name + + +def async_op_url(module, extra_data=None): + if extra_data is None: + extra_data = {} + url = "https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/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#backendService') + + +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 RegionBackendServiceBackendsArray(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'description': item.get('description'), u'group': item.get('group')}) + + def _response_from_item(self, item): + return remove_nones_from_dict({u'description': item.get(u'description'), u'group': item.get(u'group')}) + + +class RegionBackendServiceConnectiondraining(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'drainingTimeoutSec': self.request.get('draining_timeout_sec')}) + + def from_response(self): + return remove_nones_from_dict({u'drainingTimeoutSec': self.request.get(u'drainingTimeoutSec')}) + + +if __name__ == '__main__': + main() diff --git a/test/integration/targets/gcp_compute_region_backend_service/aliases b/test/integration/targets/gcp_compute_region_backend_service/aliases new file mode 100644 index 00000000000..9812f019ca4 --- /dev/null +++ b/test/integration/targets/gcp_compute_region_backend_service/aliases @@ -0,0 +1,2 @@ +cloud/gcp +unsupported diff --git a/test/integration/targets/gcp_compute_region_backend_service/meta/main.yml b/test/integration/targets/gcp_compute_region_backend_service/meta/main.yml new file mode 100644 index 00000000000..e69de29bb2d diff --git a/test/integration/targets/gcp_compute_region_backend_service/tasks/autogen.yml b/test/integration/targets/gcp_compute_region_backend_service/tasks/autogen.yml new file mode 100644 index 00000000000..7b577e2ce11 --- /dev/null +++ b/test/integration/targets/gcp_compute_region_backend_service/tasks/autogen.yml @@ -0,0 +1,164 @@ +--- +# ---------------------------------------------------------------------------- +# +# *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** +# +# ---------------------------------------------------------------------------- +# +# 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 +# +# ---------------------------------------------------------------------------- +# Pre-test setup +- name: create a health check + gcp_compute_health_check: + name: "{{ resource_name }}" + type: TCP + tcp_health_check: + port: 80 + check_interval_sec: 1 + timeout_sec: 1 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: present + register: healthcheck +- name: delete a region backend service + gcp_compute_region_backend_service: + name: "{{ resource_name }}" + region: us-central1 + health_checks: + - "{{ healthcheck.selfLink }}" + connection_draining: + draining_timeout_sec: 10 + session_affinity: CLIENT_IP + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: absent +#---------------------------------------------------------- +- name: create a region backend service + gcp_compute_region_backend_service: + name: "{{ resource_name }}" + region: us-central1 + health_checks: + - "{{ healthcheck.selfLink }}" + connection_draining: + draining_timeout_sec: 10 + session_affinity: CLIENT_IP + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: present + register: result +- name: assert changed is true + assert: + that: + - result.changed == true +- name: verify that region_backend_service was created + gcp_compute_region_backend_service_info: + filters: + - name = {{ resource_name }} + region: us-central1 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + register: results +- name: verify that command succeeded + assert: + that: + - results['resources'] | length == 1 +# ---------------------------------------------------------------------------- +- name: create a region backend service that already exists + gcp_compute_region_backend_service: + name: "{{ resource_name }}" + region: us-central1 + health_checks: + - "{{ healthcheck.selfLink }}" + connection_draining: + draining_timeout_sec: 10 + session_affinity: CLIENT_IP + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: present + register: result +- name: assert changed is false + assert: + that: + - result.changed == false +#---------------------------------------------------------- +- name: delete a region backend service + gcp_compute_region_backend_service: + name: "{{ resource_name }}" + region: us-central1 + health_checks: + - "{{ healthcheck.selfLink }}" + connection_draining: + draining_timeout_sec: 10 + session_affinity: CLIENT_IP + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: absent + register: result +- name: assert changed is true + assert: + that: + - result.changed == true +- name: verify that region_backend_service was deleted + gcp_compute_region_backend_service_info: + filters: + - name = {{ resource_name }} + region: us-central1 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + register: results +- name: verify that command succeeded + assert: + that: + - results['resources'] | length == 0 +# ---------------------------------------------------------------------------- +- name: delete a region backend service that does not exist + gcp_compute_region_backend_service: + name: "{{ resource_name }}" + region: us-central1 + health_checks: + - "{{ healthcheck.selfLink }}" + connection_draining: + draining_timeout_sec: 10 + session_affinity: CLIENT_IP + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: absent + register: result +- name: assert changed is false + assert: + that: + - result.changed == false +#--------------------------------------------------------- +# Post-test teardown +# If errors happen, don't crash the playbook! +- name: delete a health check + gcp_compute_health_check: + name: "{{ resource_name }}" + type: TCP + tcp_health_check: + port: 80 + check_interval_sec: 1 + timeout_sec: 1 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: absent + register: healthcheck + ignore_errors: true diff --git a/test/integration/targets/gcp_compute_region_backend_service/tasks/main.yml b/test/integration/targets/gcp_compute_region_backend_service/tasks/main.yml new file mode 100644 index 00000000000..45d6e49178c --- /dev/null +++ b/test/integration/targets/gcp_compute_region_backend_service/tasks/main.yml @@ -0,0 +1,2 @@ +--- +- include_tasks: autogen.yml