CHANGELOG.rst

Community DNS Collection Release Notes

Topics

• v2.0.1
  • Release Summary
  • Bugfixes
• v2.0.0
  • Release Summary
  • Minor Changes
  • Breaking Changes / Porting Guide
  • Deprecated Features
  • Bugfixes
  • New Plugins
    • Inventory
  • New Modules
• v1.2.0
  • Release Summary
  • Minor Changes
  • Bugfixes
• v1.1.0
  • Release Summary
  • Minor Changes
  • Bugfixes
• v1.0.1
  • Release Summary
  • Bugfixes
• v1.0.0
  • Release Summary
  • Bugfixes
• v0.3.0
  • Release Summary
  • Minor Changes
  • Bugfixes
  • New Modules
• v0.2.0
  • Release Summary
  • Major Changes
  • Minor Changes
  • Breaking Changes / Porting Guide
  • Bugfixes
  • New Modules
• v0.1.0
  • Release Summary
  • New Plugins
    • Filter
  • New Modules

v2.0.1

Release Summary

Maintenance release with Public Suffix List updates.

Bugfixes

• Update Public Suffix List.

v2.0.0

Release Summary

This release contains many new features, modules and plugins, but also has several breaking changes to the 1.x.y versions. Please read the changelog carefully to determine what to change if you used an earlier version of this collection.

Minor Changes

