diff --git a/CHANGELOG.md b/CHANGELOG.md index afc6d3a..5e3a8a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,90 +2,124 @@ **Topics** -- v2\.0\.3 +- v2\.1\.0 - Release Summary -- v2\.0\.2 + - Minor Changes + - Deprecated Features + - New Modules +- v2\.0\.3 - Release Summary -- v2\.0\.1 +- v2\.0\.2 - Release Summary +- v2\.0\.1 + - Release Summary - Bugfixes - v2\.0\.0 - - Release Summary + - Release Summary - Major Changes - - Minor Changes + - Minor Changes - Breaking Changes / Porting Guide - Removed Features \(previously deprecated\) - v1\.9\.2 - - Release Summary + - Release Summary - Bugfixes - v1\.9\.1 - - Release Summary + - Release Summary - Security Fixes - v1\.9\.0 - - Release Summary - - Minor Changes - - Deprecated Features -- v1\.8\.2 - Release Summary + - Minor Changes + - Deprecated Features +- v1\.8\.2 + - Release Summary - Bugfixes - v1\.8\.1 - - Release Summary + - Release Summary - Known Issues - v1\.8\.0 - - Release Summary + - Release Summary - Major Changes - - Minor Changes + - Minor Changes - v1\.7\.0 - - Release Summary - - New Modules -- v1\.6\.0 - Release Summary - - Minor Changes -- v1\.5\.2 + - New Modules +- v1\.6\.0 - Release Summary - Minor Changes -- v1\.5\.1 +- v1\.5\.2 - Release Summary -- v1\.5\.0 - - Release Summary - Minor Changes -- v1\.4\.0 +- v1\.5\.1 + - Release Summary +- v1\.5\.0 - Release Summary - Minor Changes -- v1\.3\.1 +- v1\.4\.0 - Release Summary + - Minor Changes +- v1\.3\.1 + - Release Summary - Bugfixes - v1\.3\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - v1\.2\.3 - - Release Summary -- v1\.2\.2 - Release Summary +- v1\.2\.2 + - Release Summary - Bugfixes - v1\.2\.1 - - Release Summary - - Minor Changes -- v1\.2\.0 - Release Summary - Minor Changes - - New Modules -- v1\.1\.1 +- v1\.2\.0 - Release Summary + - Minor Changes + - New Modules +- v1\.1\.1 + - Release Summary - Bugfixes - v1\.1\.0 - - Release Summary + - Release Summary - New Plugins - Inventory - v1\.0\.0 - - Release Summary + - Release Summary - Breaking Changes / Porting Guide + +## v2\.1\.0 + + +### Release Summary + +Feature release with several new modules and a deprecation\. + + +### Minor Changes + +* All modules and plugins now have a rate\_limit\_retry\_timeout option\, which allows to configure for how long to wait in case of rate limiting errors\. By default\, the modules wait indefinitely\. Setting the option to 0 does not retry \(this was the behavior in previous versions\)\, and a positive value sets a number of seconds to wait at most \([https\://github\.com/ansible\-collections/community\.hrobot/pull/140](https\://github\.com/ansible\-collections/community\.hrobot/pull/140)\)\. +* boot \- it is now possible to specify SSH public keys in authorized\_keys\. The fingerprint needed by the Robot API will be extracted automatically \([https\://github\.com/ansible\-collections/community\.hrobot/pull/134](https\://github\.com/ansible\-collections/community\.hrobot/pull/134)\)\. +* v\_switch \- the module is now part of the community\.hrobot\.robot action group\, despite already being documented as part of it \([https\://github\.com/ansible\-collections/community\.hrobot/pull/136](https\://github\.com/ansible\-collections/community\.hrobot/pull/136)\)\. + + +### Deprecated Features + +* boot \- the various arch suboptions have been deprecated and will be removed from community\.hrobot 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.hrobot/pull/134](https\://github\.com/ansible\-collections/community\.hrobot/pull/134)\)\. + + +### New Modules + +* community\.hrobot\.storagebox \- Modify a storage box\'s basic configuration\. +* community\.hrobot\.storagebox\_info \- Query information on one or more storage boxes\. +* community\.hrobot\.storagebox\_set\_password \- \(Re\)set the password for a storage box\. +* community\.hrobot\.storagebox\_snapshot\_plan \- Modify a storage box\'s snapshot plans\. +* community\.hrobot\.storagebox\_snapshot\_plan\_info \- Query the snapshot plans for a storage box\. + ## v2\.0\.3 - + ### Release Summary Maintenance release with updated documentation\. @@ -93,7 +127,7 @@ Maintenance release with updated documentation\. ## v2\.0\.2 - + ### Release Summary Maintenance release with updated documentation\. @@ -101,7 +135,7 @@ Maintenance release with updated documentation\. ## v2\.0\.1 - + ### Release Summary Bugfix release\. @@ -114,7 +148,7 @@ Bugfix release\. ## v2\.0\.0 - + ### Release Summary New major release 2\.0\.0\. @@ -124,7 +158,7 @@ New major release 2\.0\.0\. * The community\.hrobot collection now depends on the community\.library\_inventory\_filtering\_v1 collection\. This utility collection provides host filtering functionality for inventory plugins\. If you use the Ansible community package\, both collections are included and you do not have to do anything special\. If you install the collection with ansible\-galaxy collection install\, it will be installed automatically\. If you install the collection by copying the files of the collection to a place where ansible\-core can find it\, for example by cloning the git repository\, you need to make sure that you also have to install the dependency if you are using the inventory plugin \([https\://github\.com/ansible\-collections/community\.hrobot/pull/101](https\://github\.com/ansible\-collections/community\.hrobot/pull/101)\)\. - + ### Minor Changes * robot inventory plugin \- add filter option which allows to include and exclude hosts based on Jinja2 conditions \([https\://github\.com/ansible\-collections/community\.hrobot/pull/101](https\://github\.com/ansible\-collections/community\.hrobot/pull/101)\)\. @@ -142,7 +176,7 @@ New major release 2\.0\.0\. ## v1\.9\.2 - + ### Release Summary Bugfix release\. @@ -155,7 +189,7 @@ Bugfix release\. ## v1\.9\.1 - + ### Release Summary Bugfix release\. @@ -168,17 +202,17 @@ Bugfix release\. ## v1\.9\.0 - + ### Release Summary Feature and maintenance release\. - + ### Minor Changes * robot inventory plugin \- the filters option has been renamed to simple\_filters\. The old name still works until community\.hrobot 2\.0\.0\. Then it will change to allow more complex filtering with the community\.library\_inventory\_filtering\_v1 collection\'s functionality \([https\://github\.com/ansible\-collections/community\.hrobot/pull/94](https\://github\.com/ansible\-collections/community\.hrobot/pull/94)\)\. - + ### Deprecated Features * robot inventory plugin \- the filters option has been renamed to simple\_filters\. The old name will stop working in community\.hrobot 2\.0\.0 \([https\://github\.com/ansible\-collections/community\.hrobot/pull/94](https\://github\.com/ansible\-collections/community\.hrobot/pull/94)\)\. @@ -186,7 +220,7 @@ Feature and maintenance release\. ## v1\.8\.2 - + ### Release Summary Maintenance release with updated documentation\. @@ -199,7 +233,7 @@ Maintenance release with updated documentation\. ## v1\.8\.1 - + ### Release Summary Maintenance release with updated documentation\. @@ -220,7 +254,7 @@ for the rendered HTML version of the documentation of the latest release\. ## v1\.8\.0 - + ### Release Summary Feature release for the Hetzner firewall changes\. @@ -230,7 +264,7 @@ Feature release for the Hetzner firewall changes\. * firewall \- Hetzner added output rules support to the firewall\. This change unfortunately means that using old versions of the firewall module will always set the output rule list to empty\, thus disallowing the server to send out packets \([https\://github\.com/ansible\-collections/community\.hrobot/issues/75](https\://github\.com/ansible\-collections/community\.hrobot/issues/75)\, [https\://github\.com/ansible\-collections/community\.hrobot/pull/76](https\://github\.com/ansible\-collections/community\.hrobot/pull/76)\)\. - + ### Minor Changes * firewall\, firewall\_info \- add filter\_ipv6 and rules\.output output to support the new IPv6 filtering and output rules features \([https\://github\.com/ansible\-collections/community\.hrobot/issues/75](https\://github\.com/ansible\-collections/community\.hrobot/issues/75)\, [https\://github\.com/ansible\-collections/community\.hrobot/pull/76](https\://github\.com/ansible\-collections/community\.hrobot/pull/76)\)\. @@ -239,12 +273,12 @@ Feature release for the Hetzner firewall changes\. ## v1\.7\.0 - + ### Release Summary Feature release\. - + ### New Modules * community\.hrobot\.v\_switch \- Manage Hetzner\'s vSwitch @@ -252,12 +286,12 @@ Feature release\. ## v1\.6\.0 - + ### Release Summary Feature release with improved documentation\. - + ### Minor Changes * Added a community\.hrobot\.robot module defaults group / action group\. Use with group/community\.hrobot\.robot to provide options for all Hetzner Robot modules \([https\://github\.com/ansible\-collections/community\.hrobot/pull/65](https\://github\.com/ansible\-collections/community\.hrobot/pull/65)\)\. @@ -265,12 +299,12 @@ Feature release with improved documentation\. ## v1\.5\.2 - + ### Release Summary Maintenance release with a documentation improvement\. - + ### Minor Changes * The collection repository conforms to the [REUSE specification](https\://reuse\.software/spec/) except for the changelog fragments \([https\://github\.com/ansible\-collections/community\.hrobot/pull/60](https\://github\.com/ansible\-collections/community\.hrobot/pull/60)\)\. @@ -278,7 +312,7 @@ Maintenance release with a documentation improvement\. ## v1\.5\.1 - + ### Release Summary Maintenance release with small documentation fixes\. @@ -286,12 +320,12 @@ Maintenance release with small documentation fixes\. ## v1\.5\.0 - + ### Release Summary Maintenance release changing the way licenses are declared\. No functional changes\. - + ### Minor Changes * All software licenses are now in the LICENSES/ directory of the collection root\. Moreover\, SPDX\-License\-Identifier\: is used to declare the applicable license for every file that is not automatically generated \([https\://github\.com/ansible\-collections/community\.hrobot/pull/52](https\://github\.com/ansible\-collections/community\.hrobot/pull/52)\)\. @@ -299,12 +333,12 @@ Maintenance release changing the way licenses are declared\. No functional chang ## v1\.4\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * robot inventory plugin \- allow to template hetzner\_user and hetzner\_password \([https\://github\.com/ansible\-collections/community\.hrobot/pull/49](https\://github\.com/ansible\-collections/community\.hrobot/pull/49)\)\. @@ -312,7 +346,7 @@ Feature release\. ## v1\.3\.1 - + ### Release Summary Maintenance release\. @@ -325,12 +359,12 @@ Maintenance release\. ## v1\.3\.0 - + ### Release Summary Feature and bugfix release\. - + ### Minor Changes * Prepare collection for inclusion in an Execution Environment by declaring its dependencies \([https\://github\.com/ansible\-collections/community\.hrobot/pull/45](https\://github\.com/ansible\-collections/community\.hrobot/pull/45)\)\. @@ -343,7 +377,7 @@ Feature and bugfix release\. ## v1\.2\.3 - + ### Release Summary Docs update release\. @@ -351,7 +385,7 @@ Docs update release\. ## v1\.2\.2 - + ### Release Summary Bugfix release\. @@ -364,12 +398,12 @@ Bugfix release\. ## v1\.2\.1 - + ### Release Summary Maintenance release\. - + ### Minor Changes * Generic module HTTP support code \- fix usage of fetch\_url with changes in latest ansible\-core devel branch \([https\://github\.com/ansible\-collections/community\.hrobot/pull/30](https\://github\.com/ansible\-collections/community\.hrobot/pull/30)\)\. @@ -377,12 +411,12 @@ Maintenance release\. ## v1\.2\.0 - + ### Release Summary Feature release with multiple new modules\. - + ### Minor Changes * Avoid internal ansible\-core module\_utils in favor of equivalent public API available since at least Ansible 2\.9 \([https\://github\.com/ansible\-collections/community\.hrobot/pull/18](https\://github\.com/ansible\-collections/community\.hrobot/pull/18)\)\. @@ -390,7 +424,7 @@ Feature release with multiple new modules\. * firewall\, firewall\_info \- add return value allowlist\_hos\, which contains the same value as whitelist\_hos\. The old name whitelist\_hos will be removed eventually \([https\://github\.com/ansible\-collections/community\.hrobot/pull/15](https\://github\.com/ansible\-collections/community\.hrobot/pull/15)\)\. * robot module utils \- add allow\_empty\_result parameter to plugin\_open\_url\_json and fetch\_url\_json \([https\://github\.com/ansible\-collections/community\.hrobot/pull/16](https\://github\.com/ansible\-collections/community\.hrobot/pull/16)\)\. - + ### New Modules * community\.hrobot\.boot \- Set boot configuration @@ -404,7 +438,7 @@ Feature release with multiple new modules\. ## v1\.1\.1 - + ### Release Summary Bugfix release which reduces the number of HTTPS queries for the modules and plugins\. @@ -417,7 +451,7 @@ Bugfix release which reduces the number of HTTPS queries for the modules and plu ## v1\.1\.0 - + ### Release Summary Release with a new inventory plugin\. @@ -433,7 +467,7 @@ Release with a new inventory plugin\. ## v1\.0\.0 - + ### Release Summary The community\.hrobot continues the work on the Hetzner Robot modules from their state in community\.general 1\.2\.0\. The changes listed here are thus relative to the modules community\.general\.hetzner\_\*\. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 946a9b9..3504b05 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,35 @@ Community Hetzner Robot Collection Release Notes .. contents:: Topics +v2.1.0 +====== + +Release Summary +--------------- + +Feature release with several new modules and a deprecation. + +Minor Changes +------------- + +- All modules and plugins now have a ``rate_limit_retry_timeout`` option, which allows to configure for how long to wait in case of rate limiting errors. By default, the modules wait indefinitely. Setting the option to ``0`` does not retry (this was the behavior in previous versions), and a positive value sets a number of seconds to wait at most (https://github.com/ansible-collections/community.hrobot/pull/140). +- boot - it is now possible to specify SSH public keys in ``authorized_keys``. The fingerprint needed by the Robot API will be extracted automatically (https://github.com/ansible-collections/community.hrobot/pull/134). +- v_switch - the module is now part of the ``community.hrobot.robot`` action group, despite already being documented as part of it (https://github.com/ansible-collections/community.hrobot/pull/136). + +Deprecated Features +------------------- + +- boot - the various ``arch`` suboptions have been deprecated and will be removed from community.hrobot 3.0.0 (https://github.com/ansible-collections/community.hrobot/pull/134). + +New Modules +----------- + +- community.hrobot.storagebox - Modify a storage box's basic configuration. +- community.hrobot.storagebox_info - Query information on one or more storage boxes. +- community.hrobot.storagebox_set_password - (Re)set the password for a storage box. +- community.hrobot.storagebox_snapshot_plan - Modify a storage box's snapshot plans. +- community.hrobot.storagebox_snapshot_plan_info - Query the snapshot plans for a storage box. + v2.0.3 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 02fc830..1ccb773 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -343,3 +343,43 @@ releases: fragments: - 2.0.3.yml release_date: '2024-12-30' + 2.1.0: + changes: + deprecated_features: + - boot - the various ``arch`` suboptions have been deprecated and will be + removed from community.hrobot 3.0.0 (https://github.com/ansible-collections/community.hrobot/pull/134). + minor_changes: + - All modules and plugins now have a ``rate_limit_retry_timeout`` option, + which allows to configure for how long to wait in case of rate limiting + errors. By default, the modules wait indefinitely. Setting the option to + ``0`` does not retry (this was the behavior in previous versions), and a + positive value sets a number of seconds to wait at most (https://github.com/ansible-collections/community.hrobot/pull/140). + - boot - it is now possible to specify SSH public keys in ``authorized_keys``. + The fingerprint needed by the Robot API will be extracted automatically + (https://github.com/ansible-collections/community.hrobot/pull/134). + - v_switch - the module is now part of the ``community.hrobot.robot`` action + group, despite already being documented as part of it (https://github.com/ansible-collections/community.hrobot/pull/136). + release_summary: Feature release with several new modules and a deprecation. + fragments: + - 134-boot-arch.yml + - 134-boot-fingerprints.yml + - 136-v_switch-action-group.yml + - 140-rate_limit_retry_timeout.yml + - 2.1.0.yml + modules: + - description: Modify a storage box's basic configuration. + name: storagebox + namespace: '' + - description: Query information on one or more storage boxes. + name: storagebox_info + namespace: '' + - description: (Re)set the password for a storage box. + name: storagebox_set_password + namespace: '' + - description: Modify a storage box's snapshot plans. + name: storagebox_snapshot_plan + namespace: '' + - description: Query the snapshot plans for a storage box. + name: storagebox_snapshot_plan_info + namespace: '' + release_date: '2025-01-18' diff --git a/changelogs/fragments/134-boot-arch.yml b/changelogs/fragments/134-boot-arch.yml deleted file mode 100644 index 95dd60d..0000000 --- a/changelogs/fragments/134-boot-arch.yml +++ /dev/null @@ -1,2 +0,0 @@ -deprecated_features: - - "boot - the various ``arch`` suboptions have been deprecated and will be removed from community.hrobot 3.0.0 (https://github.com/ansible-collections/community.hrobot/pull/134)." diff --git a/changelogs/fragments/134-boot-fingerprints.yml b/changelogs/fragments/134-boot-fingerprints.yml deleted file mode 100644 index 22a9635..0000000 --- a/changelogs/fragments/134-boot-fingerprints.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: - - "boot - it is now possible to specify SSH public keys in ``authorized_keys``. - The fingerprint needed by the Robot API will be extracted automatically - (https://github.com/ansible-collections/community.hrobot/pull/134)." diff --git a/changelogs/fragments/136-v_switch-action-group.yml b/changelogs/fragments/136-v_switch-action-group.yml deleted file mode 100644 index ab98b35..0000000 --- a/changelogs/fragments/136-v_switch-action-group.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - "v_switch - the module is now part of the ``community.hrobot.robot`` action group, despite already being documented as part of it - (https://github.com/ansible-collections/community.hrobot/pull/136)." diff --git a/changelogs/fragments/140-rate_limit_retry_timeout.yml b/changelogs/fragments/140-rate_limit_retry_timeout.yml deleted file mode 100644 index da2c109..0000000 --- a/changelogs/fragments/140-rate_limit_retry_timeout.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: - - "All modules and plugins now have a ``rate_limit_retry_timeout`` option, which allows to configure for how long to wait in case of rate limiting errors. - By default, the modules wait indefinitely. Setting the option to ``0`` does not retry (this was the behavior in previous versions), and a positive value - sets a number of seconds to wait at most (https://github.com/ansible-collections/community.hrobot/pull/140)." diff --git a/changelogs/fragments/2.1.0.yml b/changelogs/fragments/2.1.0.yml deleted file mode 100644 index c306b79..0000000 --- a/changelogs/fragments/2.1.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: Feature release with several new modules and a deprecation.