Community.Docker Release Notes

v3.10.3

Release Summary

Bugfix release.

Bugfixes

v3.10.2

Release Summary

Bugfix release.

Bugfixes

v3.10.1

Release Summary

Hotfix release for requests 2.32.0 compatibility.

Bugfixes

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 use Docker SDK for Python can still fail due to the SDK currently being incompatible with requests 2.32.0.

    If you still experience problems with requests 2.32.0, such as error messages like Not supported URL scheme http+docker, please restrict requests to <2.32.0.

v3.10.0

Release Summary

Feature release.

Minor Changes

Deprecated Features

v3.9.0

Release Summary

Bugfix and feature release.

Minor Changes

Bugfixes

v3.8.1

Release Summary

Bugfix release

Security Fixes

Bugfixes

v3.8.0

Release Summary

Bugfix and feature release.

Minor Changes

Bugfixes

v3.7.0

Release Summary

Bugfix and feature release.

Minor Changes

Bugfixes

New Modules

  • community.docker.docker_image_export - Export (archive) Docker images

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 they support check mode, diff mode, or none of them.

This version also features modules that support the Docker CLI plugins buildx and compose. The docker_image_build module uses the docker buildx command under the hood, and the docker_compose_v2 and docker_compose_v2_pull modules uses the docker compose command. All these modules use the Docker CLI instead of directly talking to the API. The modules support mostly the same interface as the API based modules, so the main difference is that instead of some Python requirements, they depend on the Docker CLI tool docker.

Major Changes

  • 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).

Minor Changes

Bugfixes

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

  • community.docker.docker_image_build - Build Docker images using Docker buildx

  • community.docker.docker_image_pull - Pull Docker images from registries

  • community.docker.docker_image_push - Push Docker images to registries

  • community.docker.docker_image_remove - Remove Docker images

  • community.docker.docker_image_tag - Tag Docker images with new names and/or tags

v3.5.0

Release Summary

Bugfix and feature release.

Minor Changes