• Add support for Hetzner DNS (ansible-collections#27).
• Added a txt_transformation option to all modules and plugins working with DNS records (ansible-collections#48, ansible-collections#57, ansible-collections#60).
• The hosttech_dns_records module has been renamed to hosttech_dns_record_sets (ansible-collections#31).
• The internal API now supports bulk DNS record changes, if supported by the API (ansible-collections#39).
• The internal record API allows to manage extra data (ansible-collections#63).
• Use HTTP helper class to make API implementations work for both plugins and modules. Make WSDL API use fetch_url instead of open_url for modules (ansible-collections#36).
• hetzner_dns_record and hosttech_dns_record - when not using check mode, use actual return data for diff, instead of input data, so that extra data can be shown (ansible-collections#63).
• hetzner_dns_zone_info - the legacy_ns return value is now sorted, since its order is unstable (ansible-collections#46).
• hosttech_dns_* modules - rename zone parameter to zone_name. The old name zone can still be used as an alias (ansible-collections#32).
• hosttech_dns_record_set - value is no longer required when state=absent and overwrite=true (ansible-collections#31).
• hosttech_dns_record_sets - records has been renamed to record_sets. The old name records can still be used as an alias (ansible-collections#31).
• hosttech_dns_zone_info - return extra information as zone_info (ansible-collections#38).

Breaking Changes / Porting Guide

• All Hetzner modules and plugins which handle DNS records now work with unquoted TXT values by default. The old behavior can be obtained by setting txt_transformation=api (ansible-collections#48, ansible-collections#57, ansible-collections#60).
• Hosttech API creation - now requires a ModuleOptionProvider object instead of an AnsibleModule object. Alternatively an Ansible plugin instance can be passed (ansible-collections#37).
• The hetzner_dns_record_info and hosttech_dns_record_info modules have been renamed to hetzner_dns_record_set_info and hosttech_dns_record_set_info, respectively (ansible-collections#54).
• The hosttech_dns_record module has been renamed to hosttech_dns_record_set (ansible-collections#31).
• The internal bulk record updating helper (bulk_apply_changes) now also returns the records that were deleted, created or updated (ansible-collections#63).
• The internal record API no longer allows to manage comments explicitly (ansible-collections#63).
• When using the internal modules API, now a zone ID type and a provider information object must be passed (ansible-collections#27).
• hetzner_dns_record* modules - implement correct handling of default TTL. The value none is now accepted and returned in this case (ansible-collections#52, ansible-collections#50).
• hetzner_dns_record, hetzner_dns_record_set, hetzner_dns_record_sets - the default TTL is now 300 and no longer 3600, which equals the default in the web console (ansible-collections#43).
• hosttech_dns_record_set - the option overwrite was replaced by a new option on_existing. Specifying overwrite=true is equivalent to on_existing=replace (the new default). Specifying overwrite=false with state=present is equivalent to on_existing=keep_and_fail, and specifying overwrite=false with state=absent is equivalent to on_existing=keep (ansible-collections#31).

Deprecated Features

• The hosttech_dns_records module has been renamed to hosttech_dns_record_sets. The old name will stop working in community.dns 3.0.0 (ansible-collections#31).

Bugfixes

• Hetzner API - interpret missing TTL as 300, which is what the web console also does (ansible-collections#42).
• Update Public Suffix List.
• Update Public Suffix List.
• Update Public Suffix List.
• hetzner API code - make sure to also handle errors returned by the API if the HTTP status code indicates success. This sometimes happens for 500 Internal Server Error (ansible-collections#58).
• hosttech_dns_zone_info - make sure that full information is returned both when requesting a zone by ID or by name (ansible-collections#56).
• wait_for_txt - fix handling of too long TXT values (ansible-collections#65).
• wait_for_txt - resolving nameservers sometimes resulted in an empty list, yielding wrong results (ansible-collections#64).

New Plugins

Inventory

• community.dns.hetzner_dns_records - Create inventory from Hetzner DNS records
• community.dns.hosttech_dns_records - Create inventory from Hosttech DNS records

New Modules

• community.dns.hetzner_dns_record - Add or delete a single record in Hetzner DNS service
• community.dns.hetzner_dns_record_info - Retrieve records in Hetzner DNS service
• community.dns.hetzner_dns_record_set - Add or delete record sets in Hetzner DNS service
• community.dns.hetzner_dns_record_set_info - Retrieve record sets in Hetzner DNS service
• community.dns.hetzner_dns_record_sets - Bulk synchronize DNS record sets in Hetzner DNS service
• community.dns.hetzner_dns_zone_info - Retrieve zone information in Hetzner DNS service
• community.dns.hosttech_dns_record - Add or delete a single record in Hosttech DNS service
• community.dns.hosttech_dns_record_info - Retrieve records in Hosttech DNS service
• community.dns.hosttech_dns_record_set - Add or delete record sets in Hosttech DNS service
• community.dns.hosttech_dns_record_sets - Bulk synchronize DNS record sets in Hosttech DNS service

v1.2.0

Release Summary

Last minor 1.x.0 version. The 2.0.0 version will have some backwards incompatible changes to the hosttech_dns_record and hosttech_dns_records modules which will require user intervention. These changes should result in a better UX.

Minor Changes

• hosttech modules - add api_token alias for hosttech_token (ansible-collections#26).
• hosttech_dns_record - in diff mode, also return diff data structure when changed is false (ansible-collections#28).
• module utils - add default implementation for some zone/record API functions, and move common JSON API code to helper class (ansible-collections#26).

Bugfixes

• Update Public Suffix List.
• hosttech_dns_record - correctly handle quoting in CAA records for JSON API (ansible-collections#30).

v1.1.0

Release Summary

Regular maintenance release.

Minor Changes

• Avoid internal ansible-core module_utils in favor of equivalent public API available since at least Ansible 2.9 (ansible-collections#24).

Bugfixes

• Update Public Suffix List.

v1.0.1

Release Summary

Regular maintenance release.

Bugfixes

• Update Public Suffix List.

v1.0.0

Release Summary

First stable release.

Bugfixes

• Update Public Suffix List.

v0.3.0

Release Summary

Fixes bugs, adds rate limiting for Hosttech JSON API, and adds a new bulk synchronization module.

Minor Changes

• hosttech_dns_* - handle 419 Too Many Requests with proper rate limiting for JSON API (ansible-collections#14).

Bugfixes

• Avoid converting ASCII labels which contain underscores or other printable ASCII characters outside [a-zA-Z0-9-] to alabels during normalization (ansible-collections#13).
• Updated Public Suffix List.

New Modules

• community.dns.hosttech_dns_records - Bulk synchronize DNS records in Hosttech DNS service

v0.2.0

Release Summary

Major refactoring release, which adds a zone information module and supports HostTech's new REST API.

Major Changes

• hosttech_* modules - support the new JSON API at https://api.ns1.hosttech.eu/api/documentation/ (ansible-collections#4).

Minor Changes

• hosttech_dns_record* modules - allow to specify prefix instead of record (ansible-collections#8).
• hosttech_dns_record* modules - allow to specify zone by ID with the zone_id parameter, alternatively to the zone parameter (ansible-collections#7).
• hosttech_dns_record* modules - return zone_id on success (ansible-collections#7).
• hosttech_dns_record* modules - support IDN domain names and prefixes (ansible-collections#9).
• hosttech_dns_record_info - also return prefix for a record set (ansible-collections#8).
• hosttech_record - allow to delete records without querying their content first by specifying overwrite=true (ansible-collections#4).

Breaking Changes / Porting Guide

• hosttech_* module_utils - completely rewrite and refactor to support new JSON API and allow to re-use provider-independent module logic (ansible-collections#4).

Bugfixes

• Update Public Suffix List.
• hosttech_record - fix diff mode for state=absent (ansible-collections#4).
• hosttech_record_info - fix authentication error handling (ansible-collections#4).

New Modules

• community.dns.hosttech_dns_zone_info - Retrieve zone information in Hosttech DNS service

v0.1.0

Release Summary

Initial public release.

New Plugins

Filter

• community.dns.get_public_suffix - Returns the public suffix of a DNS name
• community.dns.get_registrable_domain - Returns the registrable domain name of a DNS name
• community.dns.remove_public_suffix - Removes the public suffix from a DNS name
• community.dns.remove_registrable_domain - Removes the registrable domain name from a DNS name

New Modules

• community.dns.hosttech_dns_record - Add or delete entries in Hosttech DNS service
• community.dns.hosttech_dns_record_info - Retrieve entries in Hosttech DNS service
• community.dns.wait_for_txt - Wait for TXT entries to be available on all authoritative nameservers