Improve route53_facts to modern Ansible standards #31860

willthames · 2017-10-18T02:42:22Z

SUMMARY

Use built in retries, pagination
Return snake case
Document returns
Better tag handling

Fixes #49457

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

route53_facts

ANSIBLE VERSION

ansible 2.5.0 (devel 7623c2fbda) last updated 2017/10/18 12:38:39 (GMT +1000)
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/will/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/will/src/ansible/lib/ansible
  executable location = /home/will/src/ansible/bin/ansible
  python version = 2.7.13 (default, Sep  5 2017, 08:53:59) [GCC 7.1.1 20170622 (Red Hat 7.1.1-3)]

willthames · 2017-10-18T02:45:25Z

There are a lot of changes here, but given the module's current return values are undocumented and the module is in preview status, I hope that the changes are acceptable.

I have tested them against my existing route53 resources, they seem to work

ansibot · 2017-10-18T02:47:24Z

cc @Etherdaemon
click here for bot help

willthames · 2017-10-18T02:50:45Z

@mikedlr this PR contains a change to module_utils.aws.core to support the deprecate method.

weisslj · 2017-10-19T12:26:06Z

I have tested this with our current route53 setup, which works.

s-hertel · 2017-10-31T14:44:25Z

lib/ansible/modules/cloud/amazon/route53_facts.py

+    try:
+        return list_record_sets_with_backoff(client, params)
+    except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
+        module.fail_json_aws(e, msg="Couldn't list record sets")


If providing a hosted_zone_id that has been removed, this fails. Should it fail, or should record sets just be an empty dict if e.response['Error']['Code'] == 'NoSuchHostedZone' in list_record_sets_with_backoff()? Wondered something similar throughout reading this PR in a number of other places too.

Thanks for this spot @s-hertel - it's a great catch. To be honest I think it's a flaw with AWSRetry that this happens - retries for not found should be handled by calling functions.

But until there's consensus on that, I'll add a fix for this.

Edit: Ah, I'm thinking of retries for NotFound codes, this is a different situation. It's a tough call - I'm not sure whether it's better to return an empty result for a non existent hosted zone - in some ways the error message is clearer.

s-hertel · 2017-10-31T14:52:10Z

lib/ansible/modules/cloud/amazon/route53_facts.py

-
-        results = client.list_reusable_delegation_sets(**params)
-    else:
+    if module.params.get('delegation_set_id'):
        params['DelegationSetId'] = module.params.get('delegation_set_id')


I think 'DelegationSetId' needs to be 'Id'.

Wow, I did not change this, how long has this bug been present! (Thanks again for spotting this)

s-hertel · 2017-10-31T14:58:11Z

lib/ansible/modules/cloud/amazon/route53_facts.py

