ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 03:52:05 +00:00
Code Packages Projects Releases Wiki Activity

Release 3.0.0-a1.

Browse Source
This commit is contained in:
Felix Fontein 2022-07-07 07:07:55 +02:00
parent 848e21d253
commit b90cc8b3f9
23 changed files with 170 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
CHANGELOG.rst
View File

@ -5,6 +5,56 @@ Docker Community Collection Release Notes
.. contents:: Topics
v3.0.0-a1
=========
Release Summary
---------------
First alpha prerelease of community.docker 3.0.0. This version has several breaking changes and features rewrites of several modules to directly use the API using ``requests``, instead of using the Docker SDK for Python.
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 ``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/414).
- docker_container_exec - 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/401).
- docker_container_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/402).
- docker_containers inventory plugin - 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/413).
- docker_host_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/403).
- docker_image - 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/404).
- docker_image_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/405).
- docker_image_load - 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/406).
- docker_login - 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/407).
- docker_network - 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/408).
- docker_network_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/409).
- docker_prune - 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/410).
- 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).
- 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).
Minor Changes
-------------
- Remove vendored copy of ``distutils.version`` in favor of vendored copy included with ansible-core 2.12+. For ansible-core 2.11, uses ``distutils.version`` for 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).
- socker_handler and socket_helper module utils - improve Python forward compatibilty, create helper functions for file blocking/unblocking (https://github.com/ansible-collections/community.docker/pull/415).
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).
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_compose`` module, 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).
- Support for Docker API versions 1.20 to 1.24 has been removed. If you need support for these API versions, please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).
- Support for Python 2.6 has been removed. If you need support for Python 2.6, please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).
- Various modules - the default of ``tls_hostname`` (``localhost``) has been removed. If you want to continue using ``localhost``, you need to specify it explicitly (https://github.com/ansible-collections/community.docker/pull/363).
- docker_container - the ``all`` value is no longer allowed in ``published_ports``. Use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/399).
- docker_container - the default of ``command_handling`` was changed from ``compatibility`` to ``correct``. Older versions were warning for every invocation of the module when this would result in a change of behavior (https://github.com/ansible-collections/community.docker/pull/399).
- docker_stack - the return values ``out`` and ``err`` have been removed. Use ``stdout`` and ``stderr`` instead (https://github.com/ansible-collections/community.docker/pull/363).
v2.7.0
======

120
changelogs/changelog.yaml
View File

@ -700,3 +700,123 @@ releases:
- 397-deprecate-docker-api-1.24.yml
- python-2.6.yml
release_date: '2022-07-02'
3.0.0-a1:
changes:
breaking_changes:
- 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).
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 ``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/414).
- docker_container_exec - 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/401).
- docker_container_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/402).
- docker_containers inventory plugin - 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/413).
- docker_host_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/403).
- docker_image - 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/404).
- docker_image_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/405).
- docker_image_load - 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/406).
- docker_login - 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/407).
- docker_network - 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/408).
- docker_network_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/409).
- docker_prune - 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/410).
- 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).
- 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).
minor_changes:
- Remove vendored copy of ``distutils.version`` in favor of vendored copy included
with ansible-core 2.12+. For ansible-core 2.11, uses ``distutils.version``
for 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).
- socker_handler and socket_helper module utils - improve Python forward compatibilty,
create helper functions for file blocking/unblocking (https://github.com/ansible-collections/community.docker/pull/415).
release_summary: First alpha prerelease of community.docker 3.0.0. This version
has several breaking changes and features rewrites of several modules to directly
use the API using ``requests``, instead of using the Docker SDK for Python.
removed_features:
- Execution Environments built with community.docker no longer include docker-compose
< 2.0.0. If you need to use it with the ``docker_compose`` module, 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).
- Support for Docker API versions 1.20 to 1.24 has been removed. If you need
support for these API versions, please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).
- Support for Python 2.6 has been removed. If you need support for Python 2.6,
please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).
- Various modules - the default of ``tls_hostname`` (``localhost``) has been
removed. If you want to continue using ``localhost``, you need to specify
it explicitly (https://github.com/ansible-collections/community.docker/pull/363).
- docker_container - the ``all`` value is no longer allowed in ``published_ports``.
Use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/399).
- docker_container - the default of ``command_handling`` was changed from ``compatibility``
to ``correct``. Older versions were warning for every invocation of the module
when this would result in a change of behavior (https://github.com/ansible-collections/community.docker/pull/399).
- docker_stack - the return values ``out`` and ``err`` have been removed. Use
``stdout`` and ``stderr`` instead (https://github.com/ansible-collections/community.docker/pull/363).
fragments:
- 271-distutils-vendor-removed.yml
- 3.0.0-a1.yml
- 363-deprecations.yml
- 398-docker-api.yml
- 399-deprecations.yml
- 400-deprecations.yml
- 401-docker_container_exec-docker-api.yml
- 402-docker-api.yml
- 403-docker-api.yml
- 404-docker-api.yml
- 405-docker-api.yml
- 406-docker-api.yml
- 407-docker-api.yml
- 408-docker-api.yml
- 409-docker-api.yml
- 410-docker-api.yml
- 411-docker-api.yml
- 412-docker-api.yml
- 413-docker-api.yml
- 414-docker-api.yml
- 415-socket-improvements.yml
release_date: '2022-07-07'

4
changelogs/fragments/271-distutils-vendor-removed.yml
View File

@ -1,4 +0,0 @@
minor_changes:
- "Remove vendored copy of ``distutils.version`` in favor of vendored copy included with ansible-core 2.12+. For ansible-core 2.11, uses ``distutils.version`` for 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)."
breaking_changes:
- "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)."

1
changelogs/fragments/3.0.0-a1.yml
View File

@ -1 +0,0 @@
release_summary: First alpha prerelease of community.docker 3.0.0. This version has several breaking changes and features rewrites of several modules to directly use the API using ``requests``, instead of using the Docker SDK for Python.

3
changelogs/fragments/363-deprecations.yml
View File

@ -1,3 +0,0 @@
removed_features:
- "docker_stack - the return values ``out`` and ``err`` have been removed. Use ``stdout`` and ``stderr`` instead (https://github.com/ansible-collections/community.docker/pull/363)."
- "Various modules - the default of ``tls_hostname`` (``localhost``) has been removed. If you want to continue using ``localhost``, you need to specify it explicitly (https://github.com/ansible-collections/community.docker/pull/363)."

5
changelogs/fragments/398-docker-api.yml
View File

@ -1,5 +0,0 @@
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)."

3
changelogs/fragments/399-deprecations.yml
View File

@ -1,3 +0,0 @@
removed_features:
- "docker_container - the default of ``command_handling`` was changed from ``compatibility`` to ``correct``. Older versions were warning for every invocation of the module when this would result in a change of behavior (https://github.com/ansible-collections/community.docker/pull/399)."
- "docker_container - the ``all`` value is no longer allowed in ``published_ports``. Use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/399)."

5
changelogs/fragments/400-deprecations.yml
View File

@ -1,5 +0,0 @@
removed_features:
- 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).
- Execution Environments built with community.docker no longer include docker-compose < 2.0.0. If you need to use it with the ``docker_compose`` module, please install that requirement manually (https://github.com/ansible-collections/community.docker/pull/400).
- Support for Python 2.6 has been removed. If you need support for Python 2.6, please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).
- Support for Docker API versions 1.20 to 1.24 has been removed. If you need support for these API versions, please use community.docker 2.x.y (https://github.com/ansible-collections/community.docker/pull/400).

4
changelogs/fragments/401-docker_container_exec-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_container_exec - 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/401)."

4
changelogs/fragments/402-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_container_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/402)."

4
changelogs/fragments/403-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_host_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/403)."

4
changelogs/fragments/404-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_image - 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/404)."

4
changelogs/fragments/405-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_image_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/405)."

4
changelogs/fragments/406-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_image_load - 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/406)."

4
changelogs/fragments/407-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_login - 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/407)."

4
changelogs/fragments/408-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_network - 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/408)."

4
changelogs/fragments/409-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_network_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/409)."

4
changelogs/fragments/410-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_prune - 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/410)."

4
changelogs/fragments/411-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "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)."

4
changelogs/fragments/412-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "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)."

4
changelogs/fragments/413-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_containers inventory plugin - 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/413)."

4
changelogs/fragments/414-docker-api.yml
View File

@ -1,4 +0,0 @@
major_changes:
- "docker_api connection plugin - 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/414)."

2
changelogs/fragments/415-socket-improvements.yml
View File

@ -1,2 +0,0 @@
minor_changes:
- "socker_handler and socket_helper module utils - improve Python forward compatibilty, create helper functions for file blocking/unblocking (https://github.com/ansible-collections/community.docker/pull/415)."