diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..eae8d7222 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,885 @@ +# Docker Community Collection Release Notes + +**Topics** +- v2\.7\.8 + - Release Summary + - Bugfixes +- v2\.7\.7 + - Release Summary + - Bugfixes +- v2\.7\.6 + - Release Summary + - Bugfixes +- v2\.7\.5 + - Release Summary + - Bugfixes +- v2\.7\.4 + - Release Summary + - Bugfixes +- v2\.7\.3 + - Release Summary + - Bugfixes +- v2\.7\.2 + - Release Summary + - Minor Changes +- v2\.7\.1 + - Release Summary + - Bugfixes +- v2\.7\.0 + - Release Summary + - Minor Changes + - Deprecated Features + - Bugfixes +- v2\.6\.0 + - Release Summary + - Minor Changes + - Deprecated Features + - Bugfixes +- v2\.5\.1 + - Release Summary + - Bugfixes +- v2\.5\.0 + - Release Summary + - Minor Changes +- v2\.4\.0 + - Release Summary + - Minor Changes + - Bugfixes +- v2\.3\.0 + - Release Summary + - Minor Changes + - Bugfixes +- v2\.2\.1 + - Release Summary + - Bugfixes +- v2\.2\.0 + - Release Summary + - Minor Changes + - Bugfixes +- v2\.1\.1 + - Release Summary + - Bugfixes +- v2\.1\.0 + - Release Summary + - Minor Changes + - Bugfixes +- v2\.0\.2 + - Release Summary + - Bugfixes +- v2\.0\.1 + - Release Summary +- v2\.0\.0 + - Release Summary + - Breaking Changes / Porting Guide + - Deprecated Features + - Removed Features \(previously deprecated\) +- v1\.10\.0 + - Release Summary + - Minor Changes +- v1\.9\.1 + - Release Summary + - Bugfixes +- v1\.9\.0 + - 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 + - Release Summary + - Bugfixes +- v1\.6\.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 + - Breaking Changes / Porting Guide + - Security Fixes + - Bugfixes +- v1\.3\.0 + - Release Summary + - Minor Changes + - Bugfixes + - New Modules +- v1\.2\.2 + - Release Summary + - Security Fixes +- v1\.2\.1 + - Release Summary + - Bugfixes +- v1\.2\.0 + - Release Summary + - Minor Changes + - Bugfixes +- v1\.1\.0 + - Release Summary + - Minor Changes + - Deprecated Features + - Bugfixes + - New Plugins + - Connection + - Inventory + - New Modules +- v1\.0\.1 + - Release Summary + - Bugfixes +- v1\.0\.0 + - Release Summary + - Minor Changes +- v0\.1\.0 + - Release Summary + - Minor Changes + - Removed Features \(previously deprecated\) + - Bugfixes + + +## v2\.7\.8 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* Execution Environment requirements \- restrict Docker SDK for Python to \< 7\.0\.0\, as 7\.0\.0 is incompatible with docker\-compose \([https\://github\.com/ansible\-collections/community\.docker/pull/719](https\://github\.com/ansible\-collections/community\.docker/pull/719)\)\. +* modules and plugins using the Docker SDK for Python \- remove ssl\_version from the parameters passed to Docker SDK for Python 7\.0\.0\+\. Explicitly fail with a nicer error message if it was explicitly set in this case \([https\://github\.com/ansible\-collections/community\.docker/pull/715](https\://github\.com/ansible\-collections/community\.docker/pull/715)\)\. +* modules and plugins using the Docker SDK for Python \- remove tls\_hostname from the parameters passed to Docker SDK for Python 7\.0\.0\+\. Explicitly fail with a nicer error message if it was explicitly set in this case \([https\://github\.com/ansible\-collections/community\.docker/pull/721](https\://github\.com/ansible\-collections/community\.docker/pull/721)\)\. + + +## v2\.7\.7 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* docker\_swarm \- make init and join operations work again with Docker SDK for Python before 4\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/695](https\://github\.com/ansible\-collections/community\.docker/issues/695)\, [https\://github\.com/ansible\-collections/community\.docker/pull/696](https\://github\.com/ansible\-collections/community\.docker/pull/696)\)\. +* docker\_volume \- fix crash caused by accessing an empty dictionary\. The has\_different\_config\(\) was raising an AttributeError because the self\.existing\_volume\[\"Labels\"\] dictionary was None \([https\://github\.com/ansible\-collections/community\.docker/pull/702](https\://github\.com/ansible\-collections/community\.docker/pull/702)\)\. + + +## v2\.7\.6 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* docker\_swarm\_info \- if service\=true is used\, do not crash when a service without an endpoint spec is encountered \([https\://github\.com/ansible\-collections/community\.docker/issues/636](https\://github\.com/ansible\-collections/community\.docker/issues/636)\, [https\://github\.com/ansible\-collections/community\.docker/pull/637](https\://github\.com/ansible\-collections/community\.docker/pull/637)\)\. + + +## v2\.7\.5 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* docker\_prune \- return correct value for changed\. So far the module always claimed that nothing changed \([https\://github\.com/ansible\-collections/community\.docker/pull/593](https\://github\.com/ansible\-collections/community\.docker/pull/593)\)\. +* various plugins and modules \- remove unnecessary imports \([https\://github\.com/ansible\-collections/community\.docker/pull/574](https\://github\.com/ansible\-collections/community\.docker/pull/574)\)\. + + +## v2\.7\.4 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* docker\_api connection plugin \- fix error handling when 409 Conflict is returned by the Docker daemon in case of a stopped container \([https\://github\.com/ansible\-collections/community\.docker/pull/546](https\://github\.com/ansible\-collections/community\.docker/pull/546)\)\. +* docker\_container\_exec \- fix error handling when 409 Conflict is returned by the Docker daemon in case of a stopped container \([https\://github\.com/ansible\-collections/community\.docker/pull/546](https\://github\.com/ansible\-collections/community\.docker/pull/546)\)\. +* docker\_plugin \- do not crash if plugin is installed in check mode \([https\://github\.com/ansible\-collections/community\.docker/issues/552](https\://github\.com/ansible\-collections/community\.docker/issues/552)\, [https\://github\.com/ansible\-collections/community\.docker/pull/553](https\://github\.com/ansible\-collections/community\.docker/pull/553)\)\. +* most modules \- fix handling of DOCKER\_TIMEOUT environment variable\, and improve handling of other fallback environment variables \([https\://github\.com/ansible\-collections/community\.docker/issues/551](https\://github\.com/ansible\-collections/community\.docker/issues/551)\, [https\://github\.com/ansible\-collections/community\.docker/pull/554](https\://github\.com/ansible\-collections/community\.docker/pull/554)\)\. + + +## v2\.7\.3 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* current\_container\_facts \- make container detection work better in more cases \([https\://github\.com/ansible\-collections/community\.docker/pull/522](https\://github\.com/ansible\-collections/community\.docker/pull/522)\)\. + + +## v2\.7\.2 + + +### Release Summary + +Bugfix release\. + + +### Minor Changes + +* current\_container\_facts \- make work with current Docker version \([https\://github\.com/ansible\-collections/community\.docker/pull/510](https\://github\.com/ansible\-collections/community\.docker/pull/510)\, [https\://github\.com/ansible\-collections/community\.docker/pull/512](https\://github\.com/ansible\-collections/community\.docker/pull/512)\)\. + + +## v2\.7\.1 + + +### Release Summary + +Maintenance release with updated documentation\. + + +### Bugfixes + +* docker\_stack \- fix broken string formatting when reporting error in case compose was containing invalid values \([https\://github\.com/ansible\-collections/community\.docker/pull/448](https\://github\.com/ansible\-collections/community\.docker/pull/448)\)\. + + +## 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)\)\. +* Support for Python 2\.6 is deprecated and will be removed in the next major release \(community\.docker 3\.0\.0\)\. Some modules might still work with Python 2\.6\, but we will no longer try to ensure compatibility \([https\://github\.com/ansible\-collections/community\.docker/pull/388](https\://github\.com/ansible\-collections/community\.docker/pull/388)\)\. + + +### Bugfixes + +* Docker SDK for Python based modules and plugins \- if the API version is specified as an option\, use that one to validate API version requirements of module/plugin options instead of the latest API version supported by the Docker daemon\. This also avoids one unnecessary API call per module/plugin \([https\://github\.com/ansible\-collections/community\.docker/pull/389](https\://github\.com/ansible\-collections/community\.docker/pull/389)\)\. + + +## 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)\)\. +* The dependency on docker\-compose for Execution Environments is deprecated and will be removed in community\.docker 3\.0\.0\. The [Python docker\-compose library](https\://pypi\.org/project/docker\-compose/) is unmaintained and can cause dependency issues\. You can manually still install it in an Execution Environment when needed \([https\://github\.com/ansible\-collections/community\.docker/pull/373](https\://github\.com/ansible\-collections/community\.docker/pull/373)\)\. +* Various modules \- the default of tls\_hostname that was supposed to be removed in community\.docker 2\.0\.0 will now be removed in version 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/pull/362](https\://github\.com/ansible\-collections/community\.docker/pull/362)\)\. +* docker\_stack \- the return values out and err that were supposed to be removed in community\.docker 2\.0\.0 will now be removed in version 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/pull/362](https\://github\.com/ansible\-collections/community\.docker/pull/362)\)\. + + +### Bugfixes + +* docker\_container \- fail with a meaningful message instead of crashing if a port is specified with more than three colon\-separated parts \([https\://github\.com/ansible\-collections/community\.docker/pull/367](https\://github\.com/ansible\-collections/community\.docker/pull/367)\, [https\://github\.com/ansible\-collections/community\.docker/issues/365](https\://github\.com/ansible\-collections/community\.docker/issues/365)\)\. +* docker\_container \- remove unused code that will cause problems with Python 3\.13 \([https\://github\.com/ansible\-collections/community\.docker/pull/354](https\://github\.com/ansible\-collections/community\.docker/pull/354)\)\. + + +## v2\.5\.1 + + +### Release Summary + +Maintenance release\. + + +### Bugfixes + +* Include PSF\-license\.txt file for plugins/module\_utils/\_version\.py\. + + +## 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)\)\. +* docker\_swarm \- adds data\_path\_addr parameter during swarm initialization or when joining \([https\://github\.com/ansible\-collections/community\.docker/issues/339](https\://github\.com/ansible\-collections/community\.docker/issues/339)\)\. + + +## 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)\)\. +* current\_container\_facts \- add detection for GitHub Actions \([https\://github\.com/ansible\-collections/community\.docker/pull/336](https\://github\.com/ansible\-collections/community\.docker/pull/336)\)\. +* docker\_container \- support returning Docker container log output when using Docker\'s local logging driver\, an optimized local logging driver introduced in Docker 18\.09 \([https\://github\.com/ansible\-collections/community\.docker/pull/337](https\://github\.com/ansible\-collections/community\.docker/pull/337)\)\. + + +### Bugfixes + +* docker connection plugin \- make sure that docker\_extra\_args is used for querying the Docker version\. Also ensures that the Docker version is only queried when needed\. This is currently the case if a remote user is specified \([https\://github\.com/ansible\-collections/community\.docker/issues/325](https\://github\.com/ansible\-collections/community\.docker/issues/325)\, [https\://github\.com/ansible\-collections/community\.docker/pull/327](https\://github\.com/ansible\-collections/community\.docker/pull/327)\)\. + + +## 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)\)\. +* docker connection plugin \- simplify actual\_user handling code \([https\://github\.com/ansible\-collections/community\.docker/pull/311](https\://github\.com/ansible\-collections/community\.docker/pull/311)\)\. +* docker connection plugin \- the plugin supports new ways to define the timeout\. These are the ANSIBLE\_DOCKER\_TIMEOUT environment variable\, the timeout setting in the docker\_connection section of ansible\.cfg\, and the ansible\_docker\_timeout variable \([https\://github\.com/ansible\-collections/community\.docker/pull/297](https\://github\.com/ansible\-collections/community\.docker/pull/297)\)\. +* docker\_api connection plugin \- implement connection reset by clearing internal container user/group ID cache \([https\://github\.com/ansible\-collections/community\.docker/pull/312](https\://github\.com/ansible\-collections/community\.docker/pull/312)\)\. +* docker\_api connection plugin \- the plugin supports new ways to define the timeout\. These are the ANSIBLE\_DOCKER\_TIMEOUT environment variable\, the timeout setting in the docker\_connection section of ansible\.cfg\, and the ansible\_docker\_timeout variable \([https\://github\.com/ansible\-collections/community\.docker/pull/308](https\://github\.com/ansible\-collections/community\.docker/pull/308)\)\. + + +### Bugfixes + +* docker connection plugin \- fix option handling to be compatible with ansible\-core 2\.13 \([https\://github\.com/ansible\-collections/community\.docker/pull/297](https\://github\.com/ansible\-collections/community\.docker/pull/297)\, [https\://github\.com/ansible\-collections/community\.docker/issues/307](https\://github\.com/ansible\-collections/community\.docker/issues/307)\)\. +* docker\_api connection plugin \- fix option handling to be compatible with ansible\-core 2\.13 \([https\://github\.com/ansible\-collections/community\.docker/pull/308](https\://github\.com/ansible\-collections/community\.docker/pull/308)\)\. + + +## v2\.2\.1 + + +### Release Summary + +Regular bugfix release\. + + +### Bugfixes + +* docker\_compose \- fix Python 3 type error when extracting warnings or errors from docker\-compose\'s output \([https\://github\.com/ansible\-collections/community\.docker/pull/305](https\://github\.com/ansible\-collections/community\.docker/pull/305)\)\. + + +## 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)\)\. +* docker\_secret \- add support for rolling update\, set rolling\_versions to true to enable \([https\://github\.com/ansible\-collections/community\.docker/pull/293](https\://github\.com/ansible\-collections/community\.docker/pull/293)\, [https\://github\.com/ansible\-collections/community\.docker/issues/21](https\://github\.com/ansible\-collections/community\.docker/issues/21)\)\. +* docker\_swarm\_service \- add support for setting capabilities with the cap\_add and cap\_drop parameters\. Usage is the same as with the capabilities and cap\_drop parameters for docker\_container \([https\://github\.com/ansible\-collections/community\.docker/pull/294](https\://github\.com/ansible\-collections/community\.docker/pull/294)\)\. + + +### Bugfixes + +* docker\_container\, docker\_image \- adjust image finding code to pecularities of podman\-docker\'s API emulation when Docker short names like redis are used \([https\://github\.com/ansible\-collections/community\.docker/issues/292](https\://github\.com/ansible\-collections/community\.docker/issues/292)\)\. + + +## v2\.1\.1 + + +### Release Summary + +Emergency release to amend breaking change in previous release\. + + +### Bugfixes + +* Fix unintended breaking change caused by [an earlier fix](https\://github\.com/ansible\-collections/community\.docker/pull/258) by vendoring the deprecated Python standard library distutils\.version until this collection stops supporting Ansible 2\.9 and ansible\-base 2\.10 \([https\://github\.com/ansible\-collections/community\.docker/issues/267](https\://github\.com/ansible\-collections/community\.docker/issues/267)\, [https\://github\.com/ansible\-collections/community\.docker/pull/269](https\://github\.com/ansible\-collections/community\.docker/pull/269)\)\. + + +## 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)\)\. +* docker\_container\_exec \- add env option \([https\://github\.com/ansible\-collections/community\.docker/issues/248](https\://github\.com/ansible\-collections/community\.docker/issues/248)\, [https\://github\.com/ansible\-collections/community\.docker/pull/254](https\://github\.com/ansible\-collections/community\.docker/pull/254)\)\. + + +### Bugfixes + +* Various modules and plugins \- use vendored version of distutils\.version included in ansible\-core 2\.12 if available\. This avoids breakage when distutils is removed from the standard library of Python 3\.12\. Note that ansible\-core 2\.11\, ansible\-base 2\.10 and Ansible 2\.9 are right now not compatible with Python 3\.12\, hence this fix does not target these ansible\-core/\-base/2\.9 versions \([https\://github\.com/ansible\-collections/community\.docker/pull/258](https\://github\.com/ansible\-collections/community\.docker/pull/258)\)\. +* docker connection plugin \- replace deprecated distutils\.spawn\.find\_executable with Ansible\'s get\_bin\_path to find the docker executable \([https\://github\.com/ansible\-collections/community\.docker/pull/257](https\://github\.com/ansible\-collections/community\.docker/pull/257)\)\. +* docker\_container\_exec \- disallow using the chdir option for Docker API before 1\.35 \([https\://github\.com/ansible\-collections/community\.docker/pull/253](https\://github\.com/ansible\-collections/community\.docker/pull/253)\)\. + + +## v2\.0\.2 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* docker\_api connection plugin \- avoid passing an unnecessary argument to a Docker SDK for Python call that is only supported by version 3\.0\.0 or later \([https\://github\.com/ansible\-collections/community\.docker/pull/243](https\://github\.com/ansible\-collections/community\.docker/pull/243)\)\. +* docker\_container\_exec \- chdir is only supported since Docker SDK for Python 3\.0\.0\. Make sure that this option can only use when 3\.0\.0 or later is installed\, and prevent passing this parameter on when chdir is not provided to this module \([https\://github\.com/ansible\-collections/community\.docker/pull/243](https\://github\.com/ansible\-collections/community\.docker/pull/243)\, [https\://github\.com/ansible\-collections/community\.docker/issues/242](https\://github\.com/ansible\-collections/community\.docker/issues/242)\)\. +* nsenter connection plugin \- ensure the nsenter\_pid option is retrieved in \_connect instead of \_\_init\_\_ to prevent a crasher due to bad initialization order \([https\://github\.com/ansible\-collections/community\.docker/pull/249](https\://github\.com/ansible\-collections/community\.docker/pull/249)\)\. +* nsenter connection plugin \- replace the use of \-\-all\-namespaces with specific namespaces to support compatibility with Busybox nsenter \(used on\, for example\, Alpine containers\) \([https\://github\.com/ansible\-collections/community\.docker/pull/249](https\://github\.com/ansible\-collections/community\.docker/pull/249)\)\. + + +## v2\.0\.1 + + +### Release Summary + +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)\)\. + + +### 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)\)\. + + +### 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)\)\. +* docker\_container \- the default value of network\_mode is now the name of the first network specified in networks if such are specified and networks\_cli\_compatible\=true \([https\://github\.com/ansible\-collections/community\.docker/pull/210](https\://github\.com/ansible\-collections/community\.docker/pull/210)\)\. +* docker\_container \- the special value all can no longer be used in published\_ports next to other values\. Please use publish\_all\_ports\=true instead \([https\://github\.com/ansible\-collections/community\.docker/pull/210](https\://github\.com/ansible\-collections/community\.docker/pull/210)\)\. +* docker\_login \- removed the email option \([https\://github\.com/ansible\-collections/community\.docker/pull/210](https\://github\.com/ansible\-collections/community\.docker/pull/210)\)\. + + +## 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)\)\. +* docker\_config \- add option data\_src to read configuration data from target \([https\://github\.com/ansible\-collections/community\.docker/issues/64](https\://github\.com/ansible\-collections/community\.docker/issues/64)\, [https\://github\.com/ansible\-collections/community\.docker/pull/203](https\://github\.com/ansible\-collections/community\.docker/pull/203)\)\. +* docker\_secret \- add option data\_src to read secret data from target \([https\://github\.com/ansible\-collections/community\.docker/issues/64](https\://github\.com/ansible\-collections/community\.docker/issues/64)\, [https\://github\.com/ansible\-collections/community\.docker/pull/203](https\://github\.com/ansible\-collections/community\.docker/pull/203)\)\. + + +## v1\.9\.1 + + +### Release Summary + +Regular bugfix release\. + + +### Bugfixes + +* docker\_compose \- fixed incorrect changed status for services with profiles defined\, but none enabled \([https\://github\.com/ansible\-collections/community\.docker/pull/192](https\://github\.com/ansible\-collections/community\.docker/pull/192)\)\. + + +## 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)\)\. +* docker\_compose \- added env\_file option for specifying custom environment files \([https\://github\.com/ansible\-collections/community\.docker/pull/174](https\://github\.com/ansible\-collections/community\.docker/pull/174)\)\. +* docker\_container \- added publish\_all\_ports option to publish all exposed ports to random ports except those explicitly bound with published\_ports \(this was already added in community\.docker 1\.8\.0\) \([https\://github\.com/ansible\-collections/community\.docker/pull/162](https\://github\.com/ansible\-collections/community\.docker/pull/162)\)\. +* 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)\)\. + + +### Bugfixes + +* docker\_compose \- fixes task failures when bringing up services while using docker\-compose \<1\.17\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/180](https\://github\.com/ansible\-collections/community\.docker/issues/180)\)\. +* docker\_container \- make sure to also return container on detached\=false when status code is non\-zero \([https\://github\.com/ansible\-collections/community\.docker/pull/178](https\://github\.com/ansible\-collections/community\.docker/pull/178)\)\. +* docker\_stack\_info \- make sure that module isn\'t skipped in check mode \([https\://github\.com/ansible\-collections/community\.docker/pull/183](https\://github\.com/ansible\-collections/community\.docker/pull/183)\)\. +* docker\_stack\_task\_info \- make sure that module isn\'t skipped in check mode \([https\://github\.com/ansible\-collections/community\.docker/pull/183](https\://github\.com/ansible\-collections/community\.docker/pull/183)\)\. + + +### New Plugins + + +#### Connection + +* nsenter \- execute on host running controller container + + +## 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)\)\. +* docker\_compose \- added profiles option to specify service profiles when starting services \([https\://github\.com/ansible\-collections/community\.docker/pull/167](https\://github\.com/ansible\-collections/community\.docker/pull/167)\)\. +* docker\_containers inventory plugin \- when connection\_type\=docker\-api\, now pass Docker daemon connection options from inventory plugin to connection plugin\. This can be disabled by setting configure\_docker\_daemon\=false \([https\://github\.com/ansible\-collections/community\.docker/pull/157](https\://github\.com/ansible\-collections/community\.docker/pull/157)\)\. +* docker\_host\_info \- allow values for keys in containers\_filters\, images\_filters\, networks\_filters\, and volumes\_filters to be passed as YAML lists \([https\://github\.com/ansible\-collections/community\.docker/pull/160](https\://github\.com/ansible\-collections/community\.docker/pull/160)\)\. +* docker\_plugin \- added alias option to specify local names for docker plugins \([https\://github\.com/ansible\-collections/community\.docker/pull/161](https\://github\.com/ansible\-collections/community\.docker/pull/161)\)\. + + +### Bugfixes + +* docker\_compose \- fix idempotence bug when using stopped\: true \([https\://github\.com/ansible\-collections/community\.docker/issues/142](https\://github\.com/ansible\-collections/community\.docker/issues/142)\, [https\://github\.com/ansible\-collections/community\.docker/pull/159](https\://github\.com/ansible\-collections/community\.docker/pull/159)\)\. + + +## 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)\)\. + + +## v1\.6\.1 + + +### Release Summary + +Bugfix release to reduce deprecation warning spam\. + + +### Bugfixes + +* docker\_\* modules and plugins\, except docker\_swarm connection plugin and docker\_compose and docker\_stack\*\` modules \- only emit \`\`tls\_hostname deprecation message if TLS is actually used \([https\://github\.com/ansible\-collections/community\.docker/pull/143](https\://github\.com/ansible\-collections/community\.docker/pull/143)\)\. + + +## 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)\)\. + + +### Bugfixes + +* docker\-compose \- fix not pulling when state\: present and stopped\: true \([https\://github\.com/ansible\-collections/community\.docker/issues/12](https\://github\.com/ansible\-collections/community\.docker/issues/12)\, [https\://github\.com/ansible\-collections/community\.docker/pull/119](https\://github\.com/ansible\-collections/community\.docker/pull/119)\)\. +* docker\_plugin \- also configure plugin after installing \([https\://github\.com/ansible\-collections/community\.docker/issues/118](https\://github\.com/ansible\-collections/community\.docker/issues/118)\, [https\://github\.com/ansible\-collections/community\.docker/pull/135](https\://github\.com/ansible\-collections/community\.docker/pull/135)\)\. +* docker\_swarm\_services \- avoid crash during idempotence check if published\_port is not specified \([https\://github\.com/ansible\-collections/community\.docker/issues/107](https\://github\.com/ansible\-collections/community\.docker/issues/107)\, [https\://github\.com/ansible\-collections/community\.docker/pull/136](https\://github\.com/ansible\-collections/community\.docker/pull/136)\)\. + + +## 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)\)\. + + +### Bugfixes + +* all modules \- use to\_native to convert exceptions to strings \([https\://github\.com/ansible\-collections/community\.docker/pull/121](https\://github\.com/ansible\-collections/community\.docker/pull/121)\)\. + + +### New Modules + +* docker\_container\_exec \- Execute command in a docker container + + +## 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)\)\. + + +### Security Fixes + +* docker\_swarm \- the join\_token option is now marked as no\_log so it is no longer written into logs \([https\://github\.com/ansible\-collections/community\.docker/pull/103](https\://github\.com/ansible\-collections/community\.docker/pull/103)\)\. + + +### Bugfixes + +* docker\_swarm\_service \- fix KeyError on caused by reference to deprecated option update\_failure\_action \([https\://github\.com/ansible\-collections/community\.docker/pull/100](https\://github\.com/ansible\-collections/community\.docker/pull/100)\)\. +* docker\_swarm\_service \- mark secrets module option with no\_log\=False since it does not leak secrets \([https\://github\.com/ansible\-collections/community\.general/pull/2001](https\://github\.com/ansible\-collections/community\.general/pull/2001)\)\. + + +## 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)\)\. +* docker\_image \- allows to specify platform to pull for source\=pull with new option pull\_platform \([https\://github\.com/ansible\-collections/community\.docker/issues/79](https\://github\.com/ansible\-collections/community\.docker/issues/79)\, [https\://github\.com/ansible\-collections/community\.docker/pull/89](https\://github\.com/ansible\-collections/community\.docker/pull/89)\)\. +* docker\_image \- properly support image IDs \(hashes\) for loading and tagging images \([https\://github\.com/ansible\-collections/community\.docker/issues/86](https\://github\.com/ansible\-collections/community\.docker/issues/86)\, [https\://github\.com/ansible\-collections/community\.docker/pull/87](https\://github\.com/ansible\-collections/community\.docker/pull/87)\)\. +* docker\_swarm\_service \- adding support for maximum number of tasks per node \(replicas\_max\_per\_node\) when running swarm service in replicated mode\. Introduced in API 1\.40 \([https\://github\.com/ansible\-collections/community\.docker/issues/7](https\://github\.com/ansible\-collections/community\.docker/issues/7)\, [https\://github\.com/ansible\-collections/community\.docker/pull/92](https\://github\.com/ansible\-collections/community\.docker/pull/92)\)\. + + +### Bugfixes + +* docker\_container \- fix healthcheck disabling idempotency issue with strict comparison \([https\://github\.com/ansible\-collections/community\.docker/issues/85](https\://github\.com/ansible\-collections/community\.docker/issues/85)\)\. +* docker\_image \- prevent module failure when removing image that is removed between inspection and removal \([https\://github\.com/ansible\-collections/community\.docker/pull/87](https\://github\.com/ansible\-collections/community\.docker/pull/87)\)\. +* docker\_image \- prevent module failure when removing non\-existant image by ID \([https\://github\.com/ansible\-collections/community\.docker/pull/87](https\://github\.com/ansible\-collections/community\.docker/pull/87)\)\. +* docker\_image\_info \- prevent module failure when image vanishes between listing and inspection \([https\://github\.com/ansible\-collections/community\.docker/pull/87](https\://github\.com/ansible\-collections/community\.docker/pull/87)\)\. +* docker\_image\_info \- prevent module failure when querying non\-existant image by ID \([https\://github\.com/ansible\-collections/community\.docker/pull/87](https\://github\.com/ansible\-collections/community\.docker/pull/87)\)\. + + +### New Modules + +* docker\_image\_load \- Load docker image\(s\) from archives +* docker\_plugin \- Manage Docker plugins + + +## v1\.2\.2 + + +### Release Summary + +Security bugfix release to address CVE\-2021\-20191\. + + +### Security Fixes + +* docker\_swarm \- enabled no\_log for the option signing\_ca\_key to prevent accidental disclosure \(CVE\-2021\-20191\, [https\://github\.com/ansible\-collections/community\.docker/pull/80](https\://github\.com/ansible\-collections/community\.docker/pull/80)\)\. + + +## v1\.2\.1 + + +### Release Summary + +Bugfix release\. + + +### Bugfixes + +* docker connection plugin \- fix Docker version parsing\, as some docker versions have a leading v in the output of the command docker version \-\-format \"\{\{\.Server\.Version\}\}\" \([https\://github\.com/ansible\-collections/community\.docker/pull/76](https\://github\.com/ansible\-collections/community\.docker/pull/76)\)\. + + +## 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)\)\. + + +### Bugfixes + +* docker\_container \- allow IPv6 zones \(RFC 4007\) in bind IPs \([https\://github\.com/ansible\-collections/community\.docker/pull/66](https\://github\.com/ansible\-collections/community\.docker/pull/66)\)\. +* docker\_image \- fix crash on loading images with versions of Docker SDK for Python before 2\.5\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/72](https\://github\.com/ansible\-collections/community\.docker/issues/72)\, [https\://github\.com/ansible\-collections/community\.docker/pull/73](https\://github\.com/ansible\-collections/community\.docker/pull/73)\)\. + + +## 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)\)\. + + +### Bugfixes + +* docker\_image \- if push\=true is used with repository\, and the image does not need to be tagged\, still push\. This can happen if repository and name are equal \([https\://github\.com/ansible\-collections/community\.docker/issues/52](https\://github\.com/ansible\-collections/community\.docker/issues/52)\, [https\://github\.com/ansible\-collections/community\.docker/pull/53](https\://github\.com/ansible\-collections/community\.docker/pull/53)\)\. +* docker\_image \- report error when loading a broken archive that contains no image \([https\://github\.com/ansible\-collections/community\.docker/issues/46](https\://github\.com/ansible\-collections/community\.docker/issues/46)\, [https\://github\.com/ansible\-collections/community\.docker/pull/55](https\://github\.com/ansible\-collections/community\.docker/pull/55)\)\. +* docker\_image \- report error when the loaded archive does not contain the specified image \([https\://github\.com/ansible\-collections/community\.docker/issues/41](https\://github\.com/ansible\-collections/community\.docker/issues/41)\, [https\://github\.com/ansible\-collections/community\.docker/pull/55](https\://github\.com/ansible\-collections/community\.docker/pull/55)\)\. + + +### New Plugins + + +#### Connection + +* docker\_api \- Run tasks in docker containers + + +#### Inventory + +* docker\_containers \- Ansible dynamic inventory plugin for Docker containers\. + + +### New Modules + +* current\_container\_facts \- Return facts about whether the module runs in a Docker container + + +## v1\.0\.1 + + +### Release Summary + +Maintenance release with a bugfix for docker\_container\. + + +### Bugfixes + +* docker\_container \- the validation for capabilities in device\_requests was incorrect \([https\://github\.com/ansible\-collections/community\.docker/issues/42](https\://github\.com/ansible\-collections/community\.docker/issues/42)\, [https\://github\.com/ansible\-collections/community\.docker/pull/43](https\://github\.com/ansible\-collections/community\.docker/pull/43)\)\. + + +## 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)\)\. +* docker\_image \- return docker build output \([https\://github\.com/ansible\-collections/community\.general/pull/805](https\://github\.com/ansible\-collections/community\.general/pull/805)\)\. +* docker\_secret \- add a warning when the secret does not have an ansible\_key label but the force parameter is not set \([https\://github\.com/ansible\-collections/community\.docker/issues/30](https\://github\.com/ansible\-collections/community\.docker/issues/30)\, [https\://github\.com/ansible\-collections/community\.docker/pull/31](https\://github\.com/ansible\-collections/community\.docker/pull/31)\)\. + + +## 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)\)\. +* docker\_container \- the default of networks\_cli\_compatible changed to true \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_container \- the unused option trust\_image\_content has been removed \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image \- state\=build has been removed\. Use present instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image \- the container\_limits\, dockerfile\, http\_timeout\, nocache\, rm\, path\, buildargs\, pull have been removed\. Use the corresponding suboptions of build instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image \- the force option has been removed\. Use the more specific force\_\* options instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image \- the source option is now mandatory \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image \- the use\_tls option has been removed\. Use tls and validate\_certs instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image \- the default of the build\.pull option changed to false \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_image\_facts \- this alias is on longer availabe\, use docker\_image\_info instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_network \- no longer returns ansible\_facts \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_network \- the ipam\_options option has been removed\. Use ipam\_config instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_service \- no longer returns ansible\_facts \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm \- state\=inspect has been removed\. Use docker\_swarm\_info instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm\_service \- the constraints option has been removed\. Use placement\.constraints instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm\_service \- the limit\_cpu and limit\_memory options has been removed\. Use the corresponding suboptions in limits instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm\_service \- the log\_driver and log\_driver\_options options has been removed\. Use the corresponding suboptions in logging instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm\_service \- the reserve\_cpu and reserve\_memory options has been removed\. Use the corresponding suboptions in reservations instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm\_service \- the restart\_policy\, restart\_policy\_attempts\, restart\_policy\_delay and restart\_policy\_window options has been removed\. Use the corresponding suboptions in restart\_config instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_swarm\_service \- the update\_delay\, update\_parallelism\, update\_failure\_action\, update\_monitor\, update\_max\_failure\_ratio and update\_order options has been removed\. Use the corresponding suboptions in update\_config instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_volume \- no longer returns ansible\_facts \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. +* docker\_volume \- the force option has been removed\. Use recreate instead \([https\://github\.com/ansible\-collections/community\.docker/pull/1](https\://github\.com/ansible\-collections/community\.docker/pull/1)\)\. + + +### Bugfixes + +* docker\_login \- fix internal config file storage to handle credentials for more than one registry \([https\://github\.com/ansible\-collections/community\.general/issues/1117](https\://github\.com/ansible\-collections/community\.general/issues/1117)\)\. diff --git a/CHANGELOG.md.license b/CHANGELOG.md.license new file mode 100644 index 000000000..edff8c768 --- /dev/null +++ b/CHANGELOG.md.license @@ -0,0 +1,3 @@ +GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +SPDX-License-Identifier: GPL-3.0-or-later +SPDX-FileCopyrightText: Ansible Project diff --git a/CHANGELOG.rst b/CHANGELOG.rst index bb565a353..55b82e261 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,7 +4,6 @@ Docker Community Collection Release Notes .. contents:: Topics - v2.7.8 ====== @@ -688,7 +687,6 @@ Release Summary This is the first production (non-prerelease) release of ``community.docker``. - Minor Changes ------------- @@ -706,7 +704,6 @@ The ``community.docker`` continues the work on the Ansible docker modules and pl 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 ------------- diff --git a/README.md b/README.md index 48c1a45f2..fa4914b2e 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ You can find more information in the [developer guide for collections](https://d ## Release notes -See the [changelog](https://github.com/ansible-collections/community.docker/tree/stable-2/CHANGELOG.rst). +See the [changelog](https://github.com/ansible-collections/community.docker/tree/stable-2/CHANGELOG.md). ## More information diff --git a/changelogs/config.yaml b/changelogs/config.yaml index 120c7a5bb..25f1997e1 100644 --- a/changelogs/config.yaml +++ b/changelogs/config.yaml @@ -6,6 +6,9 @@ keep_fragments: false mention_ancestor: true new_plugins_after_name: removed_features notesdir: fragments +output_formats: + - md + - rst prelude_section_name: release_summary prelude_section_title: Release Summary sections: