Community.Docker Release Notes
+Community.Docker Release Notes
-v4.6.0
+v4.6.1
Release Summary
+Release Summary
+Bugfix release.
+Bugfixes
+-
+
docker_compose_v2 - handle a (potentially unintentional) breaking change in Docker Compose 2.37.0. Note that
ContainerNameis no longer part of the return value (https://github.com/ansible-collections/community.docker/issues/1082, https://github.com/ansible-collections/community.docker/pull/1083).
+docker_container - fix idempotency if
command=[]andcommand_handling=correct(https://github.com/ansible-collections/community.docker/issues/1080, https://github.com/ansible-collections/community.docker/pull/1085).
+
v4.6.0
+Release Summary
Feature release.
Minor Changes
+Minor Changes
docker_container_copy_into - add
mode_parseparameter which determines howmodeis parsed (https://github.com/ansible-collections/community.docker/pull/1074).
v4.5.2
-Release Summary
+v4.5.2
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_compose_v2 - fix version check for
assume_yes(https://github.com/ansible-collections/community.docker/pull/1054).docker_compose_v2 - use
--yesinstead of-yfrom Docker Compose 2.34.0 on (https://github.com/ansible-collections/community.docker/pull/1060).
@@ -1206,26 +1231,26 @@
v4.5.1
-Release Summary
+v4.5.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_compose_v2 - rename flag for
assume_yesparameter fordocker compose upto-y(https://github.com/ansible-collections/community.docker/pull/1054).
v4.5.0
-Release Summary
+v4.5.0
+Release Summary
Feature release.
Minor Changes
+Minor Changes
docker_compose_v2 - add
assume_yesparameter fordocker compose up(https://github.com/ansible-collections/community.docker/pull/1045).docker_network - add
enable_ipv4option (https://github.com/ansible-collections/community.docker/issues/1047, https://github.com/ansible-collections/community.docker/pull/1049).
@@ -1233,59 +1258,59 @@
v4.4.0
-Release Summary
+v4.4.0
+Release Summary
Feature and bugfix release.
Bugfixes
+Bugfixes
docker_compose_v2_run - the module has a conflict between the type of parameter it expects and the one it tries to sanitize. Fix removes the label sanitization step because they are already validated by the parameter definition (https://github.com/ansible-collections/community.docker/pull/1034).
vendored Docker SDK for Python - do not assume that
KeyErroris always forApiVersionwhen querying version fails (https://github.com/ansible-collections/community.docker/issues/1033, https://github.com/ansible-collections/community.docker/pull/1034).
New Modules
+New Modules
community.docker.docker_context_info - Retrieve information on Docker contexts for the current user.
v4.3.1
-Release Summary
+v4.3.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
Fix label sanitization code to avoid crashes in case of errors (https://github.com/ansible-collections/community.docker/issues/1028, https://github.com/ansible-collections/community.docker/pull/1029).
v4.3.0
-Release Summary
+v4.3.0
+Release Summary
Feature release.
Minor Changes
+Minor Changes
docker_compose_v2* modules - determine compose version with
docker compose versionand only then fall back todocker info(https://github.com/ansible-collections/community.docker/pull/1021).
v4.2.0
-Release Summary
+v4.2.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker_compose_v2 - add
ignore_build_eventsoption (default valuetrue) which allows to (not) ignore build events for change detection (https://github.com/ansible-collections/community.docker/issues/1005, https://github.com/ansible-collections/community.docker/issues/pull/1011).docker_image_build -
outputs[].namecan now be a list of strings (https://github.com/ansible-collections/community.docker/pull/1006).
@@ -1293,8 +1318,8 @@
docker_network - added
ingressoption (https://github.com/ansible-collections/community.docker/pull/999).
Bugfixes
+Bugfixes
docker_compose_v2 - when using Compose 2.31.0 or newer, revert to the old behavior that image rebuilds, for example if
rebuild=always, only result inchangedif a container has been restarted (https://github.com/ansible-collections/community.docker/issues/1005, https://github.com/ansible-collections/community.docker/issues/pull/1011).docker_image_build - work around bug resp. very unexpected behavior in Docker buildx that overwrites all image names in
--outputparameters if--tagis provided, which the module did by default in the past. The module now only supplies--tagifoutputsis empty. Ifoutputshas entries, it will add an additional entry withtype=imageif no entry oftype=imagecontains the image name specified by thenameandtagoptions (https://github.com/ansible-collections/community.docker/issues/1001, https://github.com/ansible-collections/community.docker/pull/1006).
@@ -1306,19 +1331,19 @@
v4.1.0
-Release Summary
+v4.1.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker_stack - allow to add
--detach=falseoption todocker stack deploycommand (https://github.com/ansible-collections/community.docker/pull/987).
Bugfixes
+Bugfixes
docker_compose_v2_exec, docker_compose_v2_run - fix missing
--envflag while assembling env arguments (https://github.com/ansible-collections/community.docker/pull/992).docker_host_info - ensure that the module always returns
can_talk_to_docker, and that it provides the correct value even ifapi_versionis specified (https://github.com/ansible-collections/community.docker/issues/993, https://github.com/ansible-collections/community.docker/pull/995).
@@ -1326,13 +1351,13 @@
v4.0.1
-Release Summary
+v4.0.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_compose_v2_run - make sure to sanitize
labelsbefore sending them to the Docker Daemon (https://github.com/ansible-collections/community.docker/pull/985).docker_config - make sure to sanitize
labelsbefore sending them to the Docker Daemon (https://github.com/ansible-collections/community.docker/pull/985).
@@ -1346,25 +1371,25 @@
v4.0.0
-Release Summary
+v4.0.0
+Release Summary
Major release with removed deprecated features.
Minor Changes
+Minor Changes
docker_compose_v2 - add
renew_anon_volumesparameter fordocker compose up(https://github.com/ansible-collections/community.docker/pull/977).
Breaking Changes / Porting Guide
+Breaking Changes / Porting Guide
docker_container - the default of
image_name_mismatchchanged fromignoretorecreate(https://github.com/ansible-collections/community.docker/pull/971).
Removed Features (previously deprecated)
+Removed Features (previously deprecated)
The collection no longer supports ansible-core 2.11, 2.12, 2.13, and 2.14. You need ansible-core 2.15.0 or newer to use community.docker 4.x.y (https://github.com/ansible-collections/community.docker/pull/971).
The docker_compose module has been removed. Please migrate to community.docker.docker_compose_v2 (https://github.com/ansible-collections/community.docker/pull/971).
@@ -1375,26 +1400,26 @@
v3.13.1
-Release Summary
+v3.13.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_compose_v2 - improve parsing of dry-run image build operations from JSON events (https://github.com/ansible-collections/community.docker/issues/975, https://github.com/ansible-collections/community.docker/pull/976).
v3.13.0
-Release Summary
+v3.13.0
+Release Summary
Feature release.
New Modules
+New Modules
community.docker.docker_compose_v2_exec - Run command in a container of a Compose service.
community.docker.docker_compose_v2_run - Run command in a new container of a Compose service.
@@ -1402,39 +1427,39 @@
v3.12.2
-Release Summary
+v3.12.2
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_prune - fix handling of lists for the filter options (https://github.com/ansible-collections/community.docker/issues/961, https://github.com/ansible-collections/community.docker/pull/966).
v3.12.1
-Release Summary
+v3.12.1
+Release Summary
Maintenance release with updated documentation and changelog.
Deprecated Features
+Deprecated Features
The collection deprecates support for all ansible-core versions that are currently End of Life, according to the ansible-core support matrix. This means that the next major release of the collection will no longer support ansible-core 2.11, ansible-core 2.12, ansible-core 2.13, and ansible-core 2.14.
v3.12.0
-Release Summary
+v3.12.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker, docker_api connection plugins - allow to determine the working directory when executing commands with the new
working_diroption (https://github.com/ansible-collections/community.docker/pull/943).docker, docker_api connection plugins - allow to execute commands with extended privileges with the new
privilegesoption (https://github.com/ansible-collections/community.docker/pull/943).
@@ -1444,8 +1469,8 @@
docker_container - when creating a container, directly pass all networks to connect to to the Docker Daemon for API version 1.44 and newer. This makes creation more efficient and works around a bug in Docker Daemon that does not use the specified MAC address in at least some cases, though only for creation (https://github.com/ansible-collections/community.docker/pull/933).
Bugfixes
+Bugfixes
docker_compose_v2 - handle yet another random unstructured error output from pre-2.29.0 Compose versions (https://github.com/ansible-collections/community.docker/issues/948, https://github.com/ansible-collections/community.docker/pull/949).
docker_compose_v2 - make sure that services provided in
servicesare appended to the command line after--and not before it (https://github.com/ansible-collections/community.docker/pull/942).
@@ -1456,23 +1481,23 @@
Known Issues
+Known Issues
docker_container - when specifying a MAC address for a container’s network, and the network is attached after container creation (for example, due to idempotency checks), the MAC address is at least in some cases ignored by the Docker Daemon (https://github.com/ansible-collections/community.docker/pull/933).
v3.11.0
-Minor Changes
+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=healthyallows to wait for a container to become healthy on startup. Thehealthy_wait_timeoutoption 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
+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_contextno longer leads to an invalid parameter combination being passed to the corresponding Docker CLI tool, unlessdocker_hostis also provided. Combiningcli_contextanddocker_hostis no longer allowed (https://github.com/ansible-collections/community.docker/issues/892, https://github.com/ansible-collections/community.docker/pull/895).
@@ -1482,13 +1507,13 @@
v3.10.4
-Release Summary
+v3.10.4
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_compose - make sure that the module uses the
api_versionparameter (https://github.com/ansible-collections/community.docker/pull/881).docker_compose_v2* modules - there was no check to make sure that one of
project_srcanddefinitionis provided. The modules crashed if none were provided (https://github.com/ansible-collections/community.docker/issues/885, https://github.com/ansible-collections/community.docker/pull/886).
@@ -1496,45 +1521,45 @@
v3.10.3
-Release Summary
+v3.10.3
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker and nsenter connection plugins, docker_container_exec module - avoid using the deprecated
ansible.module_utils.compat.selectorsmodule util with Python 3 (https://github.com/ansible-collections/community.docker/issues/870, https://github.com/ansible-collections/community.docker/pull/871).
v3.10.2
-Release Summary
+v3.10.2
+Release Summary
Bugfix release.
Bugfixes
+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/psf/requests/issues/6707, https://github.com/ansible-collections/community.docker/pull/864).
v3.10.1
-Release Summary
+v3.10.1
+Release Summary
Hotfix release for requests 2.32.0 compatibility.
Bugfixes
+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/docker/docker-py/issues/3256, https://github.com/ansible-collections/community.docker/pull/861).
Known Issues
+Known Issues
Please note that the fix for requests 2.32.0 included in community.docker 3.10.1 only fixes problems with the vendored Docker SDK for Python code. Modules and plugins that @@ -1547,13 +1572,13 @@ with requests 2.32.0.
v3.10.0
-Release Summary
+v3.10.0
+Release Summary
Feature release.
Minor Changes
+Minor Changes
docker_container - adds
healthcheck.start_intervalto support healthcheck start interval setting on containers (https://github.com/ansible-collections/community.docker/pull/848).docker_container - adds
healthcheck.test_cli_compatibleto allow omit test option on containers without remove existing image test (https://github.com/ansible-collections/community.docker/pull/847).
@@ -1565,8 +1590,8 @@ with requests 2.32.0.
docker_swarm_service - adds
sysctlsto support sysctl settings on swarm services (https://github.com/ansible-collections/community.docker/issues/190).
Deprecated Features
+Deprecated Features
docker_compose - the Docker Compose v1 module is deprecated and will be removed from community.docker 4.0.0. Please migrate to the
community.docker.docker_compose_v2module, which works with Docker Compose v2 (https://github.com/ansible-collections/community.docker/issues/823, https://github.com/ansible-collections/community.docker/pull/833).various modules and plugins - the
ssl_versionoption has been deprecated and will be removed from community.docker 4.0.0. It has already been removed from Docker SDK for Python 7.0.0, and was only necessary in the past to work around SSL/TLS issues (https://github.com/ansible-collections/community.docker/pull/853).
@@ -1574,13 +1599,13 @@ with requests 2.32.0.
v3.9.0
-Release Summary
+v3.9.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
The EE requirements now include PyYAML, since the
docker_compose_v2*modules depend on it when thedefinitionoption 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).docker_compose_v2* - the new option
check_files_existingallows to disable the check for one of the filescompose.yaml,compose.yml,docker-compose.yaml, anddocker-compose.ymlinproject_srciffilesis not specified. This is necessary if a non-standard compose filename is specified through other means, like theCOMPOSE_FILEenvironment variable (https://github.com/ansible-collections/community.docker/issues/838, https://github.com/ansible-collections/community.docker/pull/839).
@@ -1588,8 +1613,8 @@ with requests 2.32.0.
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).
Bugfixes
+Bugfixes
docker_compose_v2* - allow
project_srcto 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/pull/828).docker_compose_v2* modules - abort with a nice error message instead of crash when the Docker Compose CLI plugin version is
dev(https://github.com/ansible-collections/community.docker/issues/825, https://github.com/ansible-collections/community.docker/pull/826).
@@ -1598,19 +1623,19 @@ with requests 2.32.0.
v3.8.1
-Release Summary
+v3.8.1
+Release Summary
Bugfix release
Security Fixes
+Security Fixes
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://github.com/ansible-collections/community.docker/pull/815).
Bugfixes
+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 upstill completes successfully (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/811).docker_compose_v2* modules - correctly parse
Warningevents emitted by Docker Compose (https://github.com/ansible-collections/community.docker/issues/807, https://github.com/ansible-collections/community.docker/pull/811).
@@ -1620,21 +1645,21 @@ with requests 2.32.0.
v3.8.0
-Release Summary
+v3.8.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker_compose_v2 - allow to wait until containers are running/health when running
docker compose upwith the newwaitoption (https://github.com/ansible-collections/community.docker/issues/794, https://github.com/ansible-collections/community.docker/pull/796).docker_container - the
pull_check_mode_behavioroption now allows to control the module’s behavior in check mode whenpull=always(https://github.com/ansible-collections/community.docker/issues/792, https://github.com/ansible-collections/community.docker/pull/797).docker_container - the
pulloption now accepts the three valuesnever,missing_image(default), andnever, next to the previously valid valuestrue(equivalent toalways) andfalse(equivalent tomissing_image). This allows the equivalent to--pull=neverfrom the Docker command line (https://github.com/ansible-collections/community.docker/issues/783, https://github.com/ansible-collections/community.docker/pull/797).
Bugfixes
+Bugfixes
docker_compose_v2 - do not consider a
Waitingevent as an action/change (https://github.com/ansible-collections/community.docker/pull/804).docker_compose_v2 - do not treat service-level pull events as changes to avoid incorrect
changed=truereturn value ofpull=always(https://github.com/ansible-collections/community.docker/issues/802, https://github.com/ansible-collections/community.docker/pull/803).
@@ -1643,36 +1668,36 @@ with requests 2.32.0.
v3.7.0
-Release Summary
+v3.7.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker_compose_v2 - add
scaleoption to allow to explicitly scale services (https://github.com/ansible-collections/community.docker/pull/776).docker_compose_v2, docker_compose_v2_pull - support
filesparameter to specify multiple Compose files (https://github.com/ansible-collections/community.docker/issues/772, https://github.com/ansible-collections/community.docker/pull/775).
Bugfixes
+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/pull/779).docker_compose_v2_pull - the module was documented as part of the
community.docker.dockeraction group, but was not actually part of it. That has now been fixed (https://github.com/ansible-collections/community.docker/pull/773).
New Modules
+New Modules
community.docker.docker_image_export - Export (archive) Docker images
v3.6.0
-Release Summary
+v3.6.0
+Release Summary
Bugfix and feature release.
The collection now includes a bunch of new docker_image_* modules that move features out of the
rather complex docker_image module. These new modules are easier to use and can better declare whether
@@ -1684,13 +1709,13 @@ instead of directly talking to the API. The modules support mostly the same inte
so the main difference is that instead of some Python requirements, they depend on the Docker CLI tool docker.
Major Changes
+Major Changes
The
community.dockercollection now depends on thecommunity.library_inventory_filtering_v1collection. 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 withansible-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).
Minor Changes
+Minor Changes
The
ca_certoption available to almost all modules and plugins has been renamed toca_path. The nameca_pathis 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).The
docker_stack*modules now use the common CLI-based module code added for thedocker_image_buildanddocker_compose_v2modules. This means that the modules now have various more configuration options with respect to talking to the Docker Daemon, and now also are part of thecommunity.docker.dockeranddockermodule default groups (https://github.com/ansible-collections/community.docker/pull/745).
@@ -1700,15 +1725,15 @@ so the main difference is that instead of some Python requirements, they depend
inventory plugins - add
filteroption 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/issues/610).
Bugfixes
+Bugfixes
Use
unix:///var/run/docker.sockinstead of the legacyunix://var/run/docker.sockas default fordocker_host(https://github.com/ansible-collections/community.docker/pull/736).docker_image - fix archiving idempotency with Docker API 1.44 or later (https://github.com/ansible-collections/community.docker/pull/765).
New Modules
+New Modules
community.docker.docker_compose_v2 - Manage multi-container Docker applications with Docker Compose CLI plugin
community.docker.docker_compose_v2_pull - Pull a Docker compose project
@@ -1721,26 +1746,26 @@ so the main difference is that instead of some Python requirements, they depend
v3.5.0
-Release Summary
+v3.5.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker_container - implement better
platformstring comparisons to improve idempotency (https://github.com/ansible-collections/community.docker/issues/654, https://github.com/ansible-collections/community.docker/pull/705).docker_container - internal refactorings which allow comparisons to use more information like details of the current image or the Docker host config (https://github.com/ansible-collections/community.docker/pull/713).
Deprecated Features
+Deprecated Features
docker_container - the default
ignorefor theimage_name_mismatchparameter has been deprecated and will switch torecreatein 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).
Bugfixes
+Bugfixes
modules and plugins using the Docker SDK for Python - remove
ssl_versionfrom 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).modules and plugins using the Docker SDK for Python - remove
tls_hostnamefrom 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).
@@ -1749,48 +1774,48 @@ so the main difference is that instead of some Python requirements, they depend
v3.4.11
-Release Summary
+v3.4.11
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_volume - fix crash caused by accessing an empty dictionary. The
has_different_config()was raising anAttributeErrorbecause theself.existing_volume["Labels"]dictionary wasNone(https://github.com/ansible-collections/community.docker/pull/702).
v3.4.10
-Release Summary
+v3.4.10
+Release Summary
Bugfix release.
Bugfixes
+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/pull/696).
v3.4.9
-Release Summary
+v3.4.9
+Release Summary
Maintenance release with updated documentation and vendored Docker SDK for Python code.
Bugfixes
+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).
v3.4.8
-Release Summary
+v3.4.8
+Release Summary
Maintenance release with updated documentation.
From this version on, community.docker is using the new Ansible semantic markup in its documentation. If you look at documentation with the ansible-doc CLI tool @@ -1800,34 +1825,34 @@ ansible-core 2.15 or later to see it as it is intended. Alternatively you can look at the devel docsite for the rendered HTML version of the documentation of the latest release.
Known Issues
+Known Issues
Ansible markup will show up in raw form on ansible-doc text output for ansible-core before 2.15. If you have trouble deciphering the documentation markup, please upgrade to ansible-core 2.15 (or newer), or read the HTML documentation on https://docs.ansible.com/ansible/devel/collections/community/docker/.
v3.4.7
-Release Summary
+v3.4.7
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_swarm_info - if
service=trueis 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/pull/637).
v3.4.6
-Release Summary
+v3.4.6
+Release Summary
Bugfix release with documentation warnings about using certain functionality when connecting to the Docker daemon with TCP TLS.
Bugfixes
+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).
vendored Docker SDK for Python code - fix for errors on pipe close in Windows (https://github.com/ansible-collections/community.docker/pull/619).
@@ -1835,8 +1860,8 @@ for the rendered HTML version of the documentation of the latest release.
vendored Docker SDK for Python code - use
poll()instead ofselect()except on Windows (https://github.com/ansible-collections/community.docker/pull/619).
Known Issues
+Known Issues
docker_api connection plugin - does not work with TCP TLS sockets! This is caused by the inability to send an
close_notifyTLS alert without closing the connection with Python’sSSLSocket(https://github.com/ansible-collections/community.docker/issues/605, https://github.com/ansible-collections/community.docker/pull/621).docker_container_exec - does not work with TCP TLS sockets when the
stdinoption is used! This is caused by the inability to send anclose_notifyTLS alert without closing the connection with Python’sSSLSocket(https://github.com/ansible-collections/community.docker/issues/605, https://github.com/ansible-collections/community.docker/pull/621).
@@ -1844,65 +1869,65 @@ for the rendered HTML version of the documentation of the latest release.
v3.4.5
-Release Summary
+v3.4.5
+Release Summary
Maintenance release which adds compatibility with requests 2.29.0 and 2.30.0 and urllib3 2.0.
Bugfixes
+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).
v3.4.4
-Release Summary
+v3.4.4
+Release Summary
Maintenance release with updated EE requirements and updated documentation.
Minor Changes
+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/pull/612).
Known Issues
+Known Issues
The modules and plugins using the vendored code from Docker SDK for Python currently do not work with requests 2.29.0 and/or urllib3 2.0.0. The same is currently true for the latest version of Docker SDK for Python itself (https://github.com/ansible-collections/community.docker/issues/611, https://github.com/ansible-collections/community.docker/pull/612).
v3.4.3
-Release Summary
+v3.4.3
+Release Summary
Maintenance release with improved documentation.
v3.4.2
-Release Summary
+v3.4.2
+Release Summary
Bugfix release.
Bugfixes
+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).
v3.4.1
-Release Summary
+v3.4.1
+Release Summary
Regular bugfix release.
Bugfixes
+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).
docker_container - fix
tmfs_sizeandtmpfs_modenot being set (https://github.com/ansible-collections/community.docker/pull/580).
@@ -1911,20 +1936,20 @@ for the rendered HTML version of the documentation of the latest release.
v3.4.0
-Release Summary
+v3.4.0
+Release Summary
Regular bugfix and feature release.
Minor Changes
+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).
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/pull/538).
Bugfixes
+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).
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).
@@ -1932,54 +1957,54 @@ for the rendered HTML version of the documentation of the latest release.
most modules - fix handling of
DOCKER_TIMEOUTenvironment 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/pull/554).
New Modules
+New Modules
community.docker.docker_container_copy_into - Copy a file into a Docker container
v3.3.2
-Release Summary
+v3.3.2
+Release Summary
Bugfix release.
Bugfixes
+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/pull/527).
v3.3.1
-Release Summary
+v3.3.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
current_container_facts - make container detection work better in more cases (https://github.com/ansible-collections/community.docker/pull/522).
v3.3.0
-Release Summary
+v3.3.0
+Release Summary
Feature and bugfix release.
Minor Changes
+Minor Changes
current_container_facts - make work with current Docker version, also support Podman (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).
Bugfixes
+Bugfixes
docker_container_exec - fix
chdiroption 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/pull/518).vendored latest Docker SDK for Python bugfix (https://github.com/ansible-collections/community.docker/pull/513, https://github.com/docker/docker-py/issues/3045).
@@ -1987,39 +2012,39 @@ for the rendered HTML version of the documentation of the latest release.
v3.2.2
-Release Summary
+v3.2.2
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_container - the
kill_signaloption 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/pull/506).
v3.2.1
-Release Summary
+v3.2.1
+Release Summary
Maintenance release with improved documentation.
v3.2.0
-Release Summary
+v3.2.0
+Release Summary
Feature and deprecation release.
Minor Changes
+Minor Changes
docker_container - added
image_name_mismatchoption 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/pull/488).
Deprecated Features
+Deprecated Features
docker_container - the
ignore_imageoption is deprecated and will be removed in community.docker 4.0.0. Useimage: ignoreincomparisonsinstead (https://github.com/ansible-collections/community.docker/pull/487).docker_container - the
purge_networksoption is deprecated and will be removed in community.docker 4.0.0. Usenetworks: strictincomparisonsinstead, and make sure to providenetworks, with value[]if all networks should be removed (https://github.com/ansible-collections/community.docker/pull/487).
@@ -2027,13 +2052,13 @@ for the rendered HTML version of the documentation of the latest release.
v3.1.0
-Release Summary
+v3.1.0
+Release Summary
Feature release.
Minor Changes
+Minor Changes
The collection repository conforms to the REUSE specification except for the changelog fragments (https://github.com/ansible-collections/community.docker/pull/462).
docker_swarm - allows usage of the
data_path_portparameter when initializing a swarm (https://github.com/ansible-collections/community.docker/issues/296).
@@ -2041,39 +2066,39 @@ for the rendered HTML version of the documentation of the latest release.
v3.0.2
-Release Summary
+v3.0.2
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_image - fix build argument handling (https://github.com/ansible-collections/community.docker/issues/455, https://github.com/ansible-collections/community.docker/pull/456).
v3.0.1
-Release Summary
+v3.0.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker_container - fix handling of
env_file(https://github.com/ansible-collections/community.docker/issues/451, https://github.com/ansible-collections/community.docker/pull/452).
v3.0.0
-Release Summary
+v3.0.0
+Release Summary
The 3.0.0 release features a rewrite of the docker_container module, and many modules and plugins no longer depend on the Docker SDK for Python.
Major Changes
+Major Changes
The collection now contains vendored code from the Docker SDK for Python to talk to the Docker daemon. Modules and plugins using this code no longer need the Docker SDK for Python installed on the machine the module or plugin is running on (https://github.com/ansible-collections/community.docker/pull/398).
docker_api connection plugin - no longer uses the Docker SDK for Python. It requires
requeststo 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/414).
@@ -2095,8 +2120,8 @@ for the rendered HTML version of the documentation of the latest release.
docker_volume_info - no longer uses the Docker SDK for Python. It requires
requeststo 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).
Minor Changes
+Minor Changes
All software licenses are now in the
LICENSES/directory of the collection root. Moreover,SPDX-License-Identifier:is used to declare the applicable license for every file that is not automatically generated (https://github.com/ansible-collections/community.docker/pull/430).Remove vendored copy of
distutils.versionin favor of vendored copy included with ansible-core 2.12+. For ansible-core 2.11, usesdistutils.versionfor Python < 3.12. There is no support for ansible-core 2.11 with Python 3.12+ (https://github.com/ansible-collections/community.docker/pull/271).
@@ -2108,8 +2133,8 @@ for the rendered HTML version of the documentation of the latest release.
socker_handler and socket_helper module utils - improve Python forward compatibility, create helper functions for file blocking/unblocking (https://github.com/ansible-collections/community.docker/pull/415).
Breaking Changes / Porting Guide
+Breaking Changes / Porting Guide
This collection does not work with ansible-core 2.11 on Python 3.12+. Please either upgrade to ansible-core 2.12+, or use Python 3.11 or earlier (https://github.com/ansible-collections/community.docker/pull/271).
docker_container -
exposed_portsis no longer ignored incomparisons. Before, its value was assumed to be identical with the value ofpublished_ports(https://github.com/ansible-collections/community.docker/pull/422).
@@ -2120,8 +2145,8 @@ for the rendered HTML version of the documentation of the latest release.
modules and plugins communicating directly with the Docker daemon - when connecting by SSH and not using
use_ssh_client=true, reject unknown host keys instead of accepting them. This is only a breaking change relative to older community.docker 3.0.0 pre-releases or with respect to Docker SDK for Python < 6.0.0. Docker SDK for Python 6.0.0 will also include this change (https://github.com/ansible-collections/community.docker/pull/434).
Removed Features (previously deprecated)
+Removed Features (previously deprecated)
Execution Environments built with community.docker no longer include docker-compose < 2.0.0. If you need to use it with the
docker_composemodule, please install that requirement manually (https://github.com/ansible-collections/community.docker/pull/400).Support for Ansible 2.9 and ansible-base 2.10 has been removed. If you need support for Ansible 2.9 or ansible-base 2.10, please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).
@@ -2133,14 +2158,14 @@ for the rendered HTML version of the documentation of the latest release.
docker_stack - the return values
outanderrhave been removed. Usestdoutandstderrinstead (https://github.com/ansible-collections/community.docker/pull/363).
Security Fixes
+Security Fixes
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).
Bugfixes
+Bugfixes
docker_image - when composing the build context, trim trailing whitespace from
.dockerignoreentries. 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).docker_plugin - fix crash when handling plugin options (https://github.com/ansible-collections/community.docker/issues/446, https://github.com/ansible-collections/community.docker/pull/447).
@@ -2153,45 +2178,45 @@ for the rendered HTML version of the documentation of the latest release.
v2.7.0
-Release Summary
+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
+Minor Changes
Move common utility functions from the
commonmodule_util to a new module_util calledutil. This should not have any user-visible effect (https://github.com/ansible-collections/community.docker/pull/390).
Deprecated Features
+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, anddocker_volume, whose minimally supported API version is between 1.20 and 1.24 (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).
Bugfixes
+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).
v2.6.0
-Release Summary
+v2.6.0
+Release Summary
Bugfix and feature release.
Minor Changes
+Minor Changes
docker_container - added
image_label_mismatchparameter (https://github.com/ansible-collections/community.docker/issues/314, https://github.com/ansible-collections/community.docker/pull/370).
Deprecated Features
+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).
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 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).
@@ -2199,8 +2224,8 @@ for the rendered HTML version of the documentation of the latest release.
docker_stack - the return values
outanderrthat 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).
Bugfixes
+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/issues/365).
docker_container - remove unused code that will cause problems with Python 3.13 (https://github.com/ansible-collections/community.docker/pull/354).
@@ -2208,26 +2233,26 @@ for the rendered HTML version of the documentation of the latest release.
v2.5.1
-Release Summary
+v2.5.1
+Release Summary
Maintenance release.
Bugfixes
+Bugfixes
Include
PSF-license.txtfile forplugins/module_utils/_version.py.
v2.5.0
-Release Summary
+v2.5.0
+Release Summary
Regular feature release.
Minor Changes
+Minor Changes
docker_config - add support for
template_driverwith one optiongolang(https://github.com/ansible-collections/community.docker/issues/332, https://github.com/ansible-collections/community.docker/pull/345).docker_swarm - adds
data_path_addrparameter during swarm initialization or when joining (https://github.com/ansible-collections/community.docker/issues/339).
@@ -2235,34 +2260,34 @@ for the rendered HTML version of the documentation of the latest release.
v2.4.0
-Release Summary
+v2.4.0
+Release Summary
Regular feature and bugfix release.
Minor Changes
+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).current_container_facts - add detection for GitHub Actions (https://github.com/ansible-collections/community.docker/pull/336).
docker_container - support returning Docker container log output when using Docker’s
locallogging driver, an optimized local logging driver introduced in Docker 18.09 (https://github.com/ansible-collections/community.docker/pull/337).
Bugfixes
+Bugfixes
docker connection plugin - make sure that
docker_extra_argsis 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/pull/327).
v2.3.0
-Release Summary
+v2.3.0
+Release Summary
Regular feature and bugfix release.
Minor Changes
+Minor Changes
docker connection plugin - implement connection reset by clearing internal container user cache (https://github.com/ansible-collections/community.docker/pull/312).
docker connection plugin - simplify
actual_userhandling code (https://github.com/ansible-collections/community.docker/pull/311).
@@ -2271,8 +2296,8 @@ for the rendered HTML version of the documentation of the latest release.
docker_api connection plugin - the plugin supports new ways to define the timeout. These are the
ANSIBLE_DOCKER_TIMEOUTenvironment variable, thetimeoutsetting in thedocker_connectionsection ofansible.cfg, and theansible_docker_timeoutvariable (https://github.com/ansible-collections/community.docker/pull/308).
Bugfixes
+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/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).
@@ -2280,67 +2305,67 @@ for the rendered HTML version of the documentation of the latest release.
v2.2.1
-Release Summary
+v2.2.1
+Release Summary
Regular bugfix release.
Bugfixes
+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).
v2.2.0
-Release Summary
+v2.2.0
+Release Summary
Regular feature and bugfix release.
Minor Changes
+Minor Changes
docker_config - add support for rolling update, set
rolling_versionstotrueto enable (https://github.com/ansible-collections/community.docker/pull/295, https://github.com/ansible-collections/community.docker/issues/109).docker_secret - add support for rolling update, set
rolling_versionstotrueto enable (https://github.com/ansible-collections/community.docker/pull/293, https://github.com/ansible-collections/community.docker/issues/21).docker_swarm_service - add support for setting capabilities with the
cap_addandcap_dropparameters. Usage is the same as with thecapabilitiesandcap_dropparameters fordocker_container(https://github.com/ansible-collections/community.docker/pull/294).
Bugfixes
+Bugfixes
docker_container, docker_image - adjust image finding code to peculiarities of
podman-docker’s API emulation when Docker short names likeredisare used (https://github.com/ansible-collections/community.docker/issues/292).
v2.1.1
-Release Summary
+v2.1.1
+Release Summary
Emergency release to amend breaking change in previous release.
Bugfixes
+Bugfixes
Fix unintended breaking change caused by an earlier fix by vendoring the deprecated Python standard library
distutils.versionuntil 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/pull/269).
v2.1.0
-Release Summary
+v2.1.0
+Release Summary
Feature and bugfix release.
Minor Changes
+Minor Changes
docker_container_exec - add
detachparameter (https://github.com/ansible-collections/community.docker/issues/250, https://github.com/ansible-collections/community.docker/pull/255).docker_container_exec - add
envoption (https://github.com/ansible-collections/community.docker/issues/248, https://github.com/ansible-collections/community.docker/pull/254).
Bugfixes
+Bugfixes
Various modules and plugins - use vendored version of
distutils.versionincluded in ansible-core 2.12 if available. This avoids breakage whendistutilsis 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).docker connection plugin - replace deprecated
distutils.spawn.find_executablewith Ansible’sget_bin_pathto find thedockerexecutable (https://github.com/ansible-collections/community.docker/pull/257).
@@ -2349,13 +2374,13 @@ for the rendered HTML version of the documentation of the latest release.
v2.0.2
-Release Summary
+v2.0.2
+Release Summary
Bugfix release.
Bugfixes
+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).
docker_container_exec -
chdiris 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 whenchdiris not provided to this module (https://github.com/ansible-collections/community.docker/pull/243, https://github.com/ansible-collections/community.docker/issues/242).
@@ -2365,32 +2390,32 @@ for the rendered HTML version of the documentation of the latest release.
v2.0.1
-Release Summary
+v2.0.1
+Release Summary
Maintenance release with some documentation fixes.
v2.0.0
-Release Summary
+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
+Breaking Changes / Porting Guide
docker_compose - fixed
timeoutdefaulting behavior so thatstop_grace_period, if defined in the compose file, will be used iftimeoutis not specified (https://github.com/ansible-collections/community.docker/pull/163).
Deprecated Features
+Deprecated Features
docker_container - using the special value
allinpublished_portshas been deprecated. Usepublish_all_ports=trueinstead (https://github.com/ansible-collections/community.docker/pull/210).
Removed Features (previously deprecated)
+Removed Features (previously deprecated)
docker_container - the default value of
container_default_behaviorchanged tono_defaults(https://github.com/ansible-collections/community.docker/pull/210).docker_container - the default value of
network_modeis now the name of the first network specified innetworksif such are specified andnetworks_cli_compatible=true(https://github.com/ansible-collections/community.docker/pull/210).
@@ -2400,13 +2425,13 @@ for the rendered HTML version of the documentation of the latest release.
v1.10.0
-Release Summary
+v1.10.0
+Release Summary
Regular feature and bugfix release.
Minor Changes
+Minor Changes
Add the modules docker_container_exec, docker_image_load and docker_plugin to the
dockermodule defaults group (https://github.com/ansible-collections/community.docker/pull/209).docker_config - add option
data_srcto read configuration data from target (https://github.com/ansible-collections/community.docker/issues/64, https://github.com/ansible-collections/community.docker/pull/203).
@@ -2415,26 +2440,26 @@ for the rendered HTML version of the documentation of the latest release.
v1.9.1
-Release Summary
+v1.9.1
+Release Summary
Regular bugfix release.
Bugfixes
+Bugfixes
docker_compose - fixed incorrect
changedstatus for services withprofilesdefined, but none enabled (https://github.com/ansible-collections/community.docker/pull/192).
v1.9.0
-Release Summary
+v1.9.0
+Release Summary
New bugfixes and features release.
Minor Changes
+Minor Changes
docker_* modules - include
ImportErrortraceback when reporting that Docker SDK for Python could not be found (https://github.com/ansible-collections/community.docker/pull/188).docker_compose - added
env_fileoption for specifying custom environment files (https://github.com/ansible-collections/community.docker/pull/174).
@@ -2443,14 +2468,14 @@ for the rendered HTML version of the documentation of the latest release.
docker_container - lifted restriction preventing the creation of anonymous volumes with the
mountsoption (https://github.com/ansible-collections/community.docker/pull/181).
Deprecated Features
+Deprecated Features
docker_container - the new
command_handling’s default value,compatibility, is deprecated and will change tocorrectin 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).
Bugfixes
+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).docker_container - make sure to also return
containerondetached=falsewhen status code is non-zero (https://github.com/ansible-collections/community.docker/pull/178).
@@ -2459,9 +2484,9 @@ for the rendered HTML version of the documentation of the latest release.
New Plugins
+New Plugins
Connection
+Connection
community.docker.nsenter - execute on host running controller container
v1.8.0
-Release Summary
+v1.8.0
+Release Summary
Regular bugfix and feature release.
Minor Changes
+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).
docker_compose - added
profilesoption to specify service profiles when starting services (https://github.com/ansible-collections/community.docker/pull/167).
@@ -2484,60 +2509,60 @@ for the rendered HTML version of the documentation of the latest release.
docker_plugin - added
aliasoption to specify local names for docker plugins (https://github.com/ansible-collections/community.docker/pull/161).
Bugfixes
+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/pull/159).
v1.7.0
-Release Summary
+v1.7.0
+Release Summary
Small feature and bugfix release.
Minor Changes
+Minor Changes
docker_image - allow to tag images by ID (https://github.com/ansible-collections/community.docker/pull/149).
v1.6.1
-Release Summary
+v1.6.1
+Release Summary
Bugfix release to reduce deprecation warning spam.
Bugfixes
+Bugfixes
docker_* modules and plugins, except
docker_swarmconnection plugin anddocker_composeanddocker_stack*` modules - only emit ``tls_hostnamedeprecation message if TLS is actually used (https://github.com/ansible-collections/community.docker/pull/143).
v1.6.0
-Release Summary
+v1.6.0
+Release Summary
Regular bugfix and feature release.
Minor Changes
+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).
docker_container - allow
memory_swap: -1to 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 ofmemory(https://github.com/ansible-collections/community.docker/pull/138).
Deprecated Features
+Deprecated Features
docker_* modules and plugins, except
docker_swarmconnection plugin anddocker_composeanddocker_stack*` modules - the current default ``localhostfortls_hostnameis deprecated. In community.docker 2.0.0 it will be computed fromdocker_hostinstead (https://github.com/ansible-collections/community.docker/pull/134).
Bugfixes
+Bugfixes
docker-compose - fix not pulling when
state: presentandstopped: true(https://github.com/ansible-collections/community.docker/issues/12, 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/pull/135).
@@ -2546,56 +2571,56 @@ for the rendered HTML version of the documentation of the latest release.
v1.5.0
-Release Summary
+v1.5.0
+Release Summary
Regular feature release.
Minor Changes
+Minor Changes
Add the
use_ssh_clientoption to most docker modules and plugins (https://github.com/ansible-collections/community.docker/issues/108, https://github.com/ansible-collections/community.docker/pull/114).
Bugfixes
+Bugfixes
all modules - use
to_nativeto convert exceptions to strings (https://github.com/ansible-collections/community.docker/pull/121).
New Modules
+New Modules
community.docker.docker_container_exec - Execute command in a docker container
v1.4.0
-Release Summary
+v1.4.0
+Release Summary
Security release to address another potential secret leak. Also includes regular bugfixes and features.
Minor Changes
+Minor Changes
docker_swarm_service - change
publish.published_portoption from mandatory to optional. Docker will assign random high port if not specified (https://github.com/ansible-collections/community.docker/issues/99).
Breaking Changes / Porting Guide
+Breaking Changes / Porting Guide
docker_swarm - if
join_tokenis specified, a returned join token with the same value will be replaced byVALUE_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 withjoin_tokenspecified! 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).
Security Fixes
+Security Fixes
docker_swarm - the
join_tokenoption is now marked asno_logso it is no longer written into logs (https://github.com/ansible-collections/community.docker/pull/103).
Bugfixes
+Bugfixes
docker_swarm_service- fix KeyError on caused by reference to deprecated optionupdate_failure_action(https://github.com/ansible-collections/community.docker/pull/100).docker_swarm_service - mark
secretsmodule option withno_log=Falsesince it does not leak secrets (https://github.com/ansible-collections/community.general/pull/2001).
@@ -2603,13 +2628,13 @@ for the rendered HTML version of the documentation of the latest release.
v1.3.0
-Release Summary
+v1.3.0
+Release Summary
Regular feature and bugfix release.
Minor Changes
+Minor Changes
docker_container - add
storage_optsoption to specify storage options (https://github.com/ansible-collections/community.docker/issues/91, https://github.com/ansible-collections/community.docker/pull/93).docker_image - allows to specify platform to pull for
source=pullwith new optionpull_platform(https://github.com/ansible-collections/community.docker/issues/79, https://github.com/ansible-collections/community.docker/pull/89).
@@ -2617,8 +2642,8 @@ for the rendered HTML version of the documentation of the latest release.
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/pull/92).
Bugfixes
+Bugfixes
docker_container - fix healthcheck disabling idempotency issue with strict comparison (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).
@@ -2627,8 +2652,8 @@ for the rendered HTML version of the documentation of the latest release.
docker_image_info - prevent module failure when querying non-existent image by ID (https://github.com/ansible-collections/community.docker/pull/87).
New Modules
+New Modules
community.docker.docker_image_load - Load docker image(s) from archives
community.docker.docker_plugin - Manage Docker plugins
@@ -2636,45 +2661,45 @@ for the rendered HTML version of the documentation of the latest release.
v1.2.2
-Release Summary
+v1.2.2
+Release Summary
Security bugfix release to address CVE-2021-20191.
Security Fixes
+Security Fixes
docker_swarm - enabled
no_logfor the optionsigning_ca_keyto prevent accidental disclosure (CVE-2021-20191, https://github.com/ansible-collections/community.docker/pull/80).
v1.2.1
-Release Summary
+v1.2.1
+Release Summary
Bugfix release.
Bugfixes
+Bugfixes
docker connection plugin - fix Docker version parsing, as some docker versions have a leading
vin the output of the commanddocker version --format "{{.Server.Version}}"(https://github.com/ansible-collections/community.docker/pull/76).
v1.2.0
-Release Summary
+v1.2.0
+Release Summary
Feature release with one new feature and two bugfixes.
Minor Changes
+Minor Changes
docker_container - added
default_host_ipoption 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/pull/71).
Bugfixes
+Bugfixes
docker_container - allow IPv6 zones (RFC 4007) in bind IPs (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/pull/73).
@@ -2682,76 +2707,76 @@ for the rendered HTML version of the documentation of the latest release.
v1.1.0
-Release Summary
+v1.1.0
+Release Summary
Feature release with three new plugins and modules.
Minor Changes
+Minor Changes
docker_container - support specifying
cgroup_parent(https://github.com/ansible-collections/community.docker/issues/6, https://github.com/ansible-collections/community.docker/pull/59).docker_container - when a container is started with
detached=false,statusis now also returned when it is 0 (https://github.com/ansible-collections/community.docker/issues/26, https://github.com/ansible-collections/community.docker/pull/58).docker_image - support
platformwhen building images (https://github.com/ansible-collections/community.docker/issues/22, https://github.com/ansible-collections/community.docker/pull/54).
Deprecated Features
+Deprecated Features
docker_container - currently
published_portscan contain port mappings next to the special valueall, 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/pull/60).
Bugfixes
+Bugfixes
docker_image - if
push=trueis used withrepository, and the image does not need to be tagged, still push. This can happen ifrepositoryandnameare equal (https://github.com/ansible-collections/community.docker/issues/52, 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/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/pull/55).