360 lines
11 KiB
Python
360 lines
11 KiB
Python
#!/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_global_address
|
|
description:
|
|
- Represents a Global Address resource. Global addresses are used for HTTP(S) load
|
|
balancing.
|
|
short_description: Creates a GCP GlobalAddress
|
|
version_added: 2.6
|
|
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
|
|
address:
|
|
description:
|
|
- The static external IP address represented by this resource.
|
|
required: false
|
|
version_added: 2.8
|
|
description:
|
|
description:
|
|
- An optional description of this resource.
|
|
- Provide this property when you create the resource.
|
|
required: false
|
|
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
|
|
ip_version:
|
|
description:
|
|
- The IP Version that will be used by this address. Valid options are IPV4 or
|
|
IPV6. The default value is IPV4.
|
|
required: false
|
|
choices:
|
|
- IPV4
|
|
- IPV6
|
|
address_type:
|
|
description:
|
|
- The type of the address to reserve, default is EXTERNAL.
|
|
- "* EXTERNAL indicates public/external single IP address."
|
|
- "* INTERNAL indicates internal IP ranges belonging to some network."
|
|
required: false
|
|
default: EXTERNAL
|
|
version_added: 2.8
|
|
choices:
|
|
- EXTERNAL
|
|
- INTERNAL
|
|
extends_documentation_fragment: gcp
|
|
notes:
|
|
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/latest/globalAddresses)'
|
|
- 'Reserving a Static External IP Address: U(https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address)'
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: create a global address
|
|
gcp_compute_global_address:
|
|
name: "test_object"
|
|
project: "test_project"
|
|
auth_kind: "serviceaccount"
|
|
service_account_file: "/tmp/auth.pem"
|
|
state: present
|
|
'''
|
|
|
|
RETURN = '''
|
|
address:
|
|
description:
|
|
- The static external IP address represented by this resource.
|
|
returned: success
|
|
type: str
|
|
creationTimestamp:
|
|
description:
|
|
- Creation timestamp in RFC3339 text format.
|
|
returned: success
|
|
type: str
|
|
description:
|
|
description:
|
|
- An optional description of this resource.
|
|
- Provide this property when you create the resource.
|
|
returned: success
|
|
type: str
|
|
id:
|
|
description:
|
|
- The unique identifier for the resource. This identifier is defined by the server.
|
|
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
|
|
ipVersion:
|
|
description:
|
|
- The IP Version that will be used by this address. Valid options are IPV4 or IPV6.
|
|
The default value is IPV4.
|
|
returned: success
|
|
type: str
|
|
region:
|
|
description:
|
|
- A reference to the region where the regional address resides.
|
|
returned: success
|
|
type: str
|
|
addressType:
|
|
description:
|
|
- The type of the address to reserve, default is EXTERNAL.
|
|
- "* EXTERNAL indicates public/external single IP address."
|
|
- "* INTERNAL indicates internal IP ranges belonging to some network."
|
|
returned: success
|
|
type: str
|
|
'''
|
|
|
|
################################################################################
|
|
# Imports
|
|
################################################################################
|
|
|
|
from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, 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'),
|
|
address=dict(type='str'),
|
|
description=dict(type='str'),
|
|
name=dict(required=True, type='str'),
|
|
ip_version=dict(type='str', choices=['IPV4', 'IPV6']),
|
|
address_type=dict(default='EXTERNAL', type='str', choices=['EXTERNAL', 'INTERNAL']),
|
|
)
|
|
)
|
|
|
|
if not module.params['scopes']:
|
|
module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
|
|
|
|
state = module.params['state']
|
|
kind = 'compute#address'
|
|
|
|
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):
|
|
module.fail_json(msg="GlobalAddress cannot be edited")
|
|
|
|
|
|
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#address',
|
|
u'address': module.params.get('address'),
|
|
u'description': module.params.get('description'),
|
|
u'name': module.params.get('name'),
|
|
u'ipVersion': module.params.get('ip_version'),
|
|
u'addressType': module.params.get('address_type'),
|
|
}
|
|
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}/global/addresses/{name}".format(**module.params)
|
|
|
|
|
|
def collection(module):
|
|
return "https://www.googleapis.com/compute/v1/projects/{project}/global/addresses".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'address': response.get(u'address'),
|
|
u'creationTimestamp': response.get(u'creationTimestamp'),
|
|
u'description': response.get(u'description'),
|
|
u'id': response.get(u'id'),
|
|
u'name': response.get(u'name'),
|
|
u'ipVersion': response.get(u'ipVersion'),
|
|
u'region': response.get(u'region'),
|
|
u'addressType': response.get(u'addressType'),
|
|
}
|
|
|
|
|
|
def region_selflink(name, params):
|
|
if name is None:
|
|
return
|
|
url = r"https://www.googleapis.com/compute/v1/projects/.*/regions/[a-z1-9\-]*"
|
|
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}/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#address')
|
|
|
|
|
|
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)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|