From 90cf544dbac27564aef459745d6aaa6595e6b4ef Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 20 Oct 2024 10:38:33 +0200 Subject: [PATCH] Release 4.0.0 --- CHANGELOG.md | 456 ++++++++++-------- CHANGELOG.rst | 27 ++ changelogs/changelog.yaml | 24 + changelogs/fragments/4.0.0.yml | 9 - .../fragments/977-renew_anon_volumes.yaml | 3 - 5 files changed, 295 insertions(+), 224 deletions(-) delete mode 100644 changelogs/fragments/4.0.0.yml delete mode 100644 changelogs/fragments/977-renew_anon_volumes.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index b761b8fe8..b3b17e274 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,251 +2,256 @@ **Topics** -- v3\.13\.1 +- v4\.0\.0 - Release Summary + - Minor Changes + - Breaking Changes / Porting Guide + - Removed Features \(previously deprecated\) +- v3\.13\.1 + - Release Summary - Bugfixes - v3\.13\.0 - - Release Summary + - Release Summary - New Modules - v3\.12\.2 - - Release Summary + - Release Summary - Bugfixes - v3\.12\.1 - - Release Summary + - Release Summary - Deprecated Features - v3\.12\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - Known Issues - v3\.11\.0 - - Minor Changes + - Minor Changes - Bugfixes - v3\.10\.4 - - Release Summary + - Release Summary - Bugfixes - v3\.10\.3 - - Release Summary + - Release Summary - Bugfixes - v3\.10\.2 - - Release Summary + - Release Summary - Bugfixes - v3\.10\.1 - - Release Summary + - Release Summary - Bugfixes - Known Issues - v3\.10\.0 - - Release Summary - - Minor Changes - - Deprecated Features -- v3\.9\.0 - Release Summary - Minor Changes + - Deprecated Features +- v3\.9\.0 + - Release Summary + - Minor Changes - Bugfixes - v3\.8\.1 - - Release Summary + - Release Summary - Security Fixes - Bugfixes - v3\.8\.0 - - Release Summary - - Minor Changes - - Bugfixes -- v3\.7\.0 - Release Summary - Minor Changes + - Bugfixes +- v3\.7\.0 + - Release Summary + - Minor Changes - Bugfixes - New Modules - v3\.6\.0 - - Release Summary + - Release Summary - Major Changes - - Minor Changes + - Minor Changes - Bugfixes - New Modules - v3\.5\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Deprecated Features - Bugfixes - v3\.4\.11 - - Release Summary + - Release Summary - Bugfixes - v3\.4\.10 - - Release Summary + - Release Summary - Bugfixes - v3\.4\.9 - - Release Summary + - Release Summary - Bugfixes - v3\.4\.8 - - Release Summary + - Release Summary - Known Issues - v3\.4\.7 - - Release Summary + - Release Summary - Bugfixes - v3\.4\.6 - - Release Summary + - Release Summary - Bugfixes - Known Issues - v3\.4\.5 - - Release Summary + - Release Summary - Bugfixes - v3\.4\.4 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Known Issues - v3\.4\.3 - - Release Summary -- v3\.4\.2 - Release Summary +- v3\.4\.2 + - Release Summary - Bugfixes - v3\.4\.1 - - Release Summary + - Release Summary - Bugfixes - v3\.4\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - New Modules - v3\.3\.2 - - Release Summary + - Release Summary - Bugfixes - v3\.3\.1 - - Release Summary + - Release Summary - Bugfixes - v3\.3\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - v3\.2\.2 - - Release Summary + - Release Summary - Bugfixes - v3\.2\.1 - - Release Summary -- v3\.2\.0 - Release Summary - - Minor Changes - - Deprecated Features -- v3\.1\.0 +- v3\.2\.0 - Release Summary - Minor Changes -- v3\.0\.2 + - Deprecated Features +- v3\.1\.0 - Release Summary + - Minor Changes +- v3\.0\.2 + - Release Summary - Bugfixes - v3\.0\.1 - - Release Summary + - Release Summary - Bugfixes - v3\.0\.0 - - Release Summary + - Release Summary - Major Changes - - Minor Changes - - Breaking Changes / Porting Guide - - Removed Features \(previously deprecated\) + - Minor Changes + - Breaking Changes / Porting Guide + - Removed Features \(previously deprecated\) - Security Fixes - Bugfixes - v2\.7\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Deprecated Features - Bugfixes - v2\.6\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Deprecated Features - Bugfixes - v2\.5\.1 - - Release Summary + - Release Summary - Bugfixes - v2\.5\.0 - - Release Summary - - Minor Changes -- v2\.4\.0 - Release Summary - Minor Changes - - Bugfixes -- v2\.3\.0 +- v2\.4\.0 - Release Summary - Minor Changes + - Bugfixes +- v2\.3\.0 + - Release Summary + - Minor Changes - Bugfixes - v2\.2\.1 - - Release Summary + - Release Summary - Bugfixes - v2\.2\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - v2\.1\.1 - - Release Summary + - Release Summary - Bugfixes - v2\.1\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - v2\.0\.2 - - Release Summary + - Release Summary - Bugfixes - v2\.0\.1 - - Release Summary -- v2\.0\.0 - Release Summary - - Breaking Changes / Porting Guide +- v2\.0\.0 + - Release Summary + - Breaking Changes / Porting Guide - Deprecated Features - - Removed Features \(previously deprecated\) + - Removed Features \(previously deprecated\) - v1\.10\.0 - - Release Summary - - Minor Changes -- v1\.9\.1 - Release Summary + - Minor Changes +- v1\.9\.1 + - Release Summary - Bugfixes - v1\.9\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Deprecated Features - Bugfixes - New Plugins - Connection - v1\.8\.0 - - Release Summary - - Minor Changes - - Bugfixes -- v1\.7\.0 - Release Summary - Minor Changes -- v1\.6\.1 + - Bugfixes +- v1\.7\.0 - Release Summary + - Minor Changes +- v1\.6\.1 + - Release Summary - Bugfixes - v1\.6\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Deprecated Features - Bugfixes - v1\.5\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - New Modules - v1\.4\.0 - - Release Summary - - Minor Changes - - Breaking Changes / Porting Guide + - Release Summary + - Minor Changes + - Breaking Changes / Porting Guide - Security Fixes - Bugfixes - v1\.3\.0 - - Release Summary - - Minor Changes + - Release Summary + - Minor Changes - Bugfixes - New Modules - v1\.2\.2 - - Release Summary + - Release Summary - Security Fixes - v1\.2\.1 - - Release Summary + - Release Summary - Bugfixes - v1\.2\.0 - - Release Summary - - Minor Changes - - Bugfixes -- v1\.1\.0 - Release Summary - Minor Changes + - Bugfixes +- v1\.1\.0 + - Release Summary + - Minor Changes - Deprecated Features - Bugfixes - New Plugins @@ -254,21 +259,48 @@ - Inventory - New Modules - v1\.0\.1 - - Release Summary + - Release Summary - Bugfixes - v1\.0\.0 - - Release Summary - - Minor Changes -- v0\.1\.0 - Release Summary - Minor Changes - - Removed Features \(previously deprecated\) +- v0\.1\.0 + - Release Summary + - Minor Changes + - Removed Features \(previously deprecated\) - Bugfixes + +## v4\.0\.0 + + +### Release Summary + +Major release with removed deprecated features\. + + +### Minor Changes + +* docker\_compose\_v2 \- add renew\_anon\_volumes parameter for docker compose up \([https\://github\.com/ansible\-collections/community\.docker/pull/977](https\://github\.com/ansible\-collections/community\.docker/pull/977)\)\. + + +### Breaking Changes / Porting Guide + +* docker\_container \- the default of image\_name\_mismatch changed from ignore to recreate \([https\://github\.com/ansible\-collections/community\.docker/pull/971](https\://github\.com/ansible\-collections/community\.docker/pull/971)\)\. + + +### Removed Features \(previously deprecated\) + +* The collection no longer supports ansible\-core 2\.11\, 2\.12\, 2\.13\, and 2\.14\. You need ansible\-core 2\.15\.0 or newer to use community\.docker 4\.x\.y \([https\://github\.com/ansible\-collections/community\.docker/pull/971](https\://github\.com/ansible\-collections/community\.docker/pull/971)\)\. +* The docker\_compose module has been removed\. Please migrate to community\.docker\.docker\_compose\_v2 \([https\://github\.com/ansible\-collections/community\.docker/pull/971](https\://github\.com/ansible\-collections/community\.docker/pull/971)\)\. +* docker\_container \- the ignore\_image option has been removed\. Use image\: ignore in comparisons instead \([https\://github\.com/ansible\-collections/community\.docker/pull/971](https\://github\.com/ansible\-collections/community\.docker/pull/971)\)\. +* docker\_container \- the purge\_networks option has been removed\. Use networks\: strict in comparisons instead and make sure that networks is specified \([https\://github\.com/ansible\-collections/community\.docker/pull/971](https\://github\.com/ansible\-collections/community\.docker/pull/971)\)\. +* various modules and plugins \- remove the ssl\_version option \([https\://github\.com/ansible\-collections/community\.docker/pull/971](https\://github\.com/ansible\-collections/community\.docker/pull/971)\)\. + ## v3\.13\.1 - + ### Release Summary Bugfix release\. @@ -281,7 +313,7 @@ Bugfix release\. ## v3\.13\.0 - + ### Release Summary Feature release\. @@ -295,7 +327,7 @@ Feature release\. ## v3\.12\.2 - + ### Release Summary Bugfix release\. @@ -308,7 +340,7 @@ Bugfix release\. ## v3\.12\.1 - + ### Release Summary Maintenance release with updated documentation and changelog\. @@ -321,12 +353,12 @@ Maintenance release with updated documentation and changelog\. ## v3\.12\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * docker\, docker\_api connection plugins \- allow to determine the working directory when executing commands with the new working\_dir option \([https\://github\.com/ansible\-collections/community\.docker/pull/943](https\://github\.com/ansible\-collections/community\.docker/pull/943)\)\. @@ -354,7 +386,7 @@ Bugfix and feature release\. ## v3\.11\.0 - + ### Minor Changes * docker\_container \- add support for device\_cgroup\_rules \([https\://github\.com/ansible\-collections/community\.docker/pull/910](https\://github\.com/ansible\-collections/community\.docker/pull/910)\)\. @@ -371,7 +403,7 @@ Bugfix and feature release\. ## v3\.10\.4 - + ### Release Summary Bugfix release\. @@ -385,7 +417,7 @@ Bugfix release\. ## v3\.10\.3 - + ### Release Summary Bugfix release\. @@ -398,7 +430,7 @@ Bugfix release\. ## v3\.10\.2 - + ### Release Summary Bugfix release\. @@ -411,7 +443,7 @@ Bugfix release\. ## v3\.10\.1 - + ### Release Summary Hotfix release for requests 2\.32\.0 compatibility\. @@ -435,12 +467,12 @@ Hotfix release for requests 2\.32\.0 compatibility\. ## v3\.10\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * docker\_container \- adds healthcheck\.start\_interval to support healthcheck start interval setting on containers \([https\://github\.com/ansible\-collections/community\.docker/pull/848](https\://github\.com/ansible\-collections/community\.docker/pull/848)\)\. @@ -461,12 +493,12 @@ Feature release\. ## v3\.9\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * The EE requirements now include PyYAML\, since the docker\_compose\_v2\* modules depend on it when the definition option is used\. This should not have a noticable effect on generated EEs since ansible\-core itself depends on PyYAML as well\, and ansible\-builder explicitly ignores this dependency \([https\://github\.com/ansible\-collections/community\.docker/pull/832](https\://github\.com/ansible\-collections/community\.docker/pull/832)\)\. @@ -484,7 +516,7 @@ Bugfix and feature release\. ## v3\.8\.1 - + ### Release Summary Bugfix release @@ -505,12 +537,12 @@ Bugfix release ## v3\.8\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * docker\_compose\_v2 \- allow to wait until containers are running/health when running docker compose up with the new wait option \([https\://github\.com/ansible\-collections/community\.docker/issues/794](https\://github\.com/ansible\-collections/community\.docker/issues/794)\, [https\://github\.com/ansible\-collections/community\.docker/pull/796](https\://github\.com/ansible\-collections/community\.docker/pull/796)\)\. @@ -527,12 +559,12 @@ Bugfix and feature release\. ## v3\.7\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * docker\_compose\_v2 \- add scale option to allow to explicitly scale services \([https\://github\.com/ansible\-collections/community\.docker/pull/776](https\://github\.com/ansible\-collections/community\.docker/pull/776)\)\. @@ -552,7 +584,7 @@ Bugfix and feature release\. ## v3\.6\.0 - + ### Release Summary Bugfix and feature release\. @@ -572,7 +604,7 @@ so the main difference is that instead of some Python requirements\, they depend * The community\.docker 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 plugins \([https\://github\.com/ansible\-collections/community\.docker/pull/698](https\://github\.com/ansible\-collections/community\.docker/pull/698)\)\. - + ### Minor Changes * The ca\_cert option available to almost all modules and plugins has been renamed to ca\_path\. The name ca\_path is also used for similar options in ansible\-core and other collections\. The old name has been added as an alias and can still be used \([https\://github\.com/ansible\-collections/community\.docker/pull/744](https\://github\.com/ansible\-collections/community\.docker/pull/744)\)\. @@ -602,12 +634,12 @@ so the main difference is that instead of some Python requirements\, they depend ## v3\.5\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * docker\_container \- implement better platform string comparisons to improve idempotency \([https\://github\.com/ansible\-collections/community\.docker/issues/654](https\://github\.com/ansible\-collections/community\.docker/issues/654)\, [https\://github\.com/ansible\-collections/community\.docker/pull/705](https\://github\.com/ansible\-collections/community\.docker/pull/705)\)\. @@ -628,7 +660,7 @@ Bugfix and feature release\. ## v3\.4\.11 - + ### Release Summary Bugfix release\. @@ -641,7 +673,7 @@ Bugfix release\. ## v3\.4\.10 - + ### Release Summary Bugfix release\. @@ -654,7 +686,7 @@ Bugfix release\. ## v3\.4\.9 - + ### Release Summary Maintenance release with updated documentation and vendored Docker SDK for Python code\. @@ -667,7 +699,7 @@ Maintenance release with updated documentation and vendored Docker SDK for Pytho ## v3\.4\.8 - + ### Release Summary Maintenance release with updated documentation\. @@ -688,7 +720,7 @@ for the rendered HTML version of the documentation of the latest release\. ## v3\.4\.7 - + ### Release Summary Bugfix release\. @@ -701,7 +733,7 @@ Bugfix release\. ## v3\.4\.6 - + ### Release Summary Bugfix release with documentation warnings about using certain functionality when connecting to the Docker daemon with TCP TLS\. @@ -723,7 +755,7 @@ Bugfix release with documentation warnings about using certain functionality whe ## v3\.4\.5 - + ### Release Summary Maintenance release which adds compatibility with requests 2\.29\.0 and 2\.30\.0 and urllib3 2\.0\. @@ -736,12 +768,12 @@ Maintenance release which adds compatibility with requests 2\.29\.0 and 2\.30\.0 ## v3\.4\.4 - + ### Release Summary Maintenance release with updated EE requirements and updated documentation\. - + ### Minor Changes * Restrict requests to versions before 2\.29\.0\, and urllib3 to versions before 2\.0\.0\. This is necessary until the vendored code from Docker SDK for Python has been fully adjusted to work with a feature of urllib3 that is used since requests 2\.29\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/611](https\://github\.com/ansible\-collections/community\.docker/issues/611)\, [https\://github\.com/ansible\-collections/community\.docker/pull/612](https\://github\.com/ansible\-collections/community\.docker/pull/612)\)\. @@ -754,7 +786,7 @@ Maintenance release with updated EE requirements and updated documentation\. ## v3\.4\.3 - + ### Release Summary Maintenance release with improved documentation\. @@ -762,7 +794,7 @@ Maintenance release with improved documentation\. ## v3\.4\.2 - + ### Release Summary Bugfix release\. @@ -775,7 +807,7 @@ Bugfix release\. ## v3\.4\.1 - + ### Release Summary Regular bugfix release\. @@ -790,12 +822,12 @@ Regular bugfix release\. ## v3\.4\.0 - + ### Release Summary Regular bugfix and feature release\. - + ### Minor Changes * docker\_api connection plugin \- when copying files to/from a container\, stream the file contents instead of first reading them to memory \([https\://github\.com/ansible\-collections/community\.docker/pull/545](https\://github\.com/ansible\-collections/community\.docker/pull/545)\)\. @@ -817,7 +849,7 @@ Regular bugfix and feature release\. ## v3\.3\.2 - + ### Release Summary Bugfix release\. @@ -830,7 +862,7 @@ Bugfix release\. ## v3\.3\.1 - + ### Release Summary Bugfix release\. @@ -843,12 +875,12 @@ Bugfix release\. ## v3\.3\.0 - + ### Release Summary Feature and bugfix release\. - + ### Minor Changes * current\_container\_facts \- make work with current Docker version\, also support Podman \([https\://github\.com/ansible\-collections/community\.docker/pull/510](https\://github\.com/ansible\-collections/community\.docker/pull/510)\)\. @@ -863,7 +895,7 @@ Feature and bugfix release\. ## v3\.2\.2 - + ### Release Summary Bugfix release\. @@ -876,7 +908,7 @@ Bugfix release\. ## v3\.2\.1 - + ### Release Summary Maintenance release with improved documentation\. @@ -884,12 +916,12 @@ Maintenance release with improved documentation\. ## v3\.2\.0 - + ### Release Summary Feature and deprecation release\. - + ### Minor Changes * docker\_container \- added image\_name\_mismatch option which allows to control the behavior if the container uses the image specified\, but the container\'s configuration uses a different name for the image than the one provided to the module \([https\://github\.com/ansible\-collections/community\.docker/issues/485](https\://github\.com/ansible\-collections/community\.docker/issues/485)\, [https\://github\.com/ansible\-collections/community\.docker/pull/488](https\://github\.com/ansible\-collections/community\.docker/pull/488)\)\. @@ -903,12 +935,12 @@ Feature and deprecation release\. ## v3\.1\.0 - + ### Release Summary Feature release\. - + ### 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\.docker/pull/462](https\://github\.com/ansible\-collections/community\.docker/pull/462)\)\. @@ -917,7 +949,7 @@ Feature release\. ## v3\.0\.2 - + ### Release Summary Bugfix release\. @@ -930,7 +962,7 @@ Bugfix release\. ## v3\.0\.1 - + ### Release Summary Bugfix release\. @@ -943,7 +975,7 @@ Bugfix release\. ## v3\.0\.0 - + ### Release Summary The 3\.0\.0 release features a rewrite of the docker\_container module\, and many modules and plugins no longer depend on the Docker SDK for Python\. @@ -970,7 +1002,7 @@ The 3\.0\.0 release features a rewrite of the docker\_container mod * docker\_volume \- no longer uses the Docker SDK for Python\. It requires requests to be installed\, and depending on the features used has some more requirements\. If the Docker SDK for Python is installed\, these requirements are likely met \([https\://github\.com/ansible\-collections/community\.docker/pull/411](https\://github\.com/ansible\-collections/community\.docker/pull/411)\)\. * docker\_volume\_info \- no longer uses the Docker SDK for Python\. It requires requests to be installed\, and depending on the features used has some more requirements\. If the Docker SDK for Python is installed\, these requirements are likely met \([https\://github\.com/ansible\-collections/community\.docker/pull/412](https\://github\.com/ansible\-collections/community\.docker/pull/412)\)\. - + ### 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\.docker/pull/430](https\://github\.com/ansible\-collections/community\.docker/pull/430)\)\. @@ -982,7 +1014,7 @@ The 3\.0\.0 release features a rewrite of the docker\_container mod * modules and plugins communicating directly with the Docker daemon \- simplify use of helper function that was removed in Docker SDK for Python to find executables \([https\://github\.com/ansible\-collections/community\.docker/pull/438](https\://github\.com/ansible\-collections/community\.docker/pull/438)\)\. * socker\_handler and socket\_helper module utils \- improve Python forward compatibility\, create helper functions for file blocking/unblocking \([https\://github\.com/ansible\-collections/community\.docker/pull/415](https\://github\.com/ansible\-collections/community\.docker/pull/415)\)\. - + ### Breaking Changes / Porting Guide * This collection does not work with ansible\-core 2\.11 on Python 3\.12\+\. Please either upgrade to ansible\-core 2\.12\+\, or use Python 3\.11 or earlier \([https\://github\.com/ansible\-collections/community\.docker/pull/271](https\://github\.com/ansible\-collections/community\.docker/pull/271)\)\. @@ -993,7 +1025,7 @@ The 3\.0\.0 release features a rewrite of the docker\_container mod * docker\_container \- stop\_timeout is no longer ignored for idempotency if told to be not ignored in comparisons\. So far it defaulted to ignore there\, and setting it to strict had no effect \([https\://github\.com/ansible\-collections/community\.docker/pull/422](https\://github\.com/ansible\-collections/community\.docker/pull/422)\)\. * modules and plugins communicating directly with the Docker daemon \- when connecting by SSH and not using use\_ssh\_client\=true\, reject unknown host keys instead of accepting them\. This is only a breaking change relative to older community\.docker 3\.0\.0 pre\-releases or with respect to Docker SDK for Python \< 6\.0\.0\. Docker SDK for Python 6\.0\.0 will also include this change \([https\://github\.com/ansible\-collections/community\.docker/pull/434](https\://github\.com/ansible\-collections/community\.docker/pull/434)\)\. - + ### Removed Features \(previously deprecated\) * Execution Environments built with community\.docker no longer include docker\-compose \< 2\.0\.0\. If you need to use it with the docker\_compose module\, please install that requirement manually \([https\://github\.com/ansible\-collections/community\.docker/pull/400](https\://github\.com/ansible\-collections/community\.docker/pull/400)\)\. @@ -1024,12 +1056,12 @@ The 3\.0\.0 release features a rewrite of the docker\_container mod ## v2\.7\.0 - + ### Release Summary Bugfix and deprecation release\. The next 2\.x\.y releases will only be bugfix releases\, the next expect minor/major release will be 3\.0\.0 with some major changes\. - + ### Minor Changes * Move common utility functions from the common module\_util to a new module\_util called util\. This should not have any user\-visible effect \([https\://github\.com/ansible\-collections/community\.docker/pull/390](https\://github\.com/ansible\-collections/community\.docker/pull/390)\)\. @@ -1048,12 +1080,12 @@ Bugfix and deprecation release\. The next 2\.x\.y releases will only be bugfix r ## v2\.6\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * docker\_container \- added image\_label\_mismatch parameter \([https\://github\.com/ansible\-collections/community\.docker/issues/314](https\://github\.com/ansible\-collections/community\.docker/issues/314)\, [https\://github\.com/ansible\-collections/community\.docker/pull/370](https\://github\.com/ansible\-collections/community\.docker/pull/370)\)\. @@ -1075,7 +1107,7 @@ Bugfix and feature release\. ## v2\.5\.1 - + ### Release Summary Maintenance release\. @@ -1088,12 +1120,12 @@ Maintenance release\. ## v2\.5\.0 - + ### Release Summary Regular feature release\. - + ### Minor Changes * docker\_config \- add support for template\_driver with one option golang \([https\://github\.com/ansible\-collections/community\.docker/issues/332](https\://github\.com/ansible\-collections/community\.docker/issues/332)\, [https\://github\.com/ansible\-collections/community\.docker/pull/345](https\://github\.com/ansible\-collections/community\.docker/pull/345)\)\. @@ -1102,12 +1134,12 @@ Regular feature release\. ## v2\.4\.0 - + ### Release Summary Regular feature and bugfix release\. - + ### Minor Changes * Prepare collection for inclusion in an Execution Environment by declaring its dependencies\. The docker\_stack\* modules are not supported \([https\://github\.com/ansible\-collections/community\.docker/pull/336](https\://github\.com/ansible\-collections/community\.docker/pull/336)\)\. @@ -1122,12 +1154,12 @@ Regular feature and bugfix release\. ## v2\.3\.0 - + ### Release Summary Regular feature and bugfix release\. - + ### Minor Changes * docker connection plugin \- implement connection reset by clearing internal container user cache \([https\://github\.com/ansible\-collections/community\.docker/pull/312](https\://github\.com/ansible\-collections/community\.docker/pull/312)\)\. @@ -1145,7 +1177,7 @@ Regular feature and bugfix release\. ## v2\.2\.1 - + ### Release Summary Regular bugfix release\. @@ -1158,12 +1190,12 @@ Regular bugfix release\. ## v2\.2\.0 - + ### Release Summary Regular feature and bugfix release\. - + ### Minor Changes * docker\_config \- add support for rolling update\, set rolling\_versions to true to enable \([https\://github\.com/ansible\-collections/community\.docker/pull/295](https\://github\.com/ansible\-collections/community\.docker/pull/295)\, [https\://github\.com/ansible\-collections/community\.docker/issues/109](https\://github\.com/ansible\-collections/community\.docker/issues/109)\)\. @@ -1178,7 +1210,7 @@ Regular feature and bugfix release\. ## v2\.1\.1 - + ### Release Summary Emergency release to amend breaking change in previous release\. @@ -1191,12 +1223,12 @@ Emergency release to amend breaking change in previous release\. ## v2\.1\.0 - + ### Release Summary Feature and bugfix release\. - + ### Minor Changes * docker\_container\_exec \- add detach parameter \([https\://github\.com/ansible\-collections/community\.docker/issues/250](https\://github\.com/ansible\-collections/community\.docker/issues/250)\, [https\://github\.com/ansible\-collections/community\.docker/pull/255](https\://github\.com/ansible\-collections/community\.docker/pull/255)\)\. @@ -1212,7 +1244,7 @@ Feature and bugfix release\. ## v2\.0\.2 - + ### Release Summary Bugfix release\. @@ -1228,7 +1260,7 @@ Bugfix release\. ## v2\.0\.1 - + ### Release Summary Maintenance release with some documentation fixes\. @@ -1236,12 +1268,12 @@ Maintenance release with some documentation fixes\. ## v2\.0\.0 - + ### Release Summary New major release with some deprecations removed and a breaking change in the docker\_compose module regarding the timeout parameter\. - + ### Breaking Changes / Porting Guide * docker\_compose \- fixed timeout defaulting behavior so that stop\_grace\_period\, if defined in the compose file\, will be used if timeout is not specified \([https\://github\.com/ansible\-collections/community\.docker/pull/163](https\://github\.com/ansible\-collections/community\.docker/pull/163)\)\. @@ -1251,7 +1283,7 @@ New major release with some deprecations removed and a breaking change in the all in published\_ports has been deprecated\. Use publish\_all\_ports\=true instead \([https\://github\.com/ansible\-collections/community\.docker/pull/210](https\://github\.com/ansible\-collections/community\.docker/pull/210)\)\. - + ### Removed Features \(previously deprecated\) * docker\_container \- the default value of container\_default\_behavior changed to no\_defaults \([https\://github\.com/ansible\-collections/community\.docker/pull/210](https\://github\.com/ansible\-collections/community\.docker/pull/210)\)\. @@ -1262,12 +1294,12 @@ New major release with some deprecations removed and a breaking change in the ## v1\.10\.0 - + ### Release Summary Regular feature and bugfix release\. - + ### Minor Changes * Add the modules docker\_container\_exec\, docker\_image\_load and docker\_plugin to the docker module defaults group \([https\://github\.com/ansible\-collections/community\.docker/pull/209](https\://github\.com/ansible\-collections/community\.docker/pull/209)\)\. @@ -1277,7 +1309,7 @@ Regular feature and bugfix release\. ## v1\.9\.1 - + ### Release Summary Regular bugfix release\. @@ -1290,12 +1322,12 @@ Regular bugfix release\. ## v1\.9\.0 - + ### Release Summary New bugfixes and features release\. - + ### Minor Changes * docker\_\* modules \- include ImportError traceback when reporting that Docker SDK for Python could not be found \([https\://github\.com/ansible\-collections/community\.docker/pull/188](https\://github\.com/ansible\-collections/community\.docker/pull/188)\)\. @@ -1328,12 +1360,12 @@ New bugfixes and features release\. ## v1\.8\.0 - + ### Release Summary Regular bugfix and feature release\. - + ### 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\.docker/pull/164](https\://github\.com/ansible\-collections/community\.docker/pull/164)\)\. @@ -1350,12 +1382,12 @@ Regular bugfix and feature release\. ## v1\.7\.0 - + ### Release Summary Small feature and bugfix release\. - + ### Minor Changes * docker\_image \- allow to tag images by ID \([https\://github\.com/ansible\-collections/community\.docker/pull/149](https\://github\.com/ansible\-collections/community\.docker/pull/149)\)\. @@ -1363,7 +1395,7 @@ Small feature and bugfix release\. ## v1\.6\.1 - + ### Release Summary Bugfix release to reduce deprecation warning spam\. @@ -1376,12 +1408,12 @@ Bugfix release to reduce deprecation warning spam\. ## v1\.6\.0 - + ### Release Summary Regular bugfix and feature release\. - + ### Minor Changes * common module utils \- correct error messages for guiding to install proper Docker SDK for Python module \([https\://github\.com/ansible\-collections/community\.docker/pull/125](https\://github\.com/ansible\-collections/community\.docker/pull/125)\)\. @@ -1402,12 +1434,12 @@ Regular bugfix and feature release\. ## v1\.5\.0 - + ### Release Summary Regular feature release\. - + ### Minor Changes * Add the use\_ssh\_client option to most docker modules and plugins \([https\://github\.com/ansible\-collections/community\.docker/issues/108](https\://github\.com/ansible\-collections/community\.docker/issues/108)\, [https\://github\.com/ansible\-collections/community\.docker/pull/114](https\://github\.com/ansible\-collections/community\.docker/pull/114)\)\. @@ -1425,17 +1457,17 @@ Regular feature release\. ## v1\.4\.0 - + ### Release Summary Security release to address another potential secret leak\. Also includes regular bugfixes and features\. - + ### Minor Changes * docker\_swarm\_service \- change publish\.published\_port option from mandatory to optional\. Docker will assign random high port if not specified \([https\://github\.com/ansible\-collections/community\.docker/issues/99](https\://github\.com/ansible\-collections/community\.docker/issues/99)\)\. - + ### Breaking Changes / Porting Guide * docker\_swarm \- if join\_token is specified\, a returned join token with the same value will be replaced by VALUE\_SPECIFIED\_IN\_NO\_LOG\_PARAMETER\. Make sure that you do not blindly use the join tokens from the return value of this module when the module is invoked with join\_token specified\! This breaking change appears in a minor release since it is necessary to fix a security issue \([https\://github\.com/ansible\-collections/community\.docker/pull/103](https\://github\.com/ansible\-collections/community\.docker/pull/103)\)\. @@ -1454,12 +1486,12 @@ Security release to address another potential secret leak\. Also includes regula ## v1\.3\.0 - + ### Release Summary Regular feature and bugfix release\. - + ### Minor Changes * docker\_container \- add storage\_opts option to specify storage options \([https\://github\.com/ansible\-collections/community\.docker/issues/91](https\://github\.com/ansible\-collections/community\.docker/issues/91)\, [https\://github\.com/ansible\-collections/community\.docker/pull/93](https\://github\.com/ansible\-collections/community\.docker/pull/93)\)\. @@ -1485,7 +1517,7 @@ Regular feature and bugfix release\. ## v1\.2\.2 - + ### Release Summary Security bugfix release to address CVE\-2021\-20191\. @@ -1498,7 +1530,7 @@ Security bugfix release to address CVE\-2021\-20191\. ## v1\.2\.1 - + ### Release Summary Bugfix release\. @@ -1511,12 +1543,12 @@ Bugfix release\. ## v1\.2\.0 - + ### Release Summary Feature release with one new feature and two bugfixes\. - + ### Minor Changes * docker\_container \- added default\_host\_ip option which allows to explicitly set the default IP string for published ports without explicitly specified IPs\. When using IPv6 binds with Docker 20\.10\.2 or newer\, this needs to be set to an empty string \(\"\"\) \([https\://github\.com/ansible\-collections/community\.docker/issues/70](https\://github\.com/ansible\-collections/community\.docker/issues/70)\, [https\://github\.com/ansible\-collections/community\.docker/pull/71](https\://github\.com/ansible\-collections/community\.docker/pull/71)\)\. @@ -1530,12 +1562,12 @@ Feature release with one new feature and two bugfixes\. ## v1\.1\.0 - + ### Release Summary Feature release with three new plugins and modules\. - + ### Minor Changes * docker\_container \- support specifying cgroup\_parent \([https\://github\.com/ansible\-collections/community\.docker/issues/6](https\://github\.com/ansible\-collections/community\.docker/issues/6)\, [https\://github\.com/ansible\-collections/community\.docker/pull/59](https\://github\.com/ansible\-collections/community\.docker/pull/59)\)\. @@ -1575,7 +1607,7 @@ Feature release with three new plugins and modules\. ## v1\.0\.1 - + ### Release Summary Maintenance release with a bugfix for docker\_container\. @@ -1588,12 +1620,12 @@ Maintenance release with a bugfix for docker\_container\. ## v1\.0\.0 - + ### Release Summary This is the first production \(non\-prerelease\) release of community\.docker\. - + ### Minor Changes * Add collection\-side support of the docker action group / module defaults group \([https\://github\.com/ansible\-collections/community\.docker/pull/17](https\://github\.com/ansible\-collections/community\.docker/pull/17)\)\. @@ -1603,19 +1635,19 @@ This is the first production \(non\-prerelease\) release of community\.doc ## v0\.1\.0 - + ### Release Summary The community\.docker continues the work on the Ansible docker modules and plugins from their state in community\.general 1\.2\.0\. The changes listed here are thus relative to the modules and plugins community\.general\.docker\*\. All deprecation removals planned for community\.general 2\.0\.0 have been applied\. All deprecation removals scheduled for community\.general 3\.0\.0 have been re\-scheduled for community\.docker 2\.0\.0\. - + ### Minor Changes * docker\_container \- now supports the device\_requests option\, which allows to request additional resources such as GPUs \([https\://github\.com/ansible/ansible/issues/65748](https\://github\.com/ansible/ansible/issues/65748)\, [https\://github\.com/ansible\-collections/community\.general/pull/1119](https\://github\.com/ansible\-collections/community\.general/pull/1119)\)\. - + ### Removed Features \(previously deprecated\) * docker\_container \- no longer returns ansible\_facts \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 4997d0805..91231a5f4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,33 @@ Docker Community Collection Release Notes .. contents:: Topics +v4.0.0 +====== + +Release Summary +--------------- + +Major release with removed deprecated features. + +Minor Changes +------------- + +- docker_compose_v2 - add ``renew_anon_volumes`` parameter for ``docker compose up`` (https://github.com/ansible-collections/community.docker/pull/977). + +Breaking Changes / Porting Guide +-------------------------------- + +- docker_container - the default of ``image_name_mismatch`` changed from ``ignore`` to ``recreate`` (https://github.com/ansible-collections/community.docker/pull/971). + +Removed Features (previously deprecated) +---------------------------------------- + +- The collection no longer supports ansible-core 2.11, 2.12, 2.13, and 2.14. You need ansible-core 2.15.0 or newer to use community.docker 4.x.y (https://github.com/ansible-collections/community.docker/pull/971). +- The docker_compose module has been removed. Please migrate to community.docker.docker_compose_v2 (https://github.com/ansible-collections/community.docker/pull/971). +- docker_container - the ``ignore_image`` option has been removed. Use ``image: ignore`` in ``comparisons`` instead (https://github.com/ansible-collections/community.docker/pull/971). +- docker_container - the ``purge_networks`` option has been removed. Use ``networks: strict`` in ``comparisons`` instead and make sure that ``networks`` is specified (https://github.com/ansible-collections/community.docker/pull/971). +- various modules and plugins - remove the ``ssl_version`` option (https://github.com/ansible-collections/community.docker/pull/971). + v3.13.1 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 1b2d4af1e..aee6fdfa0 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1927,3 +1927,27 @@ releases: - 3.13.1.yml - 976-compose-v2.yml release_date: '2024-10-15' + 4.0.0: + changes: + breaking_changes: + - docker_container - the default of ``image_name_mismatch`` changed from ``ignore`` + to ``recreate`` (https://github.com/ansible-collections/community.docker/pull/971). + minor_changes: + - docker_compose_v2 - add ``renew_anon_volumes`` parameter for ``docker compose + up`` (https://github.com/ansible-collections/community.docker/pull/977). + release_summary: Major release with removed deprecated features. + removed_features: + - The collection no longer supports ansible-core 2.11, 2.12, 2.13, and 2.14. + You need ansible-core 2.15.0 or newer to use community.docker 4.x.y (https://github.com/ansible-collections/community.docker/pull/971). + - The docker_compose module has been removed. Please migrate to community.docker.docker_compose_v2 + (https://github.com/ansible-collections/community.docker/pull/971). + - 'docker_container - the ``ignore_image`` option has been removed. Use ``image: + ignore`` in ``comparisons`` instead (https://github.com/ansible-collections/community.docker/pull/971).' + - 'docker_container - the ``purge_networks`` option has been removed. Use + ``networks: strict`` in ``comparisons`` instead and make sure that ``networks`` + is specified (https://github.com/ansible-collections/community.docker/pull/971).' + - various modules and plugins - remove the ``ssl_version`` option (https://github.com/ansible-collections/community.docker/pull/971). + fragments: + - 4.0.0.yml + - 977-renew_anon_volumes.yaml + release_date: '2024-10-20' diff --git a/changelogs/fragments/4.0.0.yml b/changelogs/fragments/4.0.0.yml deleted file mode 100644 index dc0e6ed6e..000000000 --- a/changelogs/fragments/4.0.0.yml +++ /dev/null @@ -1,9 +0,0 @@ -release_summary: Major release with removed deprecated features. -removed_features: - - "The collection no longer supports ansible-core 2.11, 2.12, 2.13, and 2.14. You need ansible-core 2.15.0 or newer to use community.docker 4.x.y (https://github.com/ansible-collections/community.docker/pull/971)." - - "The docker_compose module has been removed. Please migrate to community.docker.docker_compose_v2 (https://github.com/ansible-collections/community.docker/pull/971)." - - "various modules and plugins - remove the ``ssl_version`` option (https://github.com/ansible-collections/community.docker/pull/971)." - - "docker_container - the ``ignore_image`` option has been removed. Use ``image: ignore`` in ``comparisons`` instead (https://github.com/ansible-collections/community.docker/pull/971)." - - "docker_container - the ``purge_networks`` option has been removed. Use ``networks: strict`` in ``comparisons`` instead and make sure that ``networks`` is specified (https://github.com/ansible-collections/community.docker/pull/971)." -breaking_changes: - - "docker_container - the default of ``image_name_mismatch`` changed from ``ignore`` to ``recreate`` (https://github.com/ansible-collections/community.docker/pull/971)." diff --git a/changelogs/fragments/977-renew_anon_volumes.yaml b/changelogs/fragments/977-renew_anon_volumes.yaml deleted file mode 100644 index a457203e4..000000000 --- a/changelogs/fragments/977-renew_anon_volumes.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - docker_compose_v2 - add ``renew_anon_volumes`` parameter for ``docker compose up`` (https://github.com/ansible-collections/community.docker/pull/977).