diff --git a/CHANGELOG.md b/CHANGELOG.md
index da43b356c..580b3c414 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,167 +2,170 @@
**Topics**
+- v3\.11\.0
+ - Minor Changes
+ - Bugfixes
- v3\.10\.4
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.10\.3
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.10\.2
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.10\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- Known Issues
- v3\.10\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- v3\.9\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- v3\.8\.1
- Release Summary
- Security Fixes
- - Bugfixes
+ - 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
- Major Changes
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- New Modules
- v3\.5\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- - Bugfixes
+ - Bugfixes
- v3\.4\.11
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.10
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.9
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.8
- Release Summary
- Known Issues
- v3\.4\.7
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.6
- Release Summary
- - Bugfixes
+ - Bugfixes
- Known Issues
- v3\.4\.5
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.4
- Release Summary
- - Minor Changes
+ - Minor Changes
- Known Issues
- v3\.4\.3
- Release Summary
- v3\.4\.2
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.4\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- New Modules
- v3\.3\.2
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.3\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.3\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- v3\.2\.2
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.2\.1
- Release Summary
- v3\.2\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- v3\.1\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- v3\.0\.2
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.0\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v3\.0\.0
- Release Summary
- Major Changes
- - Minor Changes
+ - Minor Changes
- Breaking Changes / Porting Guide
- Removed Features \(previously deprecated\)
- Security Fixes
- - Bugfixes
+ - Bugfixes
- v2\.7\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- - Bugfixes
+ - Bugfixes
- v2\.6\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- - Bugfixes
+ - Bugfixes
- v2\.5\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v2\.5\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- v2\.4\.0
- Release Summary
- - Minor Changes
- - Bugfixes
-- v2\.3\.0
- - Release Summary
- Minor Changes
- Bugfixes
+- v2\.3\.0
+ - Release Summary
+ - Minor Changes
+ - Bugfixes
- v2\.2\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v2\.2\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- v2\.1\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v2\.1\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- v2\.0\.2
- Release Summary
- - Bugfixes
+ - Bugfixes
- v2\.0\.1
- Release Summary
- v2\.0\.0
@@ -172,78 +175,95 @@
- Removed Features \(previously deprecated\)
- v1\.10\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- v1\.9\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v1\.9\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- - Bugfixes
+ - Bugfixes
- New Plugins
- Connection
- v1\.8\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- v1\.7\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- v1\.6\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v1\.6\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- - Bugfixes
+ - Bugfixes
- v1\.5\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- New Modules
- v1\.4\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Breaking Changes / Porting Guide
- Security Fixes
- - Bugfixes
+ - Bugfixes
- v1\.3\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- New Modules
- v1\.2\.2
- Release Summary
- Security Fixes
- v1\.2\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v1\.2\.0
- Release Summary
- - Minor Changes
- - Bugfixes
+ - Minor Changes
+ - Bugfixes
- v1\.1\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Deprecated Features
- - Bugfixes
+ - Bugfixes
- New Plugins
- Connection
- Inventory
- New Modules
- v1\.0\.1
- Release Summary
- - Bugfixes
+ - Bugfixes
- v1\.0\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- v0\.1\.0
- Release Summary
- - Minor Changes
+ - Minor Changes
- Removed Features \(previously deprecated\)
- - Bugfixes
+ - Bugfixes
+
+
+## v3\.11\.0
+
+
+### Minor Changes
+
+* docker\_container \- add support for device\_cgroup\_rules \([https\://github\.com/ansible\-collections/community\.docker/pull/910](https\://github\.com/ansible\-collections/community\.docker/pull/910)\)\.
+* docker\_container \- the new state\=healthy allows to wait for a container to become healthy on startup\. The healthy\_wait\_timeout option allows to configure the maximum time to wait for this to happen \([https\://github\.com/ansible\-collections/community\.docker/issues/890](https\://github\.com/ansible\-collections/community\.docker/issues/890)\, [https\://github\.com/ansible\-collections/community\.docker/pull/921](https\://github\.com/ansible\-collections/community\.docker/pull/921)\)\.
+
+
+### Bugfixes
+
+* docker\_compose\_v2\* modules \- fix parsing of skipped pull messages for Docker Compose 2\.28\.x \([https\://github\.com/ansible\-collections/community\.docker/issues/911](https\://github\.com/ansible\-collections/community\.docker/issues/911)\, [https\://github\.com/ansible\-collections/community\.docker/pull/916](https\://github\.com/ansible\-collections/community\.docker/pull/916)\)\.
+* docker\_compose\_v2\*\, docker\_stack\*\, docker\_image\_build modules \- using cli\_context no longer leads to an invalid parameter combination being passed to the corresponding Docker CLI tool\, unless docker\_host is also provided\. Combining cli\_context and docker\_host is no longer allowed \([https\://github\.com/ansible\-collections/community\.docker/issues/892](https\://github\.com/ansible\-collections/community\.docker/issues/892)\, [https\://github\.com/ansible\-collections/community\.docker/pull/895](https\://github\.com/ansible\-collections/community\.docker/pull/895)\)\.
+* docker\_container \- fix possible infinite loop if removal\_wait\_timeout is set \([https\://github\.com/ansible\-collections/community\.docker/pull/922](https\://github\.com/ansible\-collections/community\.docker/pull/922)\)\.
+* vendored Docker SDK for Python \- use LooseVersion instead of StrictVersion to compare urllib3 versions\. This is needed for development versions \([https\://github\.com/ansible\-collections/community\.docker/pull/902](https\://github\.com/ansible\-collections/community\.docker/pull/902)\)\.
## v3\.10\.4
@@ -253,7 +273,7 @@
Bugfix release\.
-
+
### Bugfixes
* docker\_compose \- make sure that the module uses the api\_version parameter \([https\://github\.com/ansible\-collections/community\.docker/pull/881](https\://github\.com/ansible\-collections/community\.docker/pull/881)\)\.
@@ -267,7 +287,7 @@ Bugfix release\.
Bugfix release\.
-
+
### Bugfixes
* docker and nsenter connection plugins\, docker\_container\_exec module \- avoid using the deprecated ansible\.module\_utils\.compat\.selectors module util with Python 3 \([https\://github\.com/ansible\-collections/community\.docker/issues/870](https\://github\.com/ansible\-collections/community\.docker/issues/870)\, [https\://github\.com/ansible\-collections/community\.docker/pull/871](https\://github\.com/ansible\-collections/community\.docker/pull/871)\)\.
@@ -280,7 +300,7 @@ Bugfix release\.
Bugfix release\.
-
+
### Bugfixes
* vendored Docker SDK for Python \- include a fix requests 2\.32\.2\+ compatibility \([https\://github\.com/ansible\-collections/community\.docker/issues/860](https\://github\.com/ansible\-collections/community\.docker/issues/860)\, [https\://github\.com/psf/requests/issues/6707](https\://github\.com/psf/requests/issues/6707)\, [https\://github\.com/ansible\-collections/community\.docker/pull/864](https\://github\.com/ansible\-collections/community\.docker/pull/864)\)\.
@@ -293,7 +313,7 @@ Bugfix release\.
Hotfix release for requests 2\.32\.0 compatibility\.
-
+
### Bugfixes
* vendored Docker SDK for Python \- include a hotfix for requests 2\.32\.0 compatibility \([https\://github\.com/ansible\-collections/community\.docker/issues/860](https\://github\.com/ansible\-collections/community\.docker/issues/860)\, [https\://github\.com/docker/docker\-py/issues/3256](https\://github\.com/docker/docker\-py/issues/3256)\, [https\://github\.com/ansible\-collections/community\.docker/pull/861](https\://github\.com/ansible\-collections/community\.docker/pull/861)\)\.
@@ -317,7 +337,7 @@ Hotfix release for requests 2\.32\.0 compatibility\.
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)\)\.
@@ -343,7 +363,7 @@ Feature release\.
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)\)\.
@@ -351,7 +371,7 @@ Bugfix and feature release\.
* 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)\)\.
* vendored Docker SDK for Python \- remove unused code that relies on functionality deprecated in Python 3\.12 \([https\://github\.com/ansible\-collections/community\.docker/pull/834](https\://github\.com/ansible\-collections/community\.docker/pull/834)\)\.
-
+
### Bugfixes
* docker\_compose\_v2\* \- allow project\_src to be a relative path\, by converting it to an absolute path before using it \([https\://github\.com/ansible\-collections/community\.docker/issues/827](https\://github\.com/ansible\-collections/community\.docker/issues/827)\, [https\://github\.com/ansible\-collections/community\.docker/pull/828](https\://github\.com/ansible\-collections/community\.docker/pull/828)\)\.
@@ -371,7 +391,7 @@ Bugfix release
* docker\_containers\, docker\_machine\, and docker\_swarm inventory plugins \- make sure all data received from the Docker daemon / Docker machine is marked as unsafe\, so remote code execution by obtaining texts that can be evaluated as templates is not possible \([https\://www\.die\-welt\.net/2024/03/remote\-code\-execution\-in\-ansible\-dynamic\-inventory\-plugins/](https\://www\.die\-welt\.net/2024/03/remote\-code\-execution\-in\-ansible\-dynamic\-inventory\-plugins/)\, [https\://github\.com/ansible\-collections/community\.docker/pull/815](https\://github\.com/ansible\-collections/community\.docker/pull/815)\)\.
-
+
### Bugfixes
* docker\_compose\_v2 \- do not fail when non\-fatal errors occur\. This can happen when pulling an image fails\, but then the image can be built for another service\. Docker Compose emits an error in that case\, but docker compose up still completes successfully \([https\://github\.com/ansible\-collections/community\.docker/issues/807](https\://github\.com/ansible\-collections/community\.docker/issues/807)\, [https\://github\.com/ansible\-collections/community\.docker/pull/810](https\://github\.com/ansible\-collections/community\.docker/pull/810)\, [https\://github\.com/ansible\-collections/community\.docker/pull/811](https\://github\.com/ansible\-collections/community\.docker/pull/811)\)\.
@@ -387,14 +407,14 @@ Bugfix release
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)\)\.
* docker\_container \- the pull\_check\_mode\_behavior option now allows to control the module\'s behavior in check mode when pull\=always \([https\://github\.com/ansible\-collections/community\.docker/issues/792](https\://github\.com/ansible\-collections/community\.docker/issues/792)\, [https\://github\.com/ansible\-collections/community\.docker/pull/797](https\://github\.com/ansible\-collections/community\.docker/pull/797)\)\.
* docker\_container \- the pull option now accepts the three values never\, missing\_image \(default\)\, and never\, next to the previously valid values true \(equivalent to always\) and false \(equivalent to missing\_image\)\. This allows the equivalent to \-\-pull\=never from the Docker command line \([https\://github\.com/ansible\-collections/community\.docker/issues/783](https\://github\.com/ansible\-collections/community\.docker/issues/783)\, [https\://github\.com/ansible\-collections/community\.docker/pull/797](https\://github\.com/ansible\-collections/community\.docker/pull/797)\)\.
-
+
### Bugfixes
* docker\_compose\_v2 \- do not consider a Waiting event as an action/change \([https\://github\.com/ansible\-collections/community\.docker/pull/804](https\://github\.com/ansible\-collections/community\.docker/pull/804)\)\.
@@ -409,13 +429,13 @@ Bugfix and feature release\.
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)\)\.
* docker\_compose\_v2\, docker\_compose\_v2\_pull \- support files parameter to specify multiple Compose files \([https\://github\.com/ansible\-collections/community\.docker/issues/772](https\://github\.com/ansible\-collections/community\.docker/issues/772)\, [https\://github\.com/ansible\-collections/community\.docker/pull/775](https\://github\.com/ansible\-collections/community\.docker/pull/775)\)\.
-
+
### Bugfixes
* docker\_compose\_v2 \- properly parse dry\-run build events from stderr \([https\://github\.com/ansible\-collections/community\.docker/issues/778](https\://github\.com/ansible\-collections/community\.docker/issues/778)\, [https\://github\.com/ansible\-collections/community\.docker/pull/779](https\://github\.com/ansible\-collections/community\.docker/pull/779)\)\.
@@ -449,7 +469,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)\)\.
@@ -459,7 +479,7 @@ so the main difference is that instead of some Python requirements\, they depend
* docker\_image \- allow to specify memory size and swap memory size in other units than bytes \([https\://github\.com/ansible\-collections/community\.docker/pull/727](https\://github\.com/ansible\-collections/community\.docker/pull/727)\)\.
* inventory plugins \- add filter option which allows to include and exclude hosts based on Jinja2 conditions \([https\://github\.com/ansible\-collections/community\.docker/pull/698](https\://github\.com/ansible\-collections/community\.docker/pull/698)\, [https\://github\.com/ansible\-collections/community\.docker/issues/610](https\://github\.com/ansible\-collections/community\.docker/issues/610)\)\.
-
+
### Bugfixes
* Use unix\:///var/run/docker\.sock instead of the legacy unix\://var/run/docker\.sock as default for docker\_host \([https\://github\.com/ansible\-collections/community\.docker/pull/736](https\://github\.com/ansible\-collections/community\.docker/pull/736)\)\.
@@ -484,7 +504,7 @@ so the main difference is that instead of some Python requirements\, they depend
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)\)\.
@@ -495,7 +515,7 @@ Bugfix and feature release\.
* 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)\)\.
-
+
### Bugfixes
* 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)\)\.
@@ -510,7 +530,7 @@ Bugfix and feature release\.
Bugfix release\.
-
+
### Bugfixes
* 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)\)\.
@@ -523,7 +543,7 @@ Bugfix release\.
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)\)\.
@@ -536,7 +556,7 @@ Bugfix release\.
Maintenance release with updated documentation and vendored Docker SDK for Python code\.
-
+
### Bugfixes
* vendored Docker SDK for Python code \- cherry\-pick changes from the Docker SDK for Python code to align code\. These changes should not affect the parts used by the collection\'s code \([https\://github\.com/ansible\-collections/community\.docker/pull/694](https\://github\.com/ansible\-collections/community\.docker/pull/694)\)\.
@@ -570,7 +590,7 @@ for the rendered HTML version of the documentation of the latest release\.
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)\)\.
@@ -583,7 +603,7 @@ Bugfix release\.
Bugfix release with documentation warnings about using certain functionality when connecting to the Docker daemon with TCP TLS\.
-
+
### Bugfixes
* socket\_handler module utils \- make sure this fully works when Docker SDK for Python is not available \([https\://github\.com/ansible\-collections/community\.docker/pull/620](https\://github\.com/ansible\-collections/community\.docker/pull/620)\)\.
@@ -605,7 +625,7 @@ Bugfix release with documentation warnings about using certain functionality whe
Maintenance release which adds compatibility with requests 2\.29\.0 and 2\.30\.0 and urllib3 2\.0\.
-
+
### Bugfixes
* Make vendored Docker SDK for Python code compatible with requests 2\.29\.0 and urllib3 2\.0 \([https\://github\.com/ansible\-collections/community\.docker/pull/613](https\://github\.com/ansible\-collections/community\.docker/pull/613)\)\.
@@ -618,7 +638,7 @@ Maintenance release which adds compatibility with requests 2\.29\.0 and 2\.30\.0
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)\)\.
@@ -644,7 +664,7 @@ Maintenance release with improved documentation\.
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)\)\.
@@ -657,7 +677,7 @@ Bugfix release\.
Regular bugfix release\.
-
+
### Bugfixes
* docker\_api connection plugin\, docker\_container\_exec\, docker\_container\_copy\_into \- properly close socket to Daemon after executing commands in containers \([https\://github\.com/ansible\-collections/community\.docker/pull/582](https\://github\.com/ansible\-collections/community\.docker/pull/582)\)\.
@@ -672,13 +692,13 @@ Regular bugfix release\.
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)\)\.
* docker\_host\_info \- allow to list all containers with new option containers\_all \([https\://github\.com/ansible\-collections/community\.docker/issues/535](https\://github\.com/ansible\-collections/community\.docker/issues/535)\, [https\://github\.com/ansible\-collections/community\.docker/pull/538](https\://github\.com/ansible\-collections/community\.docker/pull/538)\)\.
-
+
### 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)\)\.
@@ -699,7 +719,7 @@ Regular bugfix and feature release\.
Bugfix release\.
-
+
### Bugfixes
* docker\_container \- when detach\=false\, wait indefinitely and not at most one minute\. This was the behavior with Docker SDK for Python\, and was accidentally changed in 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/526](https\://github\.com/ansible\-collections/community\.docker/issues/526)\, [https\://github\.com/ansible\-collections/community\.docker/pull/527](https\://github\.com/ansible\-collections/community\.docker/pull/527)\)\.
@@ -712,7 +732,7 @@ Bugfix release\.
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)\)\.
@@ -725,13 +745,13 @@ Bugfix release\.
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)\)\.
* docker\_image \- when using archive\_path\, detect whether changes are necessary based on the image ID \(hash\)\. If the existing tar archive matches the source\, do nothing\. Previously\, each task execution re\-created the archive \([https\://github\.com/ansible\-collections/community\.docker/pull/500](https\://github\.com/ansible\-collections/community\.docker/pull/500)\)\.
-
+
### Bugfixes
* docker\_container\_exec \- fix chdir option which was ignored since community\.docker 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/517](https\://github\.com/ansible\-collections/community\.docker/issues/517)\, [https\://github\.com/ansible\-collections/community\.docker/pull/518](https\://github\.com/ansible\-collections/community\.docker/pull/518)\)\.
@@ -745,7 +765,7 @@ Feature and bugfix release\.
Bugfix release\.
-
+
### Bugfixes
* docker\_container \- the kill\_signal option erroneously did not accept strings anymore since 3\.0\.0 \([https\://github\.com/ansible\-collections/community\.docker/issues/505](https\://github\.com/ansible\-collections/community\.docker/issues/505)\, [https\://github\.com/ansible\-collections/community\.docker/pull/506](https\://github\.com/ansible\-collections/community\.docker/pull/506)\)\.
@@ -766,7 +786,7 @@ Maintenance release with improved documentation\.
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)\)\.
@@ -785,7 +805,7 @@ Feature and deprecation release\.
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)\)\.
@@ -799,7 +819,7 @@ Feature release\.
Bugfix release\.
-
+
### Bugfixes
* docker\_image \- fix build argument handling \([https\://github\.com/ansible\-collections/community\.docker/issues/455](https\://github\.com/ansible\-collections/community\.docker/issues/455)\, [https\://github\.com/ansible\-collections/community\.docker/pull/456](https\://github\.com/ansible\-collections/community\.docker/pull/456)\)\.
@@ -812,7 +832,7 @@ Bugfix release\.
Bugfix release\.
-
+
### Bugfixes
* docker\_container \- fix handling of env\_file \([https\://github\.com/ansible\-collections/community\.docker/issues/451](https\://github\.com/ansible\-collections/community\.docker/issues/451)\, [https\://github\.com/ansible\-collections/community\.docker/pull/452](https\://github\.com/ansible\-collections/community\.docker/pull/452)\)\.
@@ -847,7 +867,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)\)\.
@@ -887,7 +907,7 @@ The 3\.0\.0 release features a rewrite of the docker\_container mod
* modules and plugins communicating directly with the Docker daemon \- when connecting by SSH and not using use\_ssh\_client\=true\, reject unknown host keys instead of accepting them\. This is only a change relative to older community\.docker 3\.0\.0 pre\-releases or with respect to Docker SDK for Python \< 6\.0\.0\. Docker SDK for Python 6\.0\.0 will also include this change \([https\://github\.com/ansible\-collections/community\.docker/pull/434](https\://github\.com/ansible\-collections/community\.docker/pull/434)\)\.
-
+
### Bugfixes
* docker\_image \- when composing the build context\, trim trailing whitespace from \.dockerignore entries\. This is only a change relative to older community\.docker 3\.0\.0 pre\-releases or with respect to Docker SDK for Python \< 6\.0\.0\. Docker SDK for Python 6\.0\.0 will also include this change \([https\://github\.com/ansible\-collections/community\.docker/pull/434](https\://github\.com/ansible\-collections/community\.docker/pull/434)\)\.
@@ -906,7 +926,7 @@ The 3\.0\.0 release features a rewrite of the docker\_container mod
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)\)\.
@@ -917,7 +937,7 @@ Bugfix and deprecation release\. The next 2\.x\.y releases will only be bugfix r
* 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)\)\.
@@ -930,7 +950,7 @@ Bugfix and deprecation release\. The next 2\.x\.y releases will only be bugfix r
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)\)\.
@@ -943,7 +963,7 @@ Bugfix and feature release\.
* 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)\)\.
@@ -957,7 +977,7 @@ Bugfix and feature release\.
Maintenance release\.
-
+
### Bugfixes
* Include PSF\-license\.txt file for plugins/module\_utils/\_version\.py\.
@@ -970,7 +990,7 @@ Maintenance release\.
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)\)\.
@@ -984,14 +1004,14 @@ Regular feature release\.
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)\)\.
@@ -1004,7 +1024,7 @@ Regular feature and bugfix release\.
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)\)\.
@@ -1013,7 +1033,7 @@ Regular feature and bugfix release\.
* 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)\)\.
@@ -1027,7 +1047,7 @@ Regular feature and bugfix release\.
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)\)\.
@@ -1040,14 +1060,14 @@ Regular bugfix release\.
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 peculiarities 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)\)\.
@@ -1060,7 +1080,7 @@ Regular feature and bugfix release\.
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)\)\.
@@ -1073,13 +1093,13 @@ Emergency release to amend breaking change in previous release\.
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)\)\.
@@ -1094,7 +1114,7 @@ Feature and bugfix release\.
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)\)\.
@@ -1144,7 +1164,7 @@ New major release with some deprecations removed and a breaking change in the
+
### 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)\)\.
@@ -1159,7 +1179,7 @@ Regular feature and bugfix release\.
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)\)\.
@@ -1172,7 +1192,7 @@ Regular bugfix release\.
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)\)\.
@@ -1186,7 +1206,7 @@ New bugfixes and features release\.
* 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)\)\.
@@ -1210,7 +1230,7 @@ New bugfixes and features release\.
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)\)\.
@@ -1219,7 +1239,7 @@ Regular bugfix and feature release\.
* 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)\)\.
@@ -1232,7 +1252,7 @@ Regular bugfix and feature release\.
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)\)\.
@@ -1245,7 +1265,7 @@ Small feature and bugfix release\.
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)\)\.
@@ -1258,7 +1278,7 @@ Bugfix release to reduce deprecation warning spam\.
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)\)\.
@@ -1269,7 +1289,7 @@ Regular bugfix and feature release\.
* 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)\)\.
@@ -1284,12 +1304,12 @@ Regular bugfix and feature release\.
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)\)\.
@@ -1307,7 +1327,7 @@ Regular feature release\.
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)\)\.
@@ -1322,7 +1342,7 @@ Security release to address another potential secret leak\. Also includes regula
* 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)\)\.
@@ -1336,7 +1356,7 @@ Security release to address another potential secret leak\. Also includes regula
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)\)\.
@@ -1344,7 +1364,7 @@ Regular feature and bugfix release\.
* 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)\)\.
@@ -1380,7 +1400,7 @@ Security bugfix release to address CVE\-2021\-20191\.
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)\)\.
@@ -1393,12 +1413,12 @@ Bugfix release\.
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)\)\.
@@ -1412,7 +1432,7 @@ Feature release with one new feature and two bugfixes\.
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)\)\.
@@ -1424,7 +1444,7 @@ Feature release with three new plugins and modules\.
* 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)\)\.
@@ -1457,7 +1477,7 @@ Feature release with three new plugins and modules\.
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)\)\.
@@ -1470,7 +1490,7 @@ Maintenance release with a bugfix for docker\_container\.
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)\)\.
@@ -1487,7 +1507,7 @@ The community\.docker continues the work on the Ansible docker modu
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)\)\.
@@ -1518,7 +1538,7 @@ All deprecation removals planned for community\.general 2\.0\.0 hav
* 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.rst b/CHANGELOG.rst
index 7543fd867..f7d2f4c42 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -4,6 +4,23 @@ Docker Community Collection Release Notes
.. contents:: Topics
+v3.11.0
+=======
+
+Minor Changes
+-------------
+
+- docker_container - add support for ``device_cgroup_rules`` (https://github.com/ansible-collections/community.docker/pull/910).
+- docker_container - the new ``state=healthy`` allows to wait for a container to become healthy on startup. The ``healthy_wait_timeout`` option allows to configure the maximum time to wait for this to happen (https://github.com/ansible-collections/community.docker/issues/890, https://github.com/ansible-collections/community.docker/pull/921).
+
+Bugfixes
+--------
+
+- docker_compose_v2* modules - fix parsing of skipped pull messages for Docker Compose 2.28.x (https://github.com/ansible-collections/community.docker/issues/911, https://github.com/ansible-collections/community.docker/pull/916).
+- docker_compose_v2*, docker_stack*, docker_image_build modules - using ``cli_context`` no longer leads to an invalid parameter combination being passed to the corresponding Docker CLI tool, unless ``docker_host`` is also provided. Combining ``cli_context`` and ``docker_host`` is no longer allowed (https://github.com/ansible-collections/community.docker/issues/892, https://github.com/ansible-collections/community.docker/pull/895).
+- docker_container - fix possible infinite loop if ``removal_wait_timeout`` is set (https://github.com/ansible-collections/community.docker/pull/922).
+- vendored Docker SDK for Python - use ``LooseVersion`` instead of ``StrictVersion`` to compare urllib3 versions. This is needed for development versions (https://github.com/ansible-collections/community.docker/pull/902).
+
v3.10.4
=======
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
index 85a0b07a4..317e61186 100644
--- a/changelogs/changelog.yaml
+++ b/changelogs/changelog.yaml
@@ -1112,6 +1112,35 @@ releases:
- 881-docker-compose-v1-api-version.yml
- 886-compose-v2-req.yml
release_date: '2024-06-16'
+ 3.11.0:
+ changes:
+ bugfixes:
+ - docker_compose_v2* modules - fix parsing of skipped pull messages for Docker
+ Compose 2.28.x (https://github.com/ansible-collections/community.docker/issues/911,
+ https://github.com/ansible-collections/community.docker/pull/916).
+ - docker_compose_v2*, docker_stack*, docker_image_build modules - using ``cli_context``
+ no longer leads to an invalid parameter combination being passed to the corresponding
+ Docker CLI tool, unless ``docker_host`` is also provided. Combining ``cli_context``
+ and ``docker_host`` is no longer allowed (https://github.com/ansible-collections/community.docker/issues/892,
+ https://github.com/ansible-collections/community.docker/pull/895).
+ - docker_container - fix possible infinite loop if ``removal_wait_timeout``
+ is set (https://github.com/ansible-collections/community.docker/pull/922).
+ - vendored Docker SDK for Python - use ``LooseVersion`` instead of ``StrictVersion``
+ to compare urllib3 versions. This is needed for development versions (https://github.com/ansible-collections/community.docker/pull/902).
+ minor_changes:
+ - docker_container - add support for ``device_cgroup_rules`` (https://github.com/ansible-collections/community.docker/pull/910).
+ - docker_container - the new ``state=healthy`` allows to wait for a container
+ to become healthy on startup. The ``healthy_wait_timeout`` option allows to
+ configure the maximum time to wait for this to happen (https://github.com/ansible-collections/community.docker/issues/890,
+ https://github.com/ansible-collections/community.docker/pull/921).
+ fragments:
+ - 895-docker-cli.yml
+ - 902-loose-version.yml
+ - 910-docker_container-device_cgroup_rules.yml
+ - 916-compose-v2-parse.yml
+ - 921-docker_container-healthy.yml
+ - 922-docker_container-wait-fix.yml
+ release_date: '2024-07-09'
3.2.0:
changes:
deprecated_features:
diff --git a/changelogs/fragments/895-docker-cli.yml b/changelogs/fragments/895-docker-cli.yml
deleted file mode 100644
index 8e225bca4..000000000
--- a/changelogs/fragments/895-docker-cli.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-bugfixes:
- - "docker_compose_v2*, docker_stack*, docker_image_build modules - using ``cli_context`` no longer leads to an invalid parameter combination being passed to the corresponding Docker CLI tool, unless ``docker_host`` is also provided. Combining ``cli_context`` and ``docker_host`` is no longer allowed (https://github.com/ansible-collections/community.docker/issues/892, https://github.com/ansible-collections/community.docker/pull/895)."
diff --git a/changelogs/fragments/902-loose-version.yml b/changelogs/fragments/902-loose-version.yml
deleted file mode 100644
index 198b16233..000000000
--- a/changelogs/fragments/902-loose-version.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-bugfixes:
- - "vendored Docker SDK for Python - use ``LooseVersion`` instead of ``StrictVersion`` to compare urllib3 versions. This is needed for development versions (https://github.com/ansible-collections/community.docker/pull/902)."
diff --git a/changelogs/fragments/910-docker_container-device_cgroup_rules.yml b/changelogs/fragments/910-docker_container-device_cgroup_rules.yml
deleted file mode 100644
index 4234d33af..000000000
--- a/changelogs/fragments/910-docker_container-device_cgroup_rules.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-minor_changes:
- - "docker_container - add support for ``device_cgroup_rules`` (https://github.com/ansible-collections/community.docker/pull/910)."
diff --git a/changelogs/fragments/916-compose-v2-parse.yml b/changelogs/fragments/916-compose-v2-parse.yml
deleted file mode 100644
index eecc7fd1b..000000000
--- a/changelogs/fragments/916-compose-v2-parse.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-bugfixes:
- - "docker_compose_v2* modules - fix parsing of skipped pull messages for Docker Compose 2.28.x (https://github.com/ansible-collections/community.docker/issues/911, https://github.com/ansible-collections/community.docker/pull/916)."
diff --git a/changelogs/fragments/921-docker_container-healthy.yml b/changelogs/fragments/921-docker_container-healthy.yml
deleted file mode 100644
index 007148d26..000000000
--- a/changelogs/fragments/921-docker_container-healthy.yml
+++ /dev/null
@@ -1,4 +0,0 @@
-minor_changes:
- - "docker_container - the new ``state=healthy`` allows to wait for a container to become healthy on startup.
- The ``healthy_wait_timeout`` option allows to configure the maximum time to wait for this to happen
- (https://github.com/ansible-collections/community.docker/issues/890, https://github.com/ansible-collections/community.docker/pull/921)."
diff --git a/changelogs/fragments/922-docker_container-wait-fix.yml b/changelogs/fragments/922-docker_container-wait-fix.yml
deleted file mode 100644
index 5cbaac332..000000000
--- a/changelogs/fragments/922-docker_container-wait-fix.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-bugfixes:
- - "docker_container - fix possible infinite loop if ``removal_wait_timeout`` is set (https://github.com/ansible-collections/community.docker/pull/922)."