From 0e3d7d4802a132ad4d57ff5834cf0bece359cc81 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 15 Jul 2022 19:28:10 +0200 Subject: [PATCH] Release 3.0.0-a2. --- CHANGELOG.rst | 38 ++++++++++++ changelogs/changelog.yaml | 60 +++++++++++++++++++ changelogs/fragments/3.0.0-a2.yml | 8 --- .../426-docker_container-platform.yml | 2 - .../427-docker_container-cgroupns_mode.yml | 2 - .../428-docker_container-image-ignore.yml | 2 - changelogs/fragments/429-docker_plugin.yml | 4 -- changelogs/fragments/docker_container.yml | 11 ---- 8 files changed, 98 insertions(+), 29 deletions(-) delete mode 100644 changelogs/fragments/3.0.0-a2.yml delete mode 100644 changelogs/fragments/426-docker_container-platform.yml delete mode 100644 changelogs/fragments/427-docker_container-cgroupns_mode.yml delete mode 100644 changelogs/fragments/428-docker_container-image-ignore.yml delete mode 100644 changelogs/fragments/429-docker_plugin.yml delete mode 100644 changelogs/fragments/docker_container.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1d2edac5..b7d7d701 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,44 @@ Docker Community Collection Release Notes .. contents:: Topics +v3.0.0-a2 +========= + +Release Summary +--------------- + +Second alpha prerelease of community.docker 3.0.0. This version again 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. + +The largest change to the previous 3.0.0-a1 prerelease is that ``docker_container`` module has been +rewritten. It now also no longer needs the Docker SDK for Python, which allowed to implement some new +features that were not available before (``platform`` and ``cgroupns_mode`` parameters). + + +Major Changes +------------- + +- docker_container - 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/422). +- docker_container - the module was completely rewritten from scratch (https://github.com/ansible-collections/community.docker/pull/422). +- docker_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/429). + +Minor Changes +------------- + +- docker_container - add a new parameter ``image_comparison`` to control the behavior for which image will be used for idempotency checks (https://github.com/ansible-collections/community.docker/issues/421, https://github.com/ansible-collections/community.docker/pull/428). +- docker_container - add support for ``cgroupns_mode`` (https://github.com/ansible-collections/community.docker/issues/338, https://github.com/ansible-collections/community.docker/pull/427). +- docker_container - allow to specify ``platform`` (https://github.com/ansible-collections/community.docker/issues/123, https://github.com/ansible-collections/community.docker/pull/426). + +Breaking Changes / Porting Guide +-------------------------------- + +- docker_container - ``exposed_ports`` is no longer ignored in ``comparisons``. Before, its value was assumed to be identical with the value of ``published_ports`` (https://github.com/ansible-collections/community.docker/pull/422). +- docker_container - ``log_options`` can no longer be specified when ``log_driver`` is not specified (https://github.com/ansible-collections/community.docker/pull/422). +- docker_container - ``publish_all_ports`` is no longer ignored in ``comparisons`` (https://github.com/ansible-collections/community.docker/pull/422). +- docker_container - ``restart_retries`` can no longer be specified when ``restart_policy`` is not specified (https://github.com/ansible-collections/community.docker/pull/422). +- docker_container - ``stop_timeout`` is no longer ignored for idempotency if told to be not ignored in ``comparisons``. So far it defaulted to ``ignore`` there, and setting it to ``strict`` had no effect (https://github.com/ansible-collections/community.docker/pull/422). + v3.0.0-a1 ========= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 254fbe70..5fda0b9d 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -820,3 +820,63 @@ releases: - 414-docker-api.yml - 415-socket-improvements.yml release_date: '2022-07-07' + 3.0.0-a2: + changes: + breaking_changes: + - docker_container - ``exposed_ports`` is no longer ignored in ``comparisons``. + Before, its value was assumed to be identical with the value of ``published_ports`` + (https://github.com/ansible-collections/community.docker/pull/422). + - docker_container - ``log_options`` can no longer be specified when ``log_driver`` + is not specified (https://github.com/ansible-collections/community.docker/pull/422). + - docker_container - ``publish_all_ports`` is no longer ignored in ``comparisons`` + (https://github.com/ansible-collections/community.docker/pull/422). + - docker_container - ``restart_retries`` can no longer be specified when ``restart_policy`` + is not specified (https://github.com/ansible-collections/community.docker/pull/422). + - docker_container - ``stop_timeout`` is no longer ignored for idempotency if + told to be not ignored in ``comparisons``. So far it defaulted to ``ignore`` + there, and setting it to ``strict`` had no effect (https://github.com/ansible-collections/community.docker/pull/422). + major_changes: + - docker_container - 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/422). + - docker_container - the module was completely rewritten from scratch (https://github.com/ansible-collections/community.docker/pull/422). + - docker_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/429). + minor_changes: + - docker_container - add a new parameter ``image_comparison`` to control the + behavior for which image will be used for idempotency checks (https://github.com/ansible-collections/community.docker/issues/421, + https://github.com/ansible-collections/community.docker/pull/428). + - docker_container - add support for ``cgroupns_mode`` (https://github.com/ansible-collections/community.docker/issues/338, + https://github.com/ansible-collections/community.docker/pull/427). + - docker_container - allow to specify ``platform`` (https://github.com/ansible-collections/community.docker/issues/123, + https://github.com/ansible-collections/community.docker/pull/426). + release_summary: 'Second alpha prerelease of community.docker 3.0.0. This version + again 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. + + + The largest change to the previous 3.0.0-a1 prerelease is that ``docker_container`` + module has been + + rewritten. It now also no longer needs the Docker SDK for Python, which allowed + to implement some new + + features that were not available before (``platform`` and ``cgroupns_mode`` + parameters). + + ' + fragments: + - 3.0.0-a2.yml + - 426-docker_container-platform.yml + - 427-docker_container-cgroupns_mode.yml + - 428-docker_container-image-ignore.yml + - 429-docker_plugin.yml + - docker_container.yml + release_date: '2022-07-15' diff --git a/changelogs/fragments/3.0.0-a2.yml b/changelogs/fragments/3.0.0-a2.yml deleted file mode 100644 index f1d50c88..00000000 --- a/changelogs/fragments/3.0.0-a2.yml +++ /dev/null @@ -1,8 +0,0 @@ -release_summary: | - Second alpha prerelease of community.docker 3.0.0. This version again 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. - - The largest change to the previous 3.0.0-a1 prerelease is that ``docker_container`` module has been - rewritten. It now also no longer needs the Docker SDK for Python, which allowed to implement some new - features that were not available before (``platform`` and ``cgroupns_mode`` parameters). diff --git a/changelogs/fragments/426-docker_container-platform.yml b/changelogs/fragments/426-docker_container-platform.yml deleted file mode 100644 index 9b79a050..00000000 --- a/changelogs/fragments/426-docker_container-platform.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "docker_container - allow to specify ``platform`` (https://github.com/ansible-collections/community.docker/issues/123, https://github.com/ansible-collections/community.docker/pull/426)." diff --git a/changelogs/fragments/427-docker_container-cgroupns_mode.yml b/changelogs/fragments/427-docker_container-cgroupns_mode.yml deleted file mode 100644 index ddec7e47..00000000 --- a/changelogs/fragments/427-docker_container-cgroupns_mode.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "docker_container - add support for ``cgroupns_mode`` (https://github.com/ansible-collections/community.docker/issues/338, https://github.com/ansible-collections/community.docker/pull/427)." diff --git a/changelogs/fragments/428-docker_container-image-ignore.yml b/changelogs/fragments/428-docker_container-image-ignore.yml deleted file mode 100644 index 02c6dfc1..00000000 --- a/changelogs/fragments/428-docker_container-image-ignore.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "docker_container - add a new parameter ``image_comparison`` to control the behavior for which image will be used for idempotency checks (https://github.com/ansible-collections/community.docker/issues/421, https://github.com/ansible-collections/community.docker/pull/428)." diff --git a/changelogs/fragments/429-docker_plugin.yml b/changelogs/fragments/429-docker_plugin.yml deleted file mode 100644 index 50c0ff90..00000000 --- a/changelogs/fragments/429-docker_plugin.yml +++ /dev/null @@ -1,4 +0,0 @@ -major_changes: - - docker_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/429). diff --git a/changelogs/fragments/docker_container.yml b/changelogs/fragments/docker_container.yml deleted file mode 100644 index 085f2b06..00000000 --- a/changelogs/fragments/docker_container.yml +++ /dev/null @@ -1,11 +0,0 @@ -major_changes: - - "docker_container - 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/422)." - - "docker_container - the module was completely rewritten from scratch (https://github.com/ansible-collections/community.docker/pull/422)." -breaking_changes: - - "docker_container - ``publish_all_ports`` is no longer ignored in ``comparisons`` (https://github.com/ansible-collections/community.docker/pull/422)." - - "docker_container - ``exposed_ports`` is no longer ignored in ``comparisons``. Before, its value was assumed to be identical with the value of ``published_ports`` (https://github.com/ansible-collections/community.docker/pull/422)." - - "docker_container - ``log_options`` can no longer be specified when ``log_driver`` is not specified (https://github.com/ansible-collections/community.docker/pull/422)." - - "docker_container - ``restart_retries`` can no longer be specified when ``restart_policy`` is not specified (https://github.com/ansible-collections/community.docker/pull/422)." - - "docker_container - ``stop_timeout`` is no longer ignored for idempotency if told to be not ignored in ``comparisons``. So far it defaulted to ``ignore`` there, and setting it to ``strict`` had no effect (https://github.com/ansible-collections/community.docker/pull/422)."