mirror of https://github.com/ansible/ansible.git
[cloud] New module - AWS Direct Connect Gateway (#33890)
* Adding module for AWS Direct Connect Gateway * Fixes for failing checks * Fix errors for shippable checks * Fix pep8 errors * Fixes from review comments * Simplify logic and add exception handling for every boto3 call * Fix undefined variablepull/34069/head
Gobin Sougrakpam
7 years ago
committed by
Ryan Brown
parent
b5c0141fb0
commit
e2de3c9776
@ -0,0 +1,359 @@
|
||||
#!/usr/bin/python
|
||||
# Copyright: Ansible Project
|
||||
# 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
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: aws_direct_connect_gateway
|
||||
author: Gobin Sougrakpam (gobins@github)
|
||||
version_added: "2.5"
|
||||
short_description: Manage AWS Direct Connect Gateway.
|
||||
description:
|
||||
- Creates AWS Direct Connect Gateway
|
||||
- Deletes AWS Direct Connect Gateway
|
||||
- Attaches Virtual Gateways to Direct Connect Gateway
|
||||
- Detaches Virtual Gateways to Direct Connect Gateway
|
||||
requirements: [ boto3 ]
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- present to ensure resource is created.
|
||||
- absent to remove resource
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent"]
|
||||
name:
|
||||
description:
|
||||
- name of the dxgw to be created or deleted
|
||||
required: false
|
||||
amazon_asn:
|
||||
description:
|
||||
- amazon side asn
|
||||
required: true
|
||||
direct_connect_gateway_id:
|
||||
description:
|
||||
- id of an existing direct connect gateway
|
||||
required: false
|
||||
virtual_gateway_id:
|
||||
description:
|
||||
- vpn gateway id of an existing virtual gateway
|
||||
required: false
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create a new direct connect gateway attached to virtual private gateway
|
||||
dxgw:
|
||||
state: present
|
||||
name: my-dx-gateway
|
||||
amazon_asn: 7224
|
||||
virtual_gateway_id: vpg-12345
|
||||
register: created_dxgw
|
||||
|
||||
- name: Create a new unattached dxgw
|
||||
dxgw:
|
||||
state: present
|
||||
name: my-dx-gateway
|
||||
amazon_asn: 7224
|
||||
register: created_dxgw
|
||||
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
result:
|
||||
description:
|
||||
- The attributes of the Direct Connect Gateway
|
||||
type: complex
|
||||
returned: I(state=present)
|
||||
contains:
|
||||
amazon_side_asn:
|
||||
description: ASN on the amazon side.
|
||||
direct_connect_gateway_id:
|
||||
description: The ID of the direct connect gateway.
|
||||
direct_connect_gateway_name:
|
||||
description: The name of the direct connect gateway.
|
||||
direct_connect_gateway_state:
|
||||
description: The state of the direct connect gateway.
|
||||
owner_account:
|
||||
description: The AWS account ID of the owner of the direct connect gateway.
|
||||
'''
|
||||
|
||||
import time
|
||||
import traceback
|
||||
|
||||
try:
|
||||
import botocore
|
||||
HAS_BOTO3 = True
|
||||
except ImportError:
|
||||
HAS_BOTO3 = False
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.ec2 import (camel_dict_to_snake_dict, ec2_argument_spec,
|
||||
get_aws_connection_info, boto3_conn)
|
||||
from ansible.module_utils._text import to_native
|
||||
|
||||
|
||||
def dx_gateway_info(client, gateway_id, module):
|
||||
try:
|
||||
resp = client.describe_direct_connect_gateways(
|
||||
directConnectGatewayId=gateway_id)
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
if resp['directConnectGateways']:
|
||||
return resp['directConnectGateways'][0]
|
||||
|
||||
|
||||
def wait_for_status(client, module, gateway_id, virtual_gateway_id, status):
|
||||
polling_increment_secs = 15
|
||||
max_retries = 3
|
||||
status_achieved = False
|
||||
|
||||
for x in range(0, max_retries):
|
||||
try:
|
||||
response = check_dxgw_association(
|
||||
client,
|
||||
module,
|
||||
gateway_id=gateway_id,
|
||||
virtual_gateway_id=virtual_gateway_id)
|
||||
if response['directConnectGatewayAssociations']:
|
||||
if response['directConnectGatewayAssociations'][0]['associationState'] == status:
|
||||
status_achieved = True
|
||||
break
|
||||
else:
|
||||
time.sleep(polling_increment_secs)
|
||||
else:
|
||||
status_achieved = True
|
||||
break
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
|
||||
result = response
|
||||
return status_achieved, result
|
||||
|
||||
|
||||
def associate_direct_connect_gateway(client, module, gateway_id):
|
||||
params = dict()
|
||||
params['virtual_gateway_id'] = module.params.get('virtual_gateway_id')
|
||||
try:
|
||||
response = client.create_direct_connect_gateway_association(
|
||||
directConnectGatewayId=gateway_id,
|
||||
virtualGatewayId=params['virtual_gateway_id'])
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
|
||||
status_achieved, dxgw = wait_for_status(client, module, gateway_id, params['virtual_gateway_id'], 'associating')
|
||||
if not status_achieved:
|
||||
module.fail_json(msg='Error waiting for dxgw to attach to vpg - please check the AWS console')
|
||||
|
||||
result = response
|
||||
return result
|
||||
|
||||
|
||||
def delete_association(client, module, gateway_id, virtual_gateway_id):
|
||||
try:
|
||||
response = client.delete_direct_connect_gateway_association(
|
||||
directConnectGatewayId=gateway_id,
|
||||
virtualGatewayId=virtual_gateway_id)
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
|
||||
status_achieved, dxgw = wait_for_status(client, module, gateway_id, virtual_gateway_id, 'disassociating')
|
||||
if not status_achieved:
|
||||
module.fail_json(msg='Error waiting for dxgw to detach from vpg - please check the AWS console')
|
||||
|
||||
result = response
|
||||
return result
|
||||
|
||||
|
||||
def create_dx_gateway(client, module):
|
||||
params = dict()
|
||||
params['name'] = module.params.get('name')
|
||||
params['amazon_asn'] = module.params.get('amazon_asn')
|
||||
try:
|
||||
response = client.create_direct_connect_gateway(
|
||||
directConnectGatewayName=params['name'],
|
||||
amazonSideAsn=int(params['amazon_asn']))
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
|
||||
result = response
|
||||
return result
|
||||
|
||||
|
||||
def find_dx_gateway(client, module, gateway_id=None):
|
||||
params = dict()
|
||||
gateways = list()
|
||||
if gateway_id is not None:
|
||||
params['directConnectGatewayId'] = gateway_id
|
||||
while True:
|
||||
try:
|
||||
resp = client.describe_direct_connect_gateways(**params)
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
gateways.extend(resp['directConnectGateways'])
|
||||
if 'nextToken' in resp:
|
||||
params['nextToken'] = resp['nextToken']
|
||||
else:
|
||||
break
|
||||
if gateways != []:
|
||||
count = 0
|
||||
for gateway in gateways:
|
||||
if module.params.get('name') == gateway['directConnectGatewayName']:
|
||||
count += 1
|
||||
return gateway
|
||||
return None
|
||||
|
||||
|
||||
def check_dxgw_association(client, module, gateway_id, virtual_gateway_id=None):
|
||||
try:
|
||||
if virtual_gateway_id is None:
|
||||
resp = client.describe_direct_connect_gateway_associations(
|
||||
directConnectGatewayId=gateway_id
|
||||
)
|
||||
else:
|
||||
resp = client.describe_direct_connect_gateway_associations(
|
||||
directConnectGatewayId=gateway_id,
|
||||
virtualGatewayId=virtual_gateway_id,
|
||||
)
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
return resp
|
||||
|
||||
|
||||
def ensure_present(client, module):
|
||||
# If an existing direct connect gateway matches our args
|
||||
# then a match is considered to have been found and we will not create another dxgw.
|
||||
|
||||
changed = False
|
||||
params = dict()
|
||||
result = dict()
|
||||
params['name'] = module.params.get('name')
|
||||
params['amazon_asn'] = module.params.get('amazon_asn')
|
||||
params['virtual_gateway_id'] = module.params.get('virtual_gateway_id')
|
||||
|
||||
# check if a gateway matching our module args already exists
|
||||
existing_dxgw = find_dx_gateway(client, module)
|
||||
|
||||
if existing_dxgw is not None and existing_dxgw['directConnectGatewayState'] != 'deleted':
|
||||
gateway_id = existing_dxgw['directConnectGatewayId']
|
||||
# if a gateway_id was provided, check if it is attach to the DXGW
|
||||
if params['virtual_gateway_id']:
|
||||
resp = check_dxgw_association(
|
||||
client,
|
||||
module,
|
||||
gateway_id=gateway_id,
|
||||
virtual_gateway_id=params['virtual_gateway_id'])
|
||||
if not resp["directConnectGatewayAssociations"]:
|
||||
# attach the dxgw to the supplied virtual_gateway_id
|
||||
associate_direct_connect_gateway(client, module, gateway_id)
|
||||
changed = True
|
||||
# if params['virtual_gateway_id'] is not provided, check the dxgw is attached to a VPG. If so, detach it.
|
||||
else:
|
||||
existing_dxgw = find_dx_gateway(client, module)
|
||||
|
||||
resp = check_dxgw_association(client, module, gateway_id=gateway_id)
|
||||
if resp["directConnectGatewayAssociations"]:
|
||||
for association in resp['directConnectGatewayAssociations']:
|
||||
if association['associationState'] not in ['disassociating', 'disassociated']:
|
||||
delete_association(
|
||||
client,
|
||||
module,
|
||||
gateway_id=gateway_id,
|
||||
virtual_gateway_id=association['virtualGatewayId'])
|
||||
else:
|
||||
# create a new dxgw
|
||||
new_dxgw = create_dx_gateway(client, module)
|
||||
changed = True
|
||||
gateway_id = new_dxgw['directConnectGateway']['directConnectGatewayId']
|
||||
|
||||
# if a vpc-id was supplied, attempt to attach it to the dxgw
|
||||
if params['virtual_gateway_id']:
|
||||
associate_direct_connect_gateway(client, module, gateway_id)
|
||||
resp = check_dxgw_association(client,
|
||||
module,
|
||||
gateway_id=gateway_id
|
||||
)
|
||||
if resp["directConnectGatewayAssociations"]:
|
||||
changed = True
|
||||
|
||||
result = dx_gateway_info(client, gateway_id, module)
|
||||
return changed, result
|
||||
|
||||
|
||||
def ensure_absent(client, module):
|
||||
# If an existing direct connect gateway matches our args
|
||||
# then a match is considered to have been found and we will not create another dxgw.
|
||||
|
||||
changed = False
|
||||
result = dict()
|
||||
dx_gateway_id = module.params.get('direct_connect_gateway_id')
|
||||
existing_dxgw = find_dx_gateway(client, module, dx_gateway_id)
|
||||
if existing_dxgw is not None:
|
||||
resp = check_dxgw_association(client, module,
|
||||
gateway_id=dx_gateway_id)
|
||||
if resp["directConnectGatewayAssociations"]:
|
||||
for association in resp['directConnectGatewayAssociations']:
|
||||
if association['associationState'] not in ['disassociating', 'disassociated']:
|
||||
delete_association(client, module,
|
||||
gateway_id=dx_gateway_id,
|
||||
virtual_gateway_id=association['virtualGatewayId'])
|
||||
# wait for deleting association
|
||||
timeout = time.time() + module.params.get('wait_timeout')
|
||||
while time.time() < timeout:
|
||||
resp = check_dxgw_association(client,
|
||||
module,
|
||||
gateway_id=dx_gateway_id)
|
||||
if resp["directConnectGatewayAssociations"] != []:
|
||||
time.sleep(15)
|
||||
else:
|
||||
break
|
||||
|
||||
try:
|
||||
resp = client.delete_direct_connect_gateway(
|
||||
directConnectGatewayId=dx_gateway_id
|
||||
)
|
||||
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
result = resp['directConnectGateway']
|
||||
return changed
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = ec2_argument_spec()
|
||||
argument_spec.update(dict(state=dict(default='present', choices=['present', 'absent']),
|
||||
name=dict(),
|
||||
amazon_asn=dict(),
|
||||
virtual_gateway_id=dict(),
|
||||
direct_connect_gateway_id=dict(),
|
||||
wait_timeout=dict(type='int', default=320)))
|
||||
required_if = [('state', 'present', ['name', 'amazon_asn']),
|
||||
('state', 'absent', ['direct_connect_gateway_id'])]
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
required_if=required_if)
|
||||
|
||||
if not HAS_BOTO3:
|
||||
module.fail_json(msg='boto3 is required for this module')
|
||||
|
||||
state = module.params.get('state')
|
||||
|
||||
region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module, boto3=True)
|
||||
client = boto3_conn(module, conn_type='client', resource='directconnect', region=region, endpoint=ec2_url, **aws_connect_kwargs)
|
||||
|
||||
if state == 'present':
|
||||
(changed, results) = ensure_present(client, module)
|
||||
elif state == 'absent':
|
||||
changed = ensure_absent(client, module)
|
||||
results = {}
|
||||
|
||||
module.exit_json(changed=changed, **camel_dict_to_snake_dict(results))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in New Issue