Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add NotFound retries when tagging a new RouteTable #616

Merged
merged 3 commits into from
Jun 29, 2021
Merged

Add NotFound retries when tagging a new RouteTable #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2db282
ec2_vpc_route_table - use ensure_ec2_tags
tremble Jun 29, 2021
7d0ddb0
Retry on InvalidRouteTableID.NotFound, to work around race conditions
tremble Jun 29, 2021
c298dca
changelog
tremble Jun 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelogs/fragments/616-ec2_vpc_route_table-tagging.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
bugfixes:
- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616).
minor_changes:
- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616).
68 changes: 11 additions & 57 deletions plugins/modules/ec2_vpc_route_table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,10 +238,9 @@
from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule
from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import ansible_dict_to_boto3_filter_list
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import ansible_dict_to_boto3_tag_list
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import boto3_tag_list_to_ansible_dict
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_aws_tags
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import describe_ec2_tags
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import ensure_ec2_tags
from ansible_collections.amazon.aws.plugins.module_utils.waiters import get_waiter


Expand All @@ -257,14 +256,6 @@ def describe_igws_with_backoff(connection, **params):
return paginator.paginate(**params).build_full_result()['InternetGateways']


@AWSRetry.jittered_backoff()
def describe_tags_with_backoff(connection, resource_id):
filters = ansible_dict_to_boto3_filter_list({'resource-id': resource_id})
paginator = connection.get_paginator('describe_tags')
tags = paginator.paginate(Filters=filters).build_full_result()['Tags']
return boto3_tag_list_to_ansible_dict(tags)


@AWSRetry.jittered_backoff()
def describe_route_tables_with_backoff(connection, **params):
try:
Expand Down Expand Up @@ -349,45 +340,6 @@ def tags_match(match_tags, candidate_tags):
for k, v in match_tags.items()))


def ensure_tags(connection=None, module=None, resource_id=None, tags=None, purge_tags=None, check_mode=None):
try:
cur_tags = describe_tags_with_backoff(connection, resource_id)
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, msg='Unable to list tags for VPC')

to_add, to_delete = compare_aws_tags(cur_tags, tags, purge_tags)

if not to_add and not to_delete:
return {'changed': False, 'tags': cur_tags}
if check_mode:
if not purge_tags:
tags = cur_tags.update(tags)
return {'changed': True, 'tags': tags}

if to_delete:
try:
connection.delete_tags(
aws_retry=True,
Resources=[resource_id],
Tags=[{'Key': k} for k in to_delete])
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, msg="Couldn't delete tags")
if to_add:
try:
connection.create_tags(
aws_retry=True,
Resources=[resource_id],
Tags=ansible_dict_to_boto3_tag_list(to_add))
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, msg="Couldn't create tags")

try:
latest_tags = describe_tags_with_backoff(connection, resource_id)
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, msg='Unable to list tags for VPC')
return {'changed': True, 'tags': latest_tags}


def get_route_table_by_id(connection, module, route_table_id):

route_table = None
Expand All @@ -410,7 +362,7 @@ def get_route_table_by_tags(connection, module, vpc_id, tags):
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, msg="Couldn't get route table")
for table in route_tables:
this_tags = describe_tags_with_backoff(connection, table['RouteTableId'])
this_tags = describe_ec2_tags(connection, module, table['RouteTableId'])
if tags_match(tags, this_tags):
route_table = table
count += 1
Expand Down Expand Up @@ -625,7 +577,7 @@ def ensure_route_table_absent(connection, module):
def get_route_table_info(connection, module, route_table):
result = get_route_table_by_id(connection, module, route_table['RouteTableId'])
try:
result['Tags'] = describe_tags_with_backoff(connection, route_table['RouteTableId'])
result['Tags'] = describe_ec2_tags(connection, module, route_table['RouteTableId'])
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, msg="Couldn't get tags for route table")
result = camel_dict_to_snake_dict(result, ignore_list=['Tags'])
Expand Down Expand Up @@ -711,10 +663,10 @@ def ensure_route_table_present(connection, module):
changed = changed or result['changed']

if not tags_valid and tags is not None:
result = ensure_tags(connection=connection, module=module, resource_id=route_table['RouteTableId'], tags=tags,
purge_tags=purge_tags, check_mode=module.check_mode)
route_table['Tags'] = result['tags']
changed = changed or result['changed']
changed |= ensure_ec2_tags(connection, module, route_table['RouteTableId'],
tags=tags, purge_tags=purge_tags,
retry_codes=['InvalidRouteTableID.NotFound'])
route_table['Tags'] = describe_ec2_tags(connection, module, route_table['RouteTableId'])

if subnets is not None:
associated_subnets = find_subnets(connection, module, vpc_id, subnets)
Expand Down Expand Up @@ -751,7 +703,9 @@ def main():
['state', 'present', ['vpc_id']]],
supports_check_mode=True)

retry_decorator = AWSRetry.jittered_backoff(retries=10)
# The tests for RouteTable existing uses its own decorator, we can safely
# retry on InvalidRouteTableID.NotFound
retry_decorator = AWSRetry.jittered_backoff(retries=10, catch_extra_error_codes=['InvalidRouteTableID.NotFound'])
connection = module.client('ec2', retry_decorator=retry_decorator)

state = module.params.get('state')
Expand Down