From b6e698c1def9542535f37f45578f30ea5b85dbe6 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 19 May 2024 21:05:29 +0200 Subject: [PATCH] Release 3.10.0. --- CHANGELOG.md | 406 ++++++++++-------- CHANGELOG.rst | 26 ++ changelogs/changelog.yaml | 42 ++ changelogs/fragments/3.10.0.yml | 1 - .../836-docker_swarm_service-sysctls.yml | 2 - ...docker_network-config-from-config-only.yml | 2 - changelogs/fragments/845-docker_prune.yml | 2 - ...ntainer-heackcheck-test_cli_compatible.yml | 2 - ...-docker_api-healthcheck-start-interval.yml | 2 - .../fragments/852-docker_image_build.yml | 4 - changelogs/fragments/853-ssl_version.yml | 4 - changelogs/fragments/deprecate-compose-v1.yml | 4 - 12 files changed, 286 insertions(+), 211 deletions(-) delete mode 100644 changelogs/fragments/3.10.0.yml delete mode 100644 changelogs/fragments/836-docker_swarm_service-sysctls.yml delete mode 100644 changelogs/fragments/843-docker_network-config-from-config-only.yml delete mode 100644 changelogs/fragments/845-docker_prune.yml delete mode 100644 changelogs/fragments/847-docker_container-heackcheck-test_cli_compatible.yml delete mode 100644 changelogs/fragments/848-docker_api-healthcheck-start-interval.yml delete mode 100644 changelogs/fragments/852-docker_image_build.yml delete mode 100644 changelogs/fragments/853-ssl_version.yml delete mode 100644 changelogs/fragments/deprecate-compose-v1.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index f3a4b7af..d57f3a38 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,243 +2,273 @@ **Topics** -- v3\.9\.0 +- v3\.10\.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 - - Deprecated Features + - 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 + - Minor Changes - Breaking Changes / Porting Guide - Removed Features \(previously deprecated\) - Security Fixes - Bugfixes - v2\.7\.0 - - Release Summary - - Minor Changes - - Deprecated Features - - Bugfixes -- v2\.6\.0 - Release Summary - Minor Changes - Deprecated Features + - Bugfixes +- v2\.6\.0 + - 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 +- v2\.0\.0 + - Release Summary - Breaking Changes / Porting Guide - - Deprecated Features + - Deprecated Features - 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 - - Deprecated Features + - 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 - - Deprecated Features - - Bugfixes -- v1\.5\.0 - Release Summary - Minor Changes + - Deprecated Features + - Bugfixes +- v1\.5\.0 + - Release Summary + - Minor Changes - Bugfixes - New Modules - v1\.4\.0 - - Release Summary - - Minor Changes + - 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 - - Deprecated Features + - Bugfixes +- v1\.1\.0 + - Release Summary + - Minor Changes + - Deprecated Features - Bugfixes - New Plugins - Connection - 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 +- v0\.1\.0 + - Release Summary + - Minor Changes - Removed Features \(previously deprecated\) - Bugfixes - -## v3\.9\.0 + +## v3\.10\.0 ### Release Summary -Bugfix and feature release\. +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)\)\. +* docker\_container \- adds healthcheck\.test\_cli\_compatible to allow omit test option on containers without remove existing image test \([https\://github\.com/ansible\-collections/community\.docker/pull/847](https\://github\.com/ansible\-collections/community\.docker/pull/847)\)\. +* docker\_image\_build \- add outputs option to allow configuring outputs for the build \([https\://github\.com/ansible\-collections/community\.docker/pull/852](https\://github\.com/ansible\-collections/community\.docker/pull/852)\)\. +* docker\_image\_build \- add secrets option to allow passing secrets to the build \([https\://github\.com/ansible\-collections/community\.docker/pull/852](https\://github\.com/ansible\-collections/community\.docker/pull/852)\)\. +* docker\_image\_build \- allow platform to be a list of platforms instead of only a single platform for multi\-platform builds \([https\://github\.com/ansible\-collections/community\.docker/pull/852](https\://github\.com/ansible\-collections/community\.docker/pull/852)\)\. +* docker\_network \- adds config\_only and config\_from to support creating and using config only networks \([https\://github\.com/ansible\-collections/community\.docker/issues/395](https\://github\.com/ansible\-collections/community\.docker/issues/395)\)\. +* docker\_prune \- add new options builder\_cache\_all\, builder\_cache\_filters\, and builder\_cache\_keep\_storage\, and a new return value builder\_cache\_caches\_deleted for pruning build caches \([https\://github\.com/ansible\-collections/community\.docker/issues/844](https\://github\.com/ansible\-collections/community\.docker/issues/844)\, [https\://github\.com/ansible\-collections/community\.docker/issues/845](https\://github\.com/ansible\-collections/community\.docker/issues/845)\)\. +* docker\_swarm\_service \- adds sysctls to support sysctl settings on swarm services \([https\://github\.com/ansible\-collections/community\.docker/issues/190](https\://github\.com/ansible\-collections/community\.docker/issues/190)\)\. + + +### Deprecated Features + +* docker\_compose \- the Docker Compose v1 module is deprecated and will be removed from community\.docker 4\.0\.0\. Please migrate to the community\.docker\.docker\_compose\_v2 module\, which works with Docker Compose v2 \([https\://github\.com/ansible\-collections/community\.docker/issues/823](https\://github\.com/ansible\-collections/community\.docker/issues/823)\, [https\://github\.com/ansible\-collections/community\.docker/pull/833](https\://github\.com/ansible\-collections/community\.docker/pull/833)\)\. +* various modules and plugins \- the ssl\_version option has been deprecated and will be removed from community\.docker 4\.0\.0\. It has already been removed from Docker SDK for Python 7\.0\.0\, and was only necessary in the past to work around SSL/TLS issues \([https\://github\.com/ansible\-collections/community\.docker/pull/853](https\://github\.com/ansible\-collections/community\.docker/pull/853)\)\. + + +## 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)\)\. * docker\_compose\_v2\* \- the new option check\_files\_existing allows to disable the check for one of the files compose\.yaml\, compose\.yml\, docker\-compose\.yaml\, and docker\-compose\.yml in project\_src if files is not specified\. This is necessary if a non\-standard compose filename is specified through other means\, like the COMPOSE\_FILE environment variable \([https\://github\.com/ansible\-collections/community\.docker/issues/838](https\://github\.com/ansible\-collections/community\.docker/issues/838)\, [https\://github\.com/ansible\-collections/community\.docker/pull/839](https\://github\.com/ansible\-collections/community\.docker/pull/839)\)\. * docker\_compose\_v2\* modules \- allow to provide an inline definition of the compose content instead of having to provide a project\_src directory with the compose file written into it \([https\://github\.com/ansible\-collections/community\.docker/issues/829](https\://github\.com/ansible\-collections/community\.docker/issues/829)\, [https\://github\.com/ansible\-collections/community\.docker/pull/832](https\://github\.com/ansible\-collections/community\.docker/pull/832)\)\. @@ -254,7 +284,7 @@ Bugfix and feature release\. ## v3\.8\.1 - + ### Release Summary Bugfix release @@ -275,12 +305,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)\)\. @@ -297,12 +327,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)\)\. @@ -322,7 +352,7 @@ Bugfix and feature release\. ## v3\.6\.0 - + ### Release Summary Bugfix and feature release\. @@ -342,7 +372,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)\)\. @@ -372,18 +402,18 @@ 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)\)\. * docker\_container \- internal refactorings which allow comparisons to use more information like details of the current image or the Docker host config \([https\://github\.com/ansible\-collections/community\.docker/pull/713](https\://github\.com/ansible\-collections/community\.docker/pull/713)\)\. - + ### Deprecated Features * docker\_container \- the default ignore for the image\_name\_mismatch parameter has been deprecated and will switch to recreate in community\.docker 4\.0\.0\. A deprecation warning will be printed in situations where the default value is used and where a behavior would change once the default changes \([https\://github\.com/ansible\-collections/community\.docker/pull/703](https\://github\.com/ansible\-collections/community\.docker/pull/703)\)\. @@ -398,7 +428,7 @@ Bugfix and feature release\. ## v3\.4\.11 - + ### Release Summary Bugfix release\. @@ -411,7 +441,7 @@ Bugfix release\. ## v3\.4\.10 - + ### Release Summary Bugfix release\. @@ -424,7 +454,7 @@ Bugfix release\. ## v3\.4\.9 - + ### Release Summary Maintenance release with updated documentation and vendored Docker SDK for Python code\. @@ -437,7 +467,7 @@ Maintenance release with updated documentation and vendored Docker SDK for Pytho ## v3\.4\.8 - + ### Release Summary Maintenance release with updated documentation\. @@ -458,7 +488,7 @@ for the rendered HTML version of the documentation of the latest release\. ## v3\.4\.7 - + ### Release Summary Bugfix release\. @@ -471,7 +501,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\. @@ -493,7 +523,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\. @@ -506,12 +536,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)\)\. @@ -524,7 +554,7 @@ Maintenance release with updated EE requirements and updated documentation\. ## v3\.4\.3 - + ### Release Summary Maintenance release with improved documentation\. @@ -532,7 +562,7 @@ Maintenance release with improved documentation\. ## v3\.4\.2 - + ### Release Summary Bugfix release\. @@ -545,7 +575,7 @@ Bugfix release\. ## v3\.4\.1 - + ### Release Summary Regular bugfix release\. @@ -560,12 +590,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)\)\. @@ -587,7 +617,7 @@ Regular bugfix and feature release\. ## v3\.3\.2 - + ### Release Summary Bugfix release\. @@ -600,7 +630,7 @@ Bugfix release\. ## v3\.3\.1 - + ### Release Summary Bugfix release\. @@ -613,12 +643,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)\)\. @@ -633,7 +663,7 @@ Feature and bugfix release\. ## v3\.2\.2 - + ### Release Summary Bugfix release\. @@ -646,7 +676,7 @@ Bugfix release\. ## v3\.2\.1 - + ### Release Summary Maintenance release with improved documentation\. @@ -654,17 +684,17 @@ 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)\)\. - + ### Deprecated Features * docker\_container \- the ignore\_image option is deprecated and will be removed in community\.docker 4\.0\.0\. Use image\: ignore in comparisons instead \([https\://github\.com/ansible\-collections/community\.docker/pull/487](https\://github\.com/ansible\-collections/community\.docker/pull/487)\)\. @@ -673,12 +703,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)\)\. @@ -687,7 +717,7 @@ Feature release\. ## v3\.0\.2 - + ### Release Summary Bugfix release\. @@ -700,7 +730,7 @@ Bugfix release\. ## v3\.0\.1 - + ### Release Summary Bugfix release\. @@ -713,7 +743,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\. @@ -740,7 +770,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)\)\. @@ -794,17 +824,17 @@ 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)\)\. - + ### Deprecated Features * Support for Docker API version 1\.20 to 1\.24 has been deprecated and will be removed in community\.docker 3\.0\.0\. The first Docker version supporting API version 1\.25 was Docker 1\.13\, released in January 2017\. This affects the modules docker\_container\, docker\_container\_exec\, docker\_container\_info\, docker\_compose\, docker\_login\, docker\_image\, docker\_image\_info\, docker\_image\_load\, docker\_host\_info\, docker\_network\, docker\_network\_info\, docker\_node\_info\, docker\_swarm\_info\, docker\_swarm\_service\, docker\_swarm\_service\_info\, docker\_volume\_info\, and docker\_volume\, whose minimally supported API version is between 1\.20 and 1\.24 \([https\://github\.com/ansible\-collections/community\.docker/pull/396](https\://github\.com/ansible\-collections/community\.docker/pull/396)\)\. @@ -818,17 +848,17 @@ 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)\)\. - + ### Deprecated Features * Support for Ansible 2\.9 and ansible\-base 2\.10 is deprecated\, and will be removed in the next major release \(community\.docker 3\.0\.0\)\. Some modules might still work with these versions afterwards\, but we will no longer keep compatibility code that was needed to support them \([https\://github\.com/ansible\-collections/community\.docker/pull/361](https\://github\.com/ansible\-collections/community\.docker/pull/361)\)\. @@ -845,7 +875,7 @@ Bugfix and feature release\. ## v2\.5\.1 - + ### Release Summary Maintenance release\. @@ -858,12 +888,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)\)\. @@ -872,12 +902,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)\)\. @@ -892,12 +922,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)\)\. @@ -915,7 +945,7 @@ Regular feature and bugfix release\. ## v2\.2\.1 - + ### Release Summary Regular bugfix release\. @@ -928,12 +958,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)\)\. @@ -948,7 +978,7 @@ Regular feature and bugfix release\. ## v2\.1\.1 - + ### Release Summary Emergency release to amend breaking change in previous release\. @@ -961,12 +991,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)\)\. @@ -982,7 +1012,7 @@ Feature and bugfix release\. ## v2\.0\.2 - + ### Release Summary Bugfix release\. @@ -998,7 +1028,7 @@ Bugfix release\. ## v2\.0\.1 - + ### Release Summary Maintenance release with some documentation fixes\. @@ -1006,7 +1036,7 @@ 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\. @@ -1016,7 +1046,7 @@ New major release with some deprecations removed and a breaking change in the 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)\)\. - + ### Deprecated Features * docker\_container \- using the special value 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)\)\. @@ -1032,12 +1062,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)\)\. @@ -1047,7 +1077,7 @@ Regular feature and bugfix release\. ## v1\.9\.1 - + ### Release Summary Regular bugfix release\. @@ -1060,12 +1090,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)\)\. @@ -1074,7 +1104,7 @@ New bugfixes and features release\. * docker\_container \- added new command\_handling option with current deprecated default value compatibility which allows to control how the module handles shell quoting when interpreting lists\, and how the module handles empty lists/strings\. The default will switch to correct in community\.docker 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/pull/186](https\://github\.com/ansible\-collections/community\.docker/pull/186)\)\. * docker\_container \- lifted restriction preventing the creation of anonymous volumes with the mounts option \([https\://github\.com/ansible\-collections/community\.docker/pull/181](https\://github\.com/ansible\-collections/community\.docker/pull/181)\)\. - + ### Deprecated Features * docker\_container \- the new command\_handling\'s default value\, compatibility\, is deprecated and will change to correct in community\.docker 3\.0\.0\. A deprecation warning is emitted by the module in cases where the behavior will change\. Please note that ansible\-core will output a deprecation warning only once\, so if it is shown for an earlier task\, there could be more tasks with this warning where it is not shown \([https\://github\.com/ansible\-collections/community\.docker/pull/186](https\://github\.com/ansible\-collections/community\.docker/pull/186)\)\. @@ -1098,12 +1128,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)\)\. @@ -1120,12 +1150,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)\)\. @@ -1133,7 +1163,7 @@ Small feature and bugfix release\. ## v1\.6\.1 - + ### Release Summary Bugfix release to reduce deprecation warning spam\. @@ -1146,18 +1176,18 @@ 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)\)\. * docker\_container \- allow memory\_swap\: \-1 to set memory swap limit to unlimited\. This is useful when the user cannot set memory swap limits due to cgroup limitations or other reasons\, as by default Docker will try to set swap usage to two times the value of memory \([https\://github\.com/ansible\-collections/community\.docker/pull/138](https\://github\.com/ansible\-collections/community\.docker/pull/138)\)\. - + ### Deprecated Features * docker\_\* modules and plugins\, except docker\_swarm connection plugin and docker\_compose and docker\_stack\*\` modules \- the current default \`\`localhost for tls\_hostname is deprecated\. In community\.docker 2\.0\.0 it will be computed from docker\_host instead \([https\://github\.com/ansible\-collections/community\.docker/pull/134](https\://github\.com/ansible\-collections/community\.docker/pull/134)\)\. @@ -1172,12 +1202,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)\)\. @@ -1195,12 +1225,12 @@ 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)\)\. @@ -1224,12 +1254,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)\)\. @@ -1255,7 +1285,7 @@ Regular feature and bugfix release\. ## v1\.2\.2 - + ### Release Summary Security bugfix release to address CVE\-2021\-20191\. @@ -1268,7 +1298,7 @@ Security bugfix release to address CVE\-2021\-20191\. ## v1\.2\.1 - + ### Release Summary Bugfix release\. @@ -1281,12 +1311,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)\)\. @@ -1300,19 +1330,19 @@ 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)\)\. * docker\_container \- when a container is started with detached\=false\, status is now also returned when it is 0 \([https\://github\.com/ansible\-collections/community\.docker/issues/26](https\://github\.com/ansible\-collections/community\.docker/issues/26)\, [https\://github\.com/ansible\-collections/community\.docker/pull/58](https\://github\.com/ansible\-collections/community\.docker/pull/58)\)\. * docker\_image \- support platform when building images \([https\://github\.com/ansible\-collections/community\.docker/issues/22](https\://github\.com/ansible\-collections/community\.docker/issues/22)\, [https\://github\.com/ansible\-collections/community\.docker/pull/54](https\://github\.com/ansible\-collections/community\.docker/pull/54)\)\. - + ### Deprecated Features * docker\_container \- currently published\_ports can contain port mappings next to the special value all\, in which case the port mappings are ignored\. This behavior is deprecated for community\.docker 2\.0\.0\, at which point it will either be forbidden\, or this behavior will be properly implemented similar to how the Docker CLI tool handles this \([https\://github\.com/ansible\-collections/community\.docker/issues/8](https\://github\.com/ansible\-collections/community\.docker/issues/8)\, [https\://github\.com/ansible\-collections/community\.docker/pull/60](https\://github\.com/ansible\-collections/community\.docker/pull/60)\)\. @@ -1345,7 +1375,7 @@ Feature release with three new plugins and modules\. ## v1\.0\.1 - + ### Release Summary Maintenance release with a bugfix for docker\_container\. @@ -1358,12 +1388,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)\)\. @@ -1373,14 +1403,14 @@ 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)\)\. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1e2ef58a..8ec18e95 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,32 @@ Docker Community Collection Release Notes .. contents:: Topics +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). +- docker_container - adds ``healthcheck.test_cli_compatible`` to allow omit test option on containers without remove existing image test (https://github.com/ansible-collections/community.docker/pull/847). +- docker_image_build - add ``outputs`` option to allow configuring outputs for the build (https://github.com/ansible-collections/community.docker/pull/852). +- docker_image_build - add ``secrets`` option to allow passing secrets to the build (https://github.com/ansible-collections/community.docker/pull/852). +- docker_image_build - allow ``platform`` to be a list of platforms instead of only a single platform for multi-platform builds (https://github.com/ansible-collections/community.docker/pull/852). +- docker_network - adds ``config_only`` and ``config_from`` to support creating and using config only networks (https://github.com/ansible-collections/community.docker/issues/395). +- docker_prune - add new options ``builder_cache_all``, ``builder_cache_filters``, and ``builder_cache_keep_storage``, and a new return value ``builder_cache_caches_deleted`` for pruning build caches (https://github.com/ansible-collections/community.docker/issues/844, https://github.com/ansible-collections/community.docker/issues/845). +- docker_swarm_service - adds ``sysctls`` to support sysctl settings on swarm services (https://github.com/ansible-collections/community.docker/issues/190). + +Deprecated Features +------------------- + +- docker_compose - the Docker Compose v1 module is deprecated and will be removed from community.docker 4.0.0. Please migrate to the ``community.docker.docker_compose_v2`` module, which works with Docker Compose v2 (https://github.com/ansible-collections/community.docker/issues/823, https://github.com/ansible-collections/community.docker/pull/833). +- various modules and plugins - the ``ssl_version`` option has been deprecated and will be removed from community.docker 4.0.0. It has already been removed from Docker SDK for Python 7.0.0, and was only necessary in the past to work around SSL/TLS issues (https://github.com/ansible-collections/community.docker/pull/853). + v3.9.0 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index fc22ba44..3df40e78 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1002,6 +1002,48 @@ releases: - 466-add-data-path-port.yml - licenses.yml release_date: '2022-09-08' + 3.10.0: + changes: + deprecated_features: + - docker_compose - the Docker Compose v1 module is deprecated and will be removed + from community.docker 4.0.0. Please migrate to the ``community.docker.docker_compose_v2`` + module, which works with Docker Compose v2 (https://github.com/ansible-collections/community.docker/issues/823, + https://github.com/ansible-collections/community.docker/pull/833). + - various modules and plugins - the ``ssl_version`` option has been deprecated + and will be removed from community.docker 4.0.0. It has already been removed + from Docker SDK for Python 7.0.0, and was only necessary in the past to work + around SSL/TLS issues (https://github.com/ansible-collections/community.docker/pull/853). + 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). + - docker_container - adds ``healthcheck.test_cli_compatible`` to allow omit + test option on containers without remove existing image test (https://github.com/ansible-collections/community.docker/pull/847). + - docker_image_build - add ``outputs`` option to allow configuring outputs for + the build (https://github.com/ansible-collections/community.docker/pull/852). + - docker_image_build - add ``secrets`` option to allow passing secrets to the + build (https://github.com/ansible-collections/community.docker/pull/852). + - docker_image_build - allow ``platform`` to be a list of platforms instead + of only a single platform for multi-platform builds (https://github.com/ansible-collections/community.docker/pull/852). + - docker_network - adds ``config_only`` and ``config_from`` to support creating + and using config only networks (https://github.com/ansible-collections/community.docker/issues/395). + - docker_prune - add new options ``builder_cache_all``, ``builder_cache_filters``, + and ``builder_cache_keep_storage``, and a new return value ``builder_cache_caches_deleted`` + for pruning build caches (https://github.com/ansible-collections/community.docker/issues/844, + https://github.com/ansible-collections/community.docker/issues/845). + - docker_swarm_service - adds ``sysctls`` to support sysctl settings on swarm + services (https://github.com/ansible-collections/community.docker/issues/190). + release_summary: Feature release. + fragments: + - 3.10.0.yml + - 836-docker_swarm_service-sysctls.yml + - 843-docker_network-config-from-config-only.yml + - 845-docker_prune.yml + - 847-docker_container-heackcheck-test_cli_compatible.yml + - 848-docker_api-healthcheck-start-interval.yml + - 852-docker_image_build.yml + - 853-ssl_version.yml + - deprecate-compose-v1.yml + release_date: '2024-05-19' 3.2.0: changes: deprecated_features: diff --git a/changelogs/fragments/3.10.0.yml b/changelogs/fragments/3.10.0.yml deleted file mode 100644 index 512efc99..00000000 --- a/changelogs/fragments/3.10.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: Feature release. diff --git a/changelogs/fragments/836-docker_swarm_service-sysctls.yml b/changelogs/fragments/836-docker_swarm_service-sysctls.yml deleted file mode 100644 index 9f863b7c..00000000 --- a/changelogs/fragments/836-docker_swarm_service-sysctls.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - docker_swarm_service - adds ``sysctls`` to support sysctl settings on swarm services (https://github.com/ansible-collections/community.docker/issues/190). \ No newline at end of file diff --git a/changelogs/fragments/843-docker_network-config-from-config-only.yml b/changelogs/fragments/843-docker_network-config-from-config-only.yml deleted file mode 100644 index df61f229..00000000 --- a/changelogs/fragments/843-docker_network-config-from-config-only.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - docker_network - adds ``config_only`` and ``config_from`` to support creating and using config only networks (https://github.com/ansible-collections/community.docker/issues/395). diff --git a/changelogs/fragments/845-docker_prune.yml b/changelogs/fragments/845-docker_prune.yml deleted file mode 100644 index 6ee56adb..00000000 --- a/changelogs/fragments/845-docker_prune.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "docker_prune - add new options ``builder_cache_all``, ``builder_cache_filters``, and ``builder_cache_keep_storage``, and a new return value ``builder_cache_caches_deleted`` for pruning build caches (https://github.com/ansible-collections/community.docker/issues/844, https://github.com/ansible-collections/community.docker/issues/845)." diff --git a/changelogs/fragments/847-docker_container-heackcheck-test_cli_compatible.yml b/changelogs/fragments/847-docker_container-heackcheck-test_cli_compatible.yml deleted file mode 100644 index dd960a97..00000000 --- a/changelogs/fragments/847-docker_container-heackcheck-test_cli_compatible.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - docker_container - adds ``healthcheck.test_cli_compatible`` to allow omit test option on containers without remove existing image test (https://github.com/ansible-collections/community.docker/pull/847). diff --git a/changelogs/fragments/848-docker_api-healthcheck-start-interval.yml b/changelogs/fragments/848-docker_api-healthcheck-start-interval.yml deleted file mode 100644 index 88ebf9bb..00000000 --- a/changelogs/fragments/848-docker_api-healthcheck-start-interval.yml +++ /dev/null @@ -1,2 +0,0 @@ -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). diff --git a/changelogs/fragments/852-docker_image_build.yml b/changelogs/fragments/852-docker_image_build.yml deleted file mode 100644 index a45fbd5c..00000000 --- a/changelogs/fragments/852-docker_image_build.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: - - "docker_image_build - allow ``platform`` to be a list of platforms instead of only a single platform for multi-platform builds (https://github.com/ansible-collections/community.docker/pull/852)." - - "docker_image_build - add ``secrets`` option to allow passing secrets to the build (https://github.com/ansible-collections/community.docker/pull/852)." - - "docker_image_build - add ``outputs`` option to allow configuring outputs for the build (https://github.com/ansible-collections/community.docker/pull/852)." diff --git a/changelogs/fragments/853-ssl_version.yml b/changelogs/fragments/853-ssl_version.yml deleted file mode 100644 index 60b39701..00000000 --- a/changelogs/fragments/853-ssl_version.yml +++ /dev/null @@ -1,4 +0,0 @@ -deprecated_features: - - "various modules and plugins - the ``ssl_version`` option has been deprecated and will be removed from community.docker 4.0.0. - It has already been removed from Docker SDK for Python 7.0.0, and was only necessary in the past to work around SSL/TLS issues - (https://github.com/ansible-collections/community.docker/pull/853)." diff --git a/changelogs/fragments/deprecate-compose-v1.yml b/changelogs/fragments/deprecate-compose-v1.yml deleted file mode 100644 index 30f01049..00000000 --- a/changelogs/fragments/deprecate-compose-v1.yml +++ /dev/null @@ -1,4 +0,0 @@ -deprecated_features: - - "docker_compose - the Docker Compose v1 module is deprecated and will be removed from community.docker 4.0.0. - Please migrate to the ``community.docker.docker_compose_v2`` module, which works with Docker Compose v2 - (https://github.com/ansible-collections/community.docker/issues/823, https://github.com/ansible-collections/community.docker/pull/833)."