From f22ffcab184680f8a407c9b2b199ba6235ac1d27 Mon Sep 17 00:00:00 2001 From: Bikouo Aubin <79859644+abikouo@users.noreply.github.com> Date: Tue, 28 May 2024 11:37:32 +0200 Subject: [PATCH] Prepare release 4.0.0 (#727) * Prepare release 4.0.0 * update documentation --- CHANGELOG.rst | 33 +++++++++++++++ Makefile | 2 +- README.md | 2 +- changelogs/changelog.yaml | 42 +++++++++++++++++++ ...06-fix-unsafe-condition-in-integration.yml | 3 -- ...40117-fix-helm-diff-cmd-line-rendering.yml | 4 -- ...ails-when-complex-subresources-present.yml | 3 -- ...240228-fix-helm-diff-with-reuse-values.yml | 3 -- ...20240423-k8s-display-warnings-to-users.yml | 3 -- .../inventory-update_removal_date.yml | 2 - .../fragments/k8s-merge_type-removed.yml | 2 - ...remove-deprecated-functions-and-class.yaml | 6 --- docs/kubernetes.core.k8s_inventory.rst | 4 +- docs/kubernetes.core.k8s_module.rst | 9 ++-- galaxy.yml | 2 +- 15 files changed, 84 insertions(+), 36 deletions(-) delete mode 100644 changelogs/fragments/20231206-fix-unsafe-condition-in-integration.yml delete mode 100644 changelogs/fragments/20240117-fix-helm-diff-cmd-line-rendering.yml delete mode 100644 changelogs/fragments/20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml delete mode 100644 changelogs/fragments/20240228-fix-helm-diff-with-reuse-values.yml delete mode 100644 changelogs/fragments/20240423-k8s-display-warnings-to-users.yml delete mode 100644 changelogs/fragments/inventory-update_removal_date.yml delete mode 100644 changelogs/fragments/k8s-merge_type-removed.yml delete mode 100644 changelogs/fragments/module_utils-common-remove-deprecated-functions-and-class.yaml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f93c131fc0..d81cb383cc 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,39 @@ Kubernetes Collection Release Notes .. contents:: Topics +v4.0.0 +====== + +Release Summary +--------------- + +This major release brings several bug fixes. We have also removed support for ``ansible-core<2.15`` and deprecated functions and class from ``module_utils/common.py``. + +Minor Changes +------------- + +- inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723). +- k8s - The module and K8sService were changed so warnings returned by the K8S API are now displayed to the user. + +Removed Features (previously deprecated) +---------------------------------------- + +- k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/ansible-collections/kubernetes.core/pull/722). +- k8s_exec - the previously deprecated ``result.return_code`` return value has been removed, consider using ``result.rc`` instead (https://github.com/ansible-collections/kubernetes.core/pull/726). +- module_utils/common.py - the previously deprecated ``K8sAnsibleMixin`` class has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). +- module_utils/common.py - the previously deprecated ``configuration_digest()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). +- module_utils/common.py - the previously deprecated ``get_api_client()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). +- module_utils/common.py - the previously deprecated ``unique_string()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). + +Bugfixes +-------- + +- Resolve Collections util resource discovery fails when complex subresources present (https://github.com/ansible-collections/kubernetes.core/pull/676). +- align `helmdiff_check()` function commandline rendering with the `deploy()` function (https://github.com/ansible-collections/kubernetes.core/pull/670). +- avoid unsafe conditions in integration tests (https://github.com/ansible-collections/kubernetes.core/pull/665). +- helm - use ``reuse-values`` when running ``helm diff`` command (https://github.com/ansible-collections/kubernetes.core/issues/680). +- integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670). + v3.1.0 ====== diff --git a/Makefile b/Makefile index b76f3af502..cacb698f5d 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # Also needs to be updated in galaxy.yml -VERSION = 3.0.0 +VERSION = 4.0.0 TEST_ARGS ?= "" PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'` diff --git a/README.md b/README.md index 67993a06e0..675eb11df9 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible --- collections: - name: kubernetes.core - version: 3.0.0 + version: 4.0.0 ``` ### Installing the Kubernetes Python Library diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index a6a689887c..829bb72457 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -854,3 +854,45 @@ releases: - 652-fix-json-patch-action.yml - 654-helm-expand-user.yml release_date: '2024-05-16' + 4.0.0: + changes: + bugfixes: + - Resolve Collections util resource discovery fails when complex subresources + present (https://github.com/ansible-collections/kubernetes.core/pull/676). + - align `helmdiff_check()` function commandline rendering with the `deploy()` + function (https://github.com/ansible-collections/kubernetes.core/pull/670). + - avoid unsafe conditions in integration tests (https://github.com/ansible-collections/kubernetes.core/pull/665). + - helm - use ``reuse-values`` when running ``helm diff`` command (https://github.com/ansible-collections/kubernetes.core/issues/680). + - integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability + with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670). + minor_changes: + - inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723). + - k8s - The module and K8sService were changed so warnings returned by the K8S + API are now displayed to the user. + release_summary: This major release brings several bug fixes. We have also removed + support for ``ansible-core<2.15`` and deprecated functions and class from + ``module_utils/common.py``. + removed_features: + - k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please + use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/ansible-collections/kubernetes.core/pull/722). + - k8s_exec - the previously deprecated ``result.return_code`` return value has + been removed, consider using ``result.rc`` instead (https://github.com/ansible-collections/kubernetes.core/pull/726). + - module_utils/common.py - the previously deprecated ``K8sAnsibleMixin`` class + has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). + - module_utils/common.py - the previously deprecated ``configuration_digest()`` + function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). + - module_utils/common.py - the previously deprecated ``get_api_client()`` function + has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). + - module_utils/common.py - the previously deprecated ``unique_string()`` function + has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). + fragments: + - 20231206-fix-unsafe-condition-in-integration.yml + - 20240117-fix-helm-diff-cmd-line-rendering.yml + - 20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml + - 20240228-fix-helm-diff-with-reuse-values.yml + - 20240423-k8s-display-warnings-to-users.yml + - 4.0.0.yaml + - inventory-update_removal_date.yml + - k8s-merge_type-removed.yml + - module_utils-common-remove-deprecated-functions-and-class.yaml + release_date: '2024-05-24' diff --git a/changelogs/fragments/20231206-fix-unsafe-condition-in-integration.yml b/changelogs/fragments/20231206-fix-unsafe-condition-in-integration.yml deleted file mode 100644 index 921be77efd..0000000000 --- a/changelogs/fragments/20231206-fix-unsafe-condition-in-integration.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - avoid unsafe conditions in integration tests (https://github.com/ansible-collections/kubernetes.core/pull/665). diff --git a/changelogs/fragments/20240117-fix-helm-diff-cmd-line-rendering.yml b/changelogs/fragments/20240117-fix-helm-diff-cmd-line-rendering.yml deleted file mode 100644 index 14ed55798c..0000000000 --- a/changelogs/fragments/20240117-fix-helm-diff-cmd-line-rendering.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -bugfixes: - - align `helmdiff_check()` function commandline rendering with the `deploy()` function (https://github.com/ansible-collections/kubernetes.core/pull/670). - - integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670). diff --git a/changelogs/fragments/20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml b/changelogs/fragments/20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml deleted file mode 100644 index d422127aa2..0000000000 --- a/changelogs/fragments/20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - Resolve Collections util resource discovery fails when complex subresources present (https://github.com/ansible-collections/kubernetes.core/pull/676). diff --git a/changelogs/fragments/20240228-fix-helm-diff-with-reuse-values.yml b/changelogs/fragments/20240228-fix-helm-diff-with-reuse-values.yml deleted file mode 100644 index b38c103c35..0000000000 --- a/changelogs/fragments/20240228-fix-helm-diff-with-reuse-values.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - helm - use ``reuse-values`` when running ``helm diff`` command (https://github.com/ansible-collections/kubernetes.core/issues/680). diff --git a/changelogs/fragments/20240423-k8s-display-warnings-to-users.yml b/changelogs/fragments/20240423-k8s-display-warnings-to-users.yml deleted file mode 100644 index 60d066eb21..0000000000 --- a/changelogs/fragments/20240423-k8s-display-warnings-to-users.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - k8s - The module and K8sService were changed so warnings returned by the K8S API are now displayed to the user. diff --git a/changelogs/fragments/inventory-update_removal_date.yml b/changelogs/fragments/inventory-update_removal_date.yml deleted file mode 100644 index 3ef687d5ef..0000000000 --- a/changelogs/fragments/inventory-update_removal_date.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723). diff --git a/changelogs/fragments/k8s-merge_type-removed.yml b/changelogs/fragments/k8s-merge_type-removed.yml deleted file mode 100644 index 05bf8d7be8..0000000000 --- a/changelogs/fragments/k8s-merge_type-removed.yml +++ /dev/null @@ -1,2 +0,0 @@ -removed_features: - - k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/ansible-collections/kubernetes.core/pull/722). diff --git a/changelogs/fragments/module_utils-common-remove-deprecated-functions-and-class.yaml b/changelogs/fragments/module_utils-common-remove-deprecated-functions-and-class.yaml deleted file mode 100644 index 81ff6e86be..0000000000 --- a/changelogs/fragments/module_utils-common-remove-deprecated-functions-and-class.yaml +++ /dev/null @@ -1,6 +0,0 @@ -removed_features: - - k8s_exec - the previously deprecated ``result.return_code`` return value has been removed, consider using ``result.rc`` instead (https://github.com/ansible-collections/kubernetes.core/pull/726). - - module_utils/common.py - the previously deprecated ``K8sAnsibleMixin`` class has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). - - module_utils/common.py - the previously deprecated ``configuration_digest()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). - - module_utils/common.py - the previously deprecated ``get_api_client()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). - - module_utils/common.py - the previously deprecated ``unique_string()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726). diff --git a/docs/kubernetes.core.k8s_inventory.rst b/docs/kubernetes.core.k8s_inventory.rst index 7a8cfd62a4..b9299b82a8 100644 --- a/docs/kubernetes.core.k8s_inventory.rst +++ b/docs/kubernetes.core.k8s_inventory.rst @@ -17,7 +17,7 @@ DEPRECATED ---------- :Removed in collection release after :Why: As discussed in https://github.com/ansible-collections/kubernetes.core/issues/31, we decided to -remove the k8s inventory plugin in release 4.0.0. +remove the k8s inventory plugin in release 5.0.0. :Alternative: Use :ref:`kubernetes.core.k8s_info ` and :ref:`ansible.builtin.add_host ` instead. @@ -357,7 +357,7 @@ Status ------ -- This inventory will be removed in version 4.0.0. *[deprecated]* +- This inventory will be removed in version 5.0.0. *[deprecated]* - For more information see `DEPRECATED`_. diff --git a/docs/kubernetes.core.k8s_module.rst b/docs/kubernetes.core.k8s_module.rst index d4f9d23c05..9b2e14bb21 100644 --- a/docs/kubernetes.core.k8s_module.rst +++ b/docs/kubernetes.core.k8s_module.rst @@ -121,7 +121,7 @@ Parameters
apply compares the desired resource definition with the previously supplied resource definition, ignoring properties that are automatically generated
apply works better with Services than 'force=yes'
-
mutually exclusive with merge_type
+
Mutually exclusive with merge_type.
@@ -513,18 +513,17 @@ Parameters
Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used.
-
For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may want to use merge if you see "strategic merge patch format is not supported"
+
For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may want to use merge if you see "strategic merge patch format is not supported".
See https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment
If more than one merge_type is given, the merge_types will be tried in order. This defaults to ['strategic-merge', 'merge'], which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources.
-
mutually exclusive with apply
-
merge_type=json is deprecated and will be removed in version 4.0.0. Please use kubernetes.core.k8s_json_patch instead.
+
Mutually exclusive with apply.
+
merge_type=json has been removed in version 4.0.0. Please use kubernetes.core.k8s_json_patch instead.
diff --git a/galaxy.yml b/galaxy.yml index a15f723ed8..1f6f4e53cd 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -25,7 +25,7 @@ tags: - openshift - okd - cluster -version: 3.1.0 +version: 4.0.0 build_ignore: - .DS_Store - "*.tar.gz"