-    next_marker: "{{ first_facts.NextMarker }}"
-    max_items: 1
-  when: "{{ 'NextMarker' in first_facts }}"
+RETURN = '''


Hurrah for RETURN docs :)

* Use built in retries, pagination * Return snake case * Document returns * Better tag handling * Deprecate resource_id parameter * Deprecate tags query method * Fail on multiple resource_ids

willthames · 2017-11-01T02:48:00Z

@s-hertel I've fixed the delegation set id bug. I think a module failure for a non existent hosted zone seems reasonable.

ryansb · 2017-11-02T18:46:26Z

lib/ansible/modules/cloud/amazon/route53_facts.py

@@ -43,15 +43,8 @@
    required: false
  max_items:
    description:
-      - Maximum number of items to return for various get/list requests
-    required: false
-  next_marker:


Why delete the docs for the next_marker? IMO we should entirely remove the max_items and next_marker settings and use pagination internally, there doesn't seem to be a good reason to expose these. Obviously needs to be supported still for the deprecation cycle, but it seems like unnecessary complexity.

ryansb · 2017-11-02T18:47:01Z

lib/ansible/modules/cloud/amazon/route53_facts.py

- name: setup of example for using next_marker
-  route53_facts:
-    query: hosted_zone
-    max_items: 1


I get de-emphasizing next marker, but we shouldn't remove the example entirely I don't think.

ryansb · 2017-11-07T21:45:05Z

lib/ansible/modules/cloud/amazon/route53_facts.py

+    resource_id = module.params.get('resource_id')
+    if resource_id:
+        if len(resource_id) > 1:
+            module.fail_json(msg='Using multiple resource_ids is no longer supported. Use a loop')


I don't think we can fail out on this without a deprecation cycle first.

bkmeneguello · 2019-07-11T16:43:52Z

Hey, there is something preventing this PR to be merged? I usually need to workaround the route53 info module because of this problem, and this PR works very well.

ansibot · 2020-01-31T23:22:57Z

cc @jillr @tremble
click here for bot help

ansibot · 2020-08-16T23:02:28Z

Thank you very much for your interest in Ansible. Ansible has migrated much of the content into separate repositories to allow for more rapid, independent development. We are closing this issue/PR because this content has been moved to one or more collection repositories.

lib/ansible/modules/cloud/amazon/route53_facts.py -> https://galaxy.ansible.com/community/aws
lib/ansible/module_utils/aws/core.py -> https://galaxy.ansible.com/amazon/aws

For further information, please see:
https://github.com/ansible/ansibullbot/blob/master/docs/collection_migration.md

willthames force-pushed the route53_facts branch from e58b4f9 to c0fe95b Compare October 18, 2017 02:48

willthames mentioned this pull request Oct 18, 2017

[cloud] Add CAA record type to route53 #29178

Merged

willthames requested review from s-hertel and ryansb October 18, 2017 02:50

willthames force-pushed the route53_facts branch from c0fe95b to dc87d69 Compare October 18, 2017 05:25

gundalow removed the needs_triage Needs a first human triage before being processed. label Oct 18, 2017

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Oct 27, 2017

s-hertel reviewed Oct 31, 2017

View reviewed changes

Improve route53_facts to modern Ansible standards

0635992

* Use built in retries, pagination * Return snake case * Document returns * Better tag handling * Deprecate resource_id parameter * Deprecate tags query method * Fail on multiple resource_ids

willthames force-pushed the route53_facts branch from dc87d69 to 0635992 Compare November 1, 2017 02:47

ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Nov 1, 2017

ryansb suggested changes Nov 7, 2017

View reviewed changes

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Nov 7, 2017

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Nov 15, 2017

ansibot added the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Nov 23, 2017

ansibot added the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Feb 14, 2018

ansibot added feature This issue/PR relates to a feature request. and removed feature_pull_request labels Mar 2, 2018

ansibot added needs_maintainer Ansibot is unable to identify maintainers for this PR. (Check `author` in docs or BOTMETA.yml) and removed support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 5, 2018

ansibot removed the needs_maintainer Ansibot is unable to identify maintainers for this PR. (Check `author` in docs or BOTMETA.yml) label Nov 10, 2018

ansibot added new_module This PR includes a new module. new_plugin This PR includes a new plugin. labels Jun 11, 2019

ansibot removed the new_module This PR includes a new module. label Mar 28, 2020

ansibot added collection Related to Ansible Collections work collection:amazon.aws collection:community.aws needs_collection_redirect https://github.com/ansible/ansibullbot/blob/master/docs/collection_migration.md labels Apr 29, 2020

ansibot added the bot_closed label Aug 16, 2020

ansibot closed this Aug 16, 2020

ansible locked and limited conversation to collaborators Sep 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve route53_facts to modern Ansible standards #31860

Improve route53_facts to modern Ansible standards #31860

willthames commented Oct 18, 2017 •

edited by s-hertel

Loading

willthames commented Oct 18, 2017

ansibot commented Oct 18, 2017

willthames commented Oct 18, 2017

weisslj commented Oct 19, 2017

s-hertel Oct 31, 2017

willthames Nov 1, 2017 •

edited

Loading

s-hertel Oct 31, 2017

willthames Nov 1, 2017

s-hertel Oct 31, 2017

willthames commented Nov 1, 2017

ryansb Nov 2, 2017

ryansb Nov 2, 2017

ryansb Nov 7, 2017

bkmeneguello commented Jul 11, 2019

ansibot commented Jan 31, 2020

ansibot commented Aug 16, 2020

Improve route53_facts to modern Ansible standards #31860

Improve route53_facts to modern Ansible standards #31860

Conversation

willthames commented Oct 18, 2017 • edited by s-hertel Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

willthames commented Oct 18, 2017

ansibot commented Oct 18, 2017

willthames commented Oct 18, 2017

weisslj commented Oct 19, 2017

s-hertel Oct 31, 2017

Choose a reason for hiding this comment

willthames Nov 1, 2017 • edited Loading

Choose a reason for hiding this comment

s-hertel Oct 31, 2017

Choose a reason for hiding this comment

willthames Nov 1, 2017

Choose a reason for hiding this comment

s-hertel Oct 31, 2017

Choose a reason for hiding this comment

willthames commented Nov 1, 2017

ryansb Nov 2, 2017

Choose a reason for hiding this comment

ryansb Nov 2, 2017

Choose a reason for hiding this comment

ryansb Nov 7, 2017

Choose a reason for hiding this comment

bkmeneguello commented Jul 11, 2019

ansibot commented Jan 31, 2020

ansibot commented Aug 16, 2020

willthames commented Oct 18, 2017 •

edited by s-hertel

Loading

willthames Nov 1, 2017 •

edited

Loading