mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
4b26990d8b
* fixed validation-modules for plugins/modules/cloud/google/gcdns_record.py * fixed validation-modules for plugins/modules/cloud/google/gcdns_zone.py * fixed validation-modules for plugins/modules/cloud/google/gce_eip.py * fixed validation-modules for plugins/modules/cloud/google/gce_img.py * fixed validation-modules for plugins/modules/cloud/google/gce_instance_template.py * fixed validation-modules for plugins/modules/cloud/google/gce_labels.py * fixed validation-modules for plugins/modules/cloud/google/gce_lb.py * fixed validation-modules for plugins/modules/cloud/google/gce_mig.py * fixed validation-modules for plugins/modules/cloud/google/gce_net.py * fixed validation-modules for plugins/modules/cloud/google/gce_pd.py * fixed validation-modules for plugins/modules/cloud/google/gce_snapshot.py * fixed validation-modules for plugins/modules/cloud/google/gce_tag.py * fixed validation-modules for plugins/modules/cloud/google/gcp_backend_service.py * fixed validation-modules for plugins/modules/cloud/google/gcp_forwarding_rule.py * fixed validation-modules for plugins/modules/cloud/google/gcp_healthcheck.py * fixed validation-modules for plugins/modules/cloud/google/gcp_target_proxy.py * fixed validation-modules for plugins/modules/cloud/google/gcpubsub_info.py * fixed validation-modules for plugins/modules/cloud/google/gcpubsub.py * fixed validation-modules for plugins/modules/cloud/google/gcp_url_map.py * fixed validation-modules for plugins/modules/cloud/google/gcspanner.py * fixed validation-modules for plugins/modules/cloud/google/gc_storage.py * adjust parameter description in gce_eip.py * fixed validation-modules for plugins/modules/cloud/google/gce.py * removed extra type definition * reformatted long lines * Tidy up validate-modules ignores for cloud/google modules * gc_storage.py: fixed parameter to be overwrite and alias force, instead of the other way around * rolled back a number of ignore lines that ansible 2.9 believes to defy sanity * gce_instance_template.py: the metadata parameter brings no definition whatsoever in argument_spec, causing a number of problems. Rolling back for now. * Fixes on docs from the PR
247 lines
6.8 KiB
Python
247 lines
6.8 KiB
Python
#!/usr/bin/python
|
|
# Copyright 2017 Google Inc.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
module: gce_eip
|
|
short_description: Create or Destroy Global or Regional External IP addresses.
|
|
description:
|
|
- Create (reserve) or Destroy (release) Regional or Global IP Addresses. See
|
|
U(https://cloud.google.com/compute/docs/configure-instance-ip-addresses#reserve_new_static) for more on reserving static addresses.
|
|
requirements:
|
|
- "python >= 2.6"
|
|
- "apache-libcloud >= 0.19.0"
|
|
notes:
|
|
- Global addresses can only be used with Global Forwarding Rules.
|
|
author:
|
|
- "Tom Melendez (@supertom) <tom@supertom.com>"
|
|
options:
|
|
name:
|
|
type: str
|
|
description:
|
|
- Name of Address.
|
|
required: true
|
|
region:
|
|
type: str
|
|
description:
|
|
- Region to create the address in. Set to 'global' to create a global address.
|
|
required: true
|
|
state:
|
|
type: str
|
|
description: The state the address should be in. C(present) or C(absent) are the only valid options.
|
|
default: present
|
|
required: false
|
|
choices: [present, absent]
|
|
project_id:
|
|
type: str
|
|
description:
|
|
- The Google Cloud Platform project ID to use.
|
|
pem_file:
|
|
type: path
|
|
description:
|
|
- The path to the PEM file associated with the service account email.
|
|
- This option is deprecated and may be removed in a future release. Use I(credentials_file) instead.
|
|
credentials_file:
|
|
type: path
|
|
description:
|
|
- The path to the JSON file associated with the service account email.
|
|
service_account_email:
|
|
type: str
|
|
description:
|
|
- service account email
|
|
service_account_permissions:
|
|
type: list
|
|
description:
|
|
- service account permissions
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Create a Global external IP address
|
|
community.general.gce_eip:
|
|
service_account_email: "{{ service_account_email }}"
|
|
credentials_file: "{{ credentials_file }}"
|
|
project_id: "{{ project_id }}"
|
|
name: my-global-ip
|
|
region: global
|
|
state: present
|
|
|
|
- name: Create a Regional external IP address
|
|
community.general.gce_eip:
|
|
service_account_email: "{{ service_account_email }}"
|
|
credentials_file: "{{ credentials_file }}"
|
|
project_id: "{{ project_id }}"
|
|
name: my-global-ip
|
|
region: us-east1
|
|
state: present
|
|
'''
|
|
|
|
RETURN = '''
|
|
address:
|
|
description: IP address being operated on
|
|
returned: always
|
|
type: str
|
|
sample: "35.186.222.233"
|
|
name:
|
|
description: name of the address being operated on
|
|
returned: always
|
|
type: str
|
|
sample: "my-address"
|
|
region:
|
|
description: Which region an address belongs.
|
|
returned: always
|
|
type: str
|
|
sample: "global"
|
|
'''
|
|
|
|
USER_AGENT_VERSION = 'v1'
|
|
USER_AGENT_PRODUCT = 'Ansible-gce_eip'
|
|
|
|
try:
|
|
from ast import literal_eval
|
|
HAS_PYTHON26 = True
|
|
except ImportError:
|
|
HAS_PYTHON26 = False
|
|
|
|
try:
|
|
import libcloud
|
|
from libcloud.compute.types import Provider
|
|
from libcloud.compute.providers import get_driver
|
|
from libcloud.common.google import GoogleBaseError, QuotaExceededError, \
|
|
ResourceExistsError, ResourceInUseError, ResourceNotFoundError
|
|
from libcloud.compute.drivers.gce import GCEAddress
|
|
_ = Provider.GCE
|
|
HAS_LIBCLOUD = True
|
|
except ImportError:
|
|
HAS_LIBCLOUD = False
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.general.plugins.module_utils.gcp import gcp_connect
|
|
|
|
|
|
def get_address(gce, name, region):
|
|
"""
|
|
Get an Address from GCE.
|
|
|
|
:param gce: An initialized GCE driver object.
|
|
:type gce: :class: `GCENodeDriver`
|
|
|
|
:param name: Name of the Address.
|
|
:type name: ``str``
|
|
|
|
:return: A GCEAddress object or None.
|
|
:rtype: :class: `GCEAddress` or None
|
|
"""
|
|
try:
|
|
return gce.ex_get_address(name=name, region=region)
|
|
|
|
except ResourceNotFoundError:
|
|
return None
|
|
|
|
|
|
def create_address(gce, params):
|
|
"""
|
|
Create a new Address.
|
|
|
|
:param gce: An initialized GCE driver object.
|
|
:type gce: :class: `GCENodeDriver`
|
|
|
|
:param params: Dictionary of parameters needed by the module.
|
|
:type params: ``dict``
|
|
|
|
:return: Tuple with changed status and address.
|
|
:rtype: tuple in the format of (bool, str)
|
|
"""
|
|
changed = False
|
|
return_data = []
|
|
|
|
address = gce.ex_create_address(
|
|
name=params['name'], region=params['region'])
|
|
|
|
if address:
|
|
changed = True
|
|
return_data = address.address
|
|
|
|
return (changed, return_data)
|
|
|
|
|
|
def delete_address(address):
|
|
"""
|
|
Delete an Address.
|
|
|
|
:param gce: An initialized GCE driver object.
|
|
:type gce: :class: `GCENodeDriver`
|
|
|
|
:param params: Dictionary of parameters needed by the module.
|
|
:type params: ``dict``
|
|
|
|
:return: Tuple with changed status and address.
|
|
:rtype: tuple in the format of (bool, str)
|
|
"""
|
|
changed = False
|
|
return_data = []
|
|
if address.destroy():
|
|
changed = True
|
|
return_data = address.address
|
|
return (changed, return_data)
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(argument_spec=dict(
|
|
name=dict(required=True),
|
|
state=dict(choices=['absent', 'present'], default='present'),
|
|
region=dict(required=True),
|
|
service_account_email=dict(),
|
|
service_account_permissions=dict(type='list'),
|
|
pem_file=dict(type='path'),
|
|
credentials_file=dict(type='path'),
|
|
project_id=dict(), ), )
|
|
|
|
if not HAS_PYTHON26:
|
|
module.fail_json(
|
|
msg="GCE module requires python's 'ast' module, python v2.6+")
|
|
if not HAS_LIBCLOUD:
|
|
module.fail_json(
|
|
msg='libcloud with GCE support (+0.19) required for this module.')
|
|
|
|
gce = gcp_connect(module, Provider.GCE, get_driver,
|
|
USER_AGENT_PRODUCT, USER_AGENT_VERSION)
|
|
|
|
params = {}
|
|
params['state'] = module.params.get('state')
|
|
params['name'] = module.params.get('name')
|
|
params['region'] = module.params.get('region')
|
|
|
|
changed = False
|
|
json_output = {'state': params['state']}
|
|
address = get_address(gce, params['name'], region=params['region'])
|
|
|
|
if params['state'] == 'absent':
|
|
if not address:
|
|
# Doesn't exist in GCE, and state==absent.
|
|
changed = False
|
|
module.fail_json(
|
|
msg="Cannot delete unknown address: %s" %
|
|
(params['name']))
|
|
else:
|
|
# Delete
|
|
(changed, json_output['address']) = delete_address(address)
|
|
else:
|
|
if not address:
|
|
# Create
|
|
(changed, json_output['address']) = create_address(gce,
|
|
params)
|
|
else:
|
|
changed = False
|
|
json_output['address'] = address.address
|
|
|
|
json_output['changed'] = changed
|
|
json_output.update(params)
|
|
module.exit_json(**json_output)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|