Deprecated Features

  • docker_container - the default ignore for the image_name_mismatch parameter has been deprecated and will switch to recreate in community.docker 4.0.0. A deprecation warning will be printed in situations where the default value is used and where a behavior would change once the default changes (https://github.com/ansible-collections/community.docker/pull/703).

Bugfixes

v3.4.11

Release Summary

Bugfix release.

Bugfixes

v3.4.10

Release Summary

Bugfix release.

Bugfixes

v3.4.9

Release Summary

Maintenance release with updated documentation and vendored Docker SDK for Python code.

Bugfixes

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 from ansible-core before 2.15, please note that it does not render the markup correctly. You should be still able to read it in most cases, but you need 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

v3.4.7

Release Summary

Bugfix release.

Bugfixes

v3.4.6

Release Summary

Bugfix release with documentation warnings about using certain functionality when connecting to the Docker daemon with TCP TLS.

Bugfixes

Known Issues

v3.4.5

Release Summary

Maintenance release which adds compatibility with requests 2.29.0 and 2.30.0 and urllib3 2.0.

Bugfixes

v3.4.4

Release Summary

Maintenance release with updated EE requirements and updated documentation.

Minor Changes

Known Issues

v3.4.3

Release Summary

Maintenance release with improved documentation.

v3.4.2

Release Summary

Bugfix release.

Bugfixes

v3.4.1

Release Summary

Regular bugfix release.

Bugfixes

v3.4.0

Release Summary

Regular bugfix and feature release.

Minor Changes

Bugfixes

New Modules

  • community.docker.docker_container_copy_into - Copy a file into a Docker container

v3.3.2

Release Summary

Bugfix release.

Bugfixes

v3.3.1

Release Summary

Bugfix release.

Bugfixes

v3.3.0

Release Summary

Feature and bugfix release.

Minor Changes

Bugfixes

v3.2.2

Release Summary

Bugfix release.

Bugfixes

v3.2.1

Release Summary

Maintenance release with improved documentation.

v3.2.0

Release Summary

Feature and deprecation release.

Minor Changes

Deprecated Features

v3.1.0

Release Summary

Feature release.

Minor Changes

v3.0.2

Release Summary

Bugfix release.

Bugfixes

v3.0.1

Release Summary

Bugfix release.

Bugfixes

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

Minor Changes

Breaking Changes / Porting Guide

Removed Features (previously deprecated)

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

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

Deprecated Features

  • Support for Docker API version 1.20 to 1.24 has been deprecated and will be removed in community.docker 3.0.0. The first Docker version supporting API version 1.25 was Docker 1.13, released in January 2017. This affects the modules docker_container, docker_container_exec, docker_container_info, docker_compose, docker_login, docker_image, docker_image_info, docker_image_load, docker_host_info, docker_network, docker_network_info, docker_node_info, docker_swarm_info, docker_swarm_service, docker_swarm_service_info, docker_volume_info, and docker_volume, whose minimally supported API version is between 1.20 and 1.24 (https://github.com/ansible-collections/community.docker/pull/396).

  • 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

  • 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

Bugfix and feature release.

Minor Changes

Deprecated Features

Bugfixes

v2.5.1

Release Summary

Maintenance release.

Bugfixes

  • Include PSF-license.txt file for plugins/module_utils/_version.py.

v2.5.0

Release Summary

Regular feature release.

Minor Changes

v2.4.0

Release Summary

Regular feature and bugfix release.

Minor Changes

Bugfixes

v2.3.0

Release Summary

Regular feature and bugfix release.

Minor Changes

Bugfixes

v2.2.1

Release Summary

Regular bugfix release.

Bugfixes

v2.2.0

Release Summary

Regular feature and bugfix release.

Minor Changes

Bugfixes

v2.1.1

Release Summary

Emergency release to amend breaking change in previous release.

Bugfixes

v2.1.0

Release Summary

Feature and bugfix release.

Minor Changes

Bugfixes

v2.0.2

Release Summary

Bugfix release.

Bugfixes

v2.0.1

Release Summary

Maintenance release with some documentation fixes.

v2.0.0

Release Summary

New major release with some deprecations removed and a breaking change in the docker_compose module regarding the timeout parameter.

Breaking Changes / Porting Guide

Deprecated Features

Removed Features (previously deprecated)

v1.10.0

Release Summary

Regular feature and bugfix release.

Minor Changes

v1.9.1

Release Summary

Regular bugfix release.

Bugfixes

v1.9.0

Release Summary

New bugfixes and features release.

Minor Changes

Deprecated Features

  • docker_container - the new command_handling’s default value, compatibility, is deprecated and will change to correct in community.docker 3.0.0. A deprecation warning is emitted by the module in cases where the behavior will change. Please note that ansible-core will output a deprecation warning only once, so if it is shown for an earlier task, there could be more tasks with this warning where it is not shown (https://github.com/ansible-collections/community.docker/pull/186).

Bugfixes

New Plugins

Connection

  • community.docker.nsenter - execute on host running controller container

v1.8.0

Release Summary

Regular bugfix and feature release.

Minor Changes

Bugfixes

v1.7.0

Release Summary

Small feature and bugfix release.

Minor Changes

v1.6.1

Release Summary

Bugfix release to reduce deprecation warning spam.

Bugfixes

v1.6.0

Release Summary

Regular bugfix and feature release.

Minor Changes

Deprecated Features

  • docker_* modules and plugins, except docker_swarm connection plugin and docker_compose and docker_stack*` modules - the current default ``localhost for tls_hostname is deprecated. In community.docker 2.0.0 it will be computed from docker_host instead (https://github.com/ansible-collections/community.docker/pull/134).

Bugfixes

v1.5.0

Release Summary

Regular feature release.

Minor Changes

Bugfixes

New Modules

  • community.docker.docker_container_exec - Execute command in a docker container

v1.4.0

Release Summary

Security release to address another potential secret leak. Also includes regular bugfixes and features.

Minor Changes

Breaking Changes / Porting Guide

  • docker_swarm - if join_token is specified, a returned join token with the same value will be replaced by VALUE_SPECIFIED_IN_NO_LOG_PARAMETER. Make sure that you do not blindly use the join tokens from the return value of this module when the module is invoked with join_token specified! This breaking change appears in a minor release since it is necessary to fix a security issue (https://github.com/ansible-collections/community.docker/pull/103).

Security Fixes

Bugfixes

v1.3.0

Release Summary

Regular feature and bugfix release.

Minor Changes

Bugfixes

New Modules

  • community.docker.docker_image_load - Load docker image(s) from archives

  • community.docker.docker_plugin - Manage Docker plugins

v1.2.2

Release Summary

Security bugfix release to address CVE-2021-20191.

Security Fixes

v1.2.1

Release Summary

Bugfix release.

Bugfixes

v1.2.0

Release Summary

Feature release with one new feature and two bugfixes.

Minor Changes

Bugfixes

v1.1.0

Release Summary

Feature release with three new plugins and modules.

Minor Changes

Deprecated Features

Bugfixes

New Plugins

Connection

  • community.docker.docker_api - Run tasks in docker containers

Inventory

  • community.docker.docker_containers - Ansible dynamic inventory plugin for Docker containers.

New Modules

  • community.docker.current_container_facts - Return facts about whether the module runs in a Docker container

v1.0.1

Release Summary

Maintenance release with a bugfix for docker_container.

Bugfixes

v1.0.0

Release Summary

This is the first production (non-prerelease) release of community.docker.

Minor Changes

v0.1.0

Release Summary

The community.docker continues the work on the Ansible docker modules and plugins from their state in community.general 1.2.0. The changes listed here are thus relative to the modules and plugins community.general.docker*.

All deprecation removals planned for community.general 2.0.0 have been applied. All deprecation removals scheduled for community.general 3.0.0 have been re-scheduled for community.docker 2.0.0.

Minor Changes

Removed Features (previously deprecated)

Bugfixes