diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 100f802e..86589b22 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,38 @@ Kubernetes Collection Release Notes .. contents:: Topics +v5.5.0 +====== + +Release Summary +--------------- + +This minor release deprecates Ansible Turbo mode (``ENABLE_TURBO_MODE``), the ``status.values`` return value of the ``helm`` and ``helm_info`` modules, the ``wait_timeout`` parameter of the ``helm`` module, the ``return_code`` return value of the ``k8s_exec`` module, and the ``merge_type=json`` option of the ``k8s_service`` module. It also includes bugfixes for ``helm_repository`` URL comparison and for empty template output handling in ``k8s_info``. + +Minor Changes +------------- + +- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197). +- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common`` collection is not installed, instead of silently falling back to the standard lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242). + +Deprecated Features +------------------- + +- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be removed in release 8.0.0, as it depends on the ``cloud.common`` collection, which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242). +- helm - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). +- helm - the ``wait_timeout`` parameter has been deprecated and will be removed in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). +- helm_info - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). +- k8s_exec - the ``return_code`` return value has been deprecated and will be removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). +- k8s_service - the ``merge_type=json`` option has been deprecated and will be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). + +Bugfixes +-------- + +- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported, and fall back to the standard ``AnsibleModule`` instead of failing with ``byte indices must be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242). +- helm_repository - normalize both sides of the repository URL comparison, so that a repository already registered with a trailing slash is recognized as matching instead of failing with ``Repository already have a repository named `` (https://github.com/ansible-collections/kubernetes.core/pull/1236). +- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported. Fall back to the standard ``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253). +- k8s_info - Handle empty template output gracefully by returning ``changed=false`` instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042). + v5.4.4 ====== @@ -30,7 +62,7 @@ Bugfixes - ee - Add ``meta/execution-environment.yml`` to decouple ansible-builder EE builds from the ``openshift-clients`` system dependency declared in ``bindep.txt``, which is not available in standard UBI repositories and caused builds to fail with ``No package matches 'openshift-clients'`` (https://github.com/ansible-collections/kubernetes.core/issues/1141). - helm_repository - Correct handling of repository URLs with trailing slashes (https://github.com/ansible-collections/kubernetes.core/pull/1121). -- k8s_drain - Fix logic for handling pods with local storage to correctly check for ``empty_dir`` volumes in replicated pods and pods managed by DaemonSets (https://github.com/ansible-collections/kubernetes.core/pull/1095). +- k8s_drain - Fix logic for handling pods with local storage to correctly check for empty_dir volumes in replicated pods and pods managed by DaemonSets (https://github.com/ansible-collections/kubernetes.core/pull/1095). v5.4.2 ====== @@ -38,7 +70,7 @@ v5.4.2 Release Summary --------------- -This release includes bugfixes such as replacing the passing of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a security update for selectively redacting sensitive information from kubeconfig. +This release includes bugfixes such as replacing the passing of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a security update for selectively redacting sensitive information from kubeconfig, and adds a new ``release_values`` key to the ``status`` return value. Minor Changes ------------- diff --git a/Makefile b/Makefile index 14933e91..23281b2a 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # Also needs to be updated in galaxy.yml -VERSION = 5.4.4 +VERSION = 5.5.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 b1dc6828..17605056 100644 --- a/README.md +++ b/README.md @@ -19,62 +19,60 @@ The collection includes a variety of Ansible content to help automate the manage Click on the name of a plugin or module to view that content's documentation: -### Connection Plugins +### Connection plugins Name | Description --- | --- -[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes. +[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes. -### K8s filter Plugins +### K8s filter plugins Name | Description --- | --- kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret -### Inventory Plugins +### Inventory plugins Name | Description --- | --- -[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source +[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source -### Lookup Plugins +### Lookup plugins Name | Description --- | --- -[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API -[kubernetes.core.kustomize](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kustomize_lookup.rst)|Build a set of kubernetes resources using a 'kustomization.yaml' file. +[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API +[kubernetes.core.kustomize](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.kustomize_lookup.rst)|Build a set of kubernetes resources using a 'kustomization.yaml' file. ### Modules Name | Description --- | --- -[kubernetes.core.helm](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager -[kubernetes.core.helm_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_info_module.rst)|Get information from Helm package deployed inside the cluster -[kubernetes.core.helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins -[kubernetes.core.helm_plugin_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_info_module.rst)|Gather information about Helm plugins -[kubernetes.core.helm_pull](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_pull_module.rst)|download a chart from a repository and (optionally) unpack it in local directory. -[kubernetes.core.helm_registry_auth](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_registry_auth_module.rst)|Helm registry authentication module -[kubernetes.core.helm_repository](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories. -[kubernetes.core.helm_template](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_template_module.rst)|Render chart templates -[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects -[kubernetes.core.k8s_cluster_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_cluster_info_module.rst)|Describe Kubernetes (K8s) cluster, APIs available and their respective versions -[kubernetes.core.k8s_cp](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_cp_module.rst)|Copy files and directories to and from pod. -[kubernetes.core.k8s_drain](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_drain_module.rst)|Drain, Cordon, or Uncordon node in k8s cluster -[kubernetes.core.k8s_exec](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod -[kubernetes.core.k8s_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects -[kubernetes.core.k8s_json_patch](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_json_patch_module.rst)|Apply JSON patch operations to existing objects -[kubernetes.core.k8s_log](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_log_module.rst)|Fetch logs from Kubernetes resources -[kubernetes.core.k8s_rollback](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_rollback_module.rst)|Rollback Kubernetes (K8S) Deployments and DaemonSets -[kubernetes.core.k8s_scale](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_scale_module.rst)|Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. -[kubernetes.core.k8s_service](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes -[kubernetes.core.k8s_taint](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_taint_module.rst)|Taint a node in a Kubernetes/OpenShift cluster +[kubernetes.core.helm](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager +[kubernetes.core.helm_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_info_module.rst)|Get information from Helm package deployed inside the cluster +[kubernetes.core.helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins +[kubernetes.core.helm_plugin_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_plugin_info_module.rst)|Gather information about Helm plugins +[kubernetes.core.helm_pull](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_pull_module.rst)|download a chart from a repository and (optionally) unpack it in local directory. +[kubernetes.core.helm_registry_auth](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_registry_auth_module.rst)|Helm registry authentication module +[kubernetes.core.helm_repository](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories. +[kubernetes.core.helm_template](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.helm_template_module.rst)|Render chart templates +[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects +[kubernetes.core.k8s_cluster_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_cluster_info_module.rst)|Describe Kubernetes (K8s) cluster, APIs available and their respective versions +[kubernetes.core.k8s_cp](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_cp_module.rst)|Copy files and directories to and from pod. +[kubernetes.core.k8s_drain](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_drain_module.rst)|Drain, Cordon, or Uncordon node in k8s cluster +[kubernetes.core.k8s_exec](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod +[kubernetes.core.k8s_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects +[kubernetes.core.k8s_json_patch](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_json_patch_module.rst)|Apply JSON patch operations to existing objects +[kubernetes.core.k8s_log](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_log_module.rst)|Fetch logs from Kubernetes resources +[kubernetes.core.k8s_rollback](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_rollback_module.rst)|Rollback Kubernetes (K8S) Deployments and DaemonSets +[kubernetes.core.k8s_scale](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_scale_module.rst)|Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. +[kubernetes.core.k8s_service](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes +[kubernetes.core.k8s_taint](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/kubernetes.core.k8s_taint_module.rst)|Taint a node in a Kubernetes/OpenShift cluster ## Requirements -### Ansible version compatibility +## Ansible version compatibility This collection has been tested against the following Ansible versions: **>=2.16.0**. -For collections that support Ansible 2.9, please ensure you update your `network_os` to use the -fully qualified collection name (for example, `cisco.ios.ios`). Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible. @@ -106,7 +104,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible --- collections: - name: kubernetes.core - version: 5.4.4 + version: 5.5.0 ``` ### Installing the Kubernetes Python Library @@ -205,7 +203,7 @@ The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview To enable Turbo mode for k8s lookup plugin, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. This is not working when defined in the playbook using `environment` keyword as above, you must set it using `export ENABLE_TURBO_MODE=1`. -Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst). +Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/stable-5/docs/ansible_turbo_mode.rst). ## Testing diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 1451c499..14545129 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1097,13 +1097,14 @@ releases: be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056). minor_changes: - - helm - Add ``release_values`` key to ``status`` return value that can be - accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056). + - helm - Add ``release_values`` key to ``status`` return value that can be accessed + using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056). - helm_info - Add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056). - release_summary: This release includes bugfixes such as replacing the passing of ``warnings`` to ``exit_json`` - with ``AnsibleModule.warn`` as well as a security update for selectively redacting sensitive information - from kubeconfig, and adds a new ``release_values`` key to the ``status`` return value. + release_summary: This release includes bugfixes such as replacing the passing + of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a + security update for selectively redacting sensitive information from kubeconfig, + and adds a new ``release_values`` key to the ``status`` return value. security_fixes: - Selectively redact sensitive info from kubeconfig instead of applying blanket ``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014). @@ -1140,6 +1141,62 @@ releases: 5.4.4: changes: bugfixes: - - meta - Update ``requires_ansible`` in ``runtime.yml`` and README to ``>=2.16.0`` to match the actual minimum supported ``ansible-core`` version (https://github.com/ansible-collections/kubernetes.core/pull/1193). - release_summary: This release corrects the documented and enforced minimum ``ansible-core`` version to ``>=2.16.0``. + - meta - Update ``requires_ansible`` in ``runtime.yml`` and README to ``>=2.16.0`` + to match the actual minimum supported ``ansible-core`` version (https://github.com/ansible-collections/kubernetes.core/pull/1193). + release_summary: This release corrects the documented and enforced minimum ``ansible-core`` + version to ``>=2.16.0``. release_date: '2026-07-09' + 5.5.0: + changes: + bugfixes: + - Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and + later, where the ``cloud.common`` collection is not supported, and fall back + to the standard ``AnsibleModule`` instead of failing with ``byte indices must + be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242). + - helm_repository - normalize both sides of the repository URL comparison, so + that a repository already registered with a trailing slash is recognized as + matching instead of failing with ``Repository already have a repository named + `` (https://github.com/ansible-collections/kubernetes.core/pull/1236). + - k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, + where the ``cloud.common`` collection is not supported. Fall back to the standard + ``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253). + - k8s_info - Handle empty template output gracefully by returning ``changed=false`` + instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042). + deprecated_features: + - Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be + removed in release 8.0.0, as it depends on the ``cloud.common`` collection, + which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242). + - helm - the ``status.values`` return value has been deprecated and will be + removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). + - helm - the ``wait_timeout`` parameter has been deprecated and will be removed + in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). + - helm_info - the ``status.values`` return value has been deprecated and will + be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). + - k8s_exec - the ``return_code`` return value has been deprecated and will be + removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). + - k8s_service - the ``merge_type=json`` option has been deprecated and will + be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module + instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). + minor_changes: + - Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation + warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197). + - k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common`` + collection is not installed, instead of silently falling back to the standard + lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242). + release_summary: This minor release deprecates Ansible Turbo mode (``ENABLE_TURBO_MODE``), + the ``status.values`` return value of the ``helm`` and ``helm_info`` modules, + the ``wait_timeout`` parameter of the ``helm`` module, the ``return_code`` + return value of the ``k8s_exec`` module, and the ``merge_type=json`` option + of the ``k8s_service`` module. It also includes bugfixes for ``helm_repository`` + URL comparison and for empty template output handling in ``k8s_info``. + fragments: + - 1253-k8s-lookup-turbo-version-check.yml + - 20250108-fix-empty-template-output.yaml + - 20260723-remove-module-utils-six.yaml + - 20260908-helm-repository-trailing-slash.yaml + - 20260911-deprecate-status-values.yaml + - 20260911-update-deprecation-notices.yaml + - 5.5.0.yml + - deprecate-enable-turbo-mode.yml + - fix-ansible-lint-warnings.yaml + release_date: '2026-09-15' diff --git a/changelogs/fragments/1253-k8s-lookup-turbo-version-check.yml b/changelogs/fragments/1253-k8s-lookup-turbo-version-check.yml deleted file mode 100644 index 1bea8754..00000000 --- a/changelogs/fragments/1253-k8s-lookup-turbo-version-check.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -bugfixes: - - k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported. - Fall back to the standard ``LookupBase`` instead of failing with a traceback - (https://github.com/ansible-collections/kubernetes.core/pull/1253). diff --git a/changelogs/fragments/20250108-fix-empty-template-output.yaml b/changelogs/fragments/20250108-fix-empty-template-output.yaml deleted file mode 100644 index 5582ad47..00000000 --- a/changelogs/fragments/20250108-fix-empty-template-output.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- k8s_info - Handle empty template output gracefully by returning ``changed=false`` instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042). diff --git a/changelogs/fragments/20260723-remove-module-utils-six.yaml b/changelogs/fragments/20260723-remove-module-utils-six.yaml deleted file mode 100644 index bdbe2187..00000000 --- a/changelogs/fragments/20260723-remove-module-utils-six.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -minor_changes: - - Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation - warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197). diff --git a/changelogs/fragments/20260908-helm-repository-trailing-slash.yaml b/changelogs/fragments/20260908-helm-repository-trailing-slash.yaml deleted file mode 100644 index 732b9cc6..00000000 --- a/changelogs/fragments/20260908-helm-repository-trailing-slash.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - helm_repository - normalize both sides of the repository URL comparison, so that a repository already registered with a trailing slash is recognized as matching instead of failing with ``Repository already have a repository named `` (https://github.com/ansible-collections/kubernetes.core/pull/1236). diff --git a/changelogs/fragments/20260911-deprecate-status-values.yaml b/changelogs/fragments/20260911-deprecate-status-values.yaml deleted file mode 100644 index 430ee711..00000000 --- a/changelogs/fragments/20260911-deprecate-status-values.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -deprecated_features: - - helm - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. - Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). - - helm_info - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. - Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). diff --git a/changelogs/fragments/20260911-update-deprecation-notices.yaml b/changelogs/fragments/20260911-update-deprecation-notices.yaml deleted file mode 100644 index 96c86c77..00000000 --- a/changelogs/fragments/20260911-update-deprecation-notices.yaml +++ /dev/null @@ -1,8 +0,0 @@ ---- -deprecated_features: - - helm - the ``wait_timeout`` parameter has been deprecated and will be removed in version 7.0.0. - Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). - - k8s_exec - the ``return_code`` return value has been deprecated and will be removed in version 7.0.0. - Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). - - k8s_service - the ``merge_type=json`` option has been deprecated and will be removed in version 7.0.0. - Use ``kubernetes.core.k8s_json_patch`` module instead (https://github.com/ansible-collections/kubernetes.core/issues/1239). diff --git a/changelogs/fragments/deprecate-enable-turbo-mode.yml b/changelogs/fragments/deprecate-enable-turbo-mode.yml deleted file mode 100644 index d25854cc..00000000 --- a/changelogs/fragments/deprecate-enable-turbo-mode.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -deprecated_features: - - Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be removed in release 8.0.0, as it depends on the ``cloud.common`` collection, which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242). -bugfixes: - - Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported, and fall back to the standard ``AnsibleModule`` instead of failing with ``byte indices must be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242). -minor_changes: - - k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common`` collection is not installed, instead of silently falling back to the standard lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242). diff --git a/changelogs/fragments/fix-ansible-lint-warnings.yaml b/changelogs/fragments/fix-ansible-lint-warnings.yaml deleted file mode 100644 index 19a0f0e3..00000000 --- a/changelogs/fragments/fix-ansible-lint-warnings.yaml +++ /dev/null @@ -1,3 +0,0 @@ -trivial: - - "kubectl connection plugin - added ``changed_when: false`` to example ``ansible.builtin.command`` tasks to resolve ansible-lint ``no-changed-when`` warnings." - - "ee - added ``version: 3`` to ``meta/execution-environment.yml`` to resolve ansible-lint ``schema[execution-environment]`` warning." diff --git a/docs/kubernetes.core.helm_info_module.rst b/docs/kubernetes.core.helm_info_module.rst index 4b5ef7c0..32c04a33 100644 --- a/docs/kubernetes.core.helm_info_module.rst +++ b/docs/kubernetes.core.helm_info_module.rst @@ -268,7 +268,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html @@ -410,6 +410,23 @@ Common return values are documented `here + +   + +
+ release_values + +
+ dictionary +
+
added in 6.3.0
+ + always + +
Dict of Values used to deploy.
+
+ +   @@ -465,12 +482,13 @@ Common return values are documented `here values
- string + dictionary
always
Dict of Values used to deploy
+
This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.

diff --git a/docs/kubernetes.core.helm_module.rst b/docs/kubernetes.core.helm_module.rst index e7df00d3..64f9ce6c 100644 --- a/docs/kubernetes.core.helm_module.rst +++ b/docs/kubernetes.core.helm_module.rst @@ -713,7 +713,7 @@ Parameters
Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).
-
The use of wait_timeout to wait for kubernetes commands to complete has been deprecated and will be removed after 2022-12-01.
+
The use of wait_timeout to wait for kubernetes commands to complete has been deprecated and will be removed in version 7.0.0. Use O(timeout) instead.
@@ -851,7 +851,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html @@ -957,6 +957,23 @@ Common return values are documented `here + +   + +
+ release_values + +
+ dictionary +
+
added in 6.3.0
+ + always + +
Dict of Values used to deploy.
+
+ +   @@ -1012,12 +1029,13 @@ Common return values are documented `here values
- string + dictionary
always -
Dict of Values used to deploy
+
Dict of Values used to deploy.
+
This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.

diff --git a/docs/kubernetes.core.helm_plugin_info_module.rst b/docs/kubernetes.core.helm_plugin_info_module.rst index ec0b7ce7..e6625ba1 100644 --- a/docs/kubernetes.core.helm_plugin_info_module.rst +++ b/docs/kubernetes.core.helm_plugin_info_module.rst @@ -196,7 +196,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.helm_plugin_module.rst b/docs/kubernetes.core.helm_plugin_module.rst index aae71899..5ced5391 100644 --- a/docs/kubernetes.core.helm_plugin_module.rst +++ b/docs/kubernetes.core.helm_plugin_module.rst @@ -272,7 +272,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.helm_repository_module.rst b/docs/kubernetes.core.helm_repository_module.rst index d2a8ecf1..a0475915 100644 --- a/docs/kubernetes.core.helm_repository_module.rst +++ b/docs/kubernetes.core.helm_repository_module.rst @@ -336,7 +336,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.helm_template_module.rst b/docs/kubernetes.core.helm_template_module.rst index 983616d3..2e70c8f2 100644 --- a/docs/kubernetes.core.helm_template_module.rst +++ b/docs/kubernetes.core.helm_template_module.rst @@ -409,7 +409,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_cluster_info_module.rst b/docs/kubernetes.core.k8s_cluster_info_module.rst index a0b621d6..580de1ca 100644 --- a/docs/kubernetes.core.k8s_cluster_info_module.rst +++ b/docs/kubernetes.core.k8s_cluster_info_module.rst @@ -416,7 +416,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_cp_module.rst b/docs/kubernetes.core.k8s_cp_module.rst index f74a0eac..3ca9cf9e 100644 --- a/docs/kubernetes.core.k8s_cp_module.rst +++ b/docs/kubernetes.core.k8s_cp_module.rst @@ -571,7 +571,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_drain_module.rst b/docs/kubernetes.core.k8s_drain_module.rst index 995e9113..d9341b9b 100644 --- a/docs/kubernetes.core.k8s_drain_module.rst +++ b/docs/kubernetes.core.k8s_drain_module.rst @@ -627,7 +627,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_exec_module.rst b/docs/kubernetes.core.k8s_exec_module.rst index 49be3421..883801ce 100644 --- a/docs/kubernetes.core.k8s_exec_module.rst +++ b/docs/kubernetes.core.k8s_exec_module.rst @@ -481,7 +481,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html @@ -535,7 +535,7 @@ Common return values are documented `here -
The command status code. This attribute is deprecated and will be removed in a future release. Please use rc instead.
+
The command status code. This attribute is deprecated and will be removed in version 7.0.0. Use RV(result.rc) instead.

diff --git a/docs/kubernetes.core.k8s_info_module.rst b/docs/kubernetes.core.k8s_info_module.rst index c9768004..c0c2c436 100644 --- a/docs/kubernetes.core.k8s_info_module.rst +++ b/docs/kubernetes.core.k8s_info_module.rst @@ -720,7 +720,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_json_patch_module.rst b/docs/kubernetes.core.k8s_json_patch_module.rst index 3ab82a1b..5d4c552e 100644 --- a/docs/kubernetes.core.k8s_json_patch_module.rst +++ b/docs/kubernetes.core.k8s_json_patch_module.rst @@ -621,7 +621,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_log_module.rst b/docs/kubernetes.core.k8s_log_module.rst index f2cbe671..da0de88d 100644 --- a/docs/kubernetes.core.k8s_log_module.rst +++ b/docs/kubernetes.core.k8s_log_module.rst @@ -612,7 +612,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_lookup.rst b/docs/kubernetes.core.k8s_lookup.rst index 347a8c05..c8cb00f8 100644 --- a/docs/kubernetes.core.k8s_lookup.rst +++ b/docs/kubernetes.core.k8s_lookup.rst @@ -38,13 +38,13 @@ Parameters - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - -
ParameterParameter Choices/Defaults Configuration Comments
+
api_key @@ -61,7 +61,7 @@ Parameters
+
api_version @@ -79,7 +79,7 @@ Parameters
+
ca_cert @@ -97,7 +97,7 @@ Parameters
+
client_cert @@ -115,7 +115,7 @@ Parameters
+
client_key @@ -133,7 +133,7 @@ Parameters
+
cluster_info @@ -150,7 +150,7 @@ Parameters
+
context @@ -167,7 +167,7 @@ Parameters
+
field_selector @@ -184,7 +184,7 @@ Parameters
+
host @@ -201,7 +201,7 @@ Parameters
+
kind @@ -219,7 +219,7 @@ Parameters
+
kubeconfig @@ -236,7 +236,7 @@ Parameters
+
label_selector @@ -253,7 +253,7 @@ Parameters
+
namespace @@ -270,7 +270,26 @@ Parameters
+ +
+ no_proxy + +
+ string +
+
+ + +
The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+
Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+
This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even if no_proxy is set correctly.
+
password @@ -287,7 +306,101 @@ Parameters
+
+ proxy + +
+ string +
+
+ + +
The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
+
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
+
+
+ proxy_headers + +
+ dictionary +
+
+ + +
The Header used for the HTTP proxy.
+ +
+
+ basic_auth + +
+ string +
+
+ + +
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+
+
+ proxy_basic_auth + +
+ string +
+
+ + +
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+
+
+ user_agent + +
+ string +
+
+ + +
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+
resource_definition @@ -304,7 +417,7 @@ Parameters
+
resource_name @@ -321,7 +434,7 @@ Parameters
+
src @@ -339,7 +452,7 @@ Parameters
+
username @@ -356,7 +469,7 @@ Parameters
+
validate_certs @@ -432,7 +545,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: +Common return values are documented `here `_, the following are the fields unique to this lookup: .. raw:: html diff --git a/docs/kubernetes.core.k8s_module.rst b/docs/kubernetes.core.k8s_module.rst index de083a9c..43259876 100644 --- a/docs/kubernetes.core.k8s_module.rst +++ b/docs/kubernetes.core.k8s_module.rst @@ -1279,18 +1279,35 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - - - - - - + + - + + - + + - + + + + + + + + + + + + + + @@ -614,7 +615,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_taint_module.rst b/docs/kubernetes.core.k8s_taint_module.rst index b3a08974..cd015677 100644 --- a/docs/kubernetes.core.k8s_taint_module.rst +++ b/docs/kubernetes.core.k8s_taint_module.rst @@ -541,7 +541,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.kubectl_connection.rst b/docs/kubernetes.core.kubectl_connection.rst index 97e60f9c..76bd87d1 100644 --- a/docs/kubernetes.core.kubectl_connection.rst +++ b/docs/kubernetes.core.kubectl_connection.rst @@ -383,6 +383,7 @@ Examples # and requires python to be installed in the image - name: Run a command in a pod ansible.builtin.command: echo "Hello, World!" + changed_when: false - name: Run a command in a pod using local kubectl with inventory variables # Example inventory: @@ -407,6 +408,7 @@ Examples # and requires python to be installed in the image - name: Run a command in a pod ansible.builtin.command: echo "Hello, World!" + changed_when: false - name: Run a command in a pod using dynamic inventory hosts: localhost @@ -440,6 +442,7 @@ Examples # be aware that the command is executed as the user that started the container # and requires python to be installed in the image ansible.builtin.command: echo "Hello, World!" + changed_when: false delegate_to: "{{ my_app_pod_name }}" diff --git a/docs/kubernetes.core.kustomize_lookup.rst b/docs/kubernetes.core.kustomize_lookup.rst index 423e8aaf..2515e470 100644 --- a/docs/kubernetes.core.kustomize_lookup.rst +++ b/docs/kubernetes.core.kustomize_lookup.rst @@ -149,7 +149,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this lookup: +Common return values are documented `here `_, the following are the fields unique to this lookup: .. raw:: html diff --git a/galaxy.yml b/galaxy.yml index de5fe91e..f3559d72 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -25,7 +25,7 @@ tags: - openshift - okd - cluster -version: 5.4.4 +version: 5.5.0 build_ignore: - .DS_Store - "*.tar.gz"
KeyKey Returned Description
+ +
+ method + +
+ string +
+
success +
The method used to deploy the resource.
+
+
Sample:
+
create
+
result @@ -1306,6 +1323,105 @@ Common return values are documented `here
  +
+ api_version + +
+ string +
+
when O(resource_definition) or O(src) contains a single object. +
The versioned schema of this representation of an object.
+
+
  +
+ duration + +
+ integer +
+
when wait is true +
elapsed time of task in seconds
+
+
Sample:
+
48
+
  +
+ error + +
+ complex +
+
error +
error while trying to create/delete the object.
+
+
  +
+ kind + +
+ string +
+
when O(resource_definition) or O(src) contains a single object. +
Represents the REST resource this object represents.
+
+
  +
+ metadata + +
+ complex +
+
when O(resource_definition) or O(src) contains a single object. +
Standard object metadata. Includes name, namespace, annotations, labels, etc.
+
+
  +
+ results + +
+ complex +
+
when O(resource_definition) or O(src) contains a list of objects. +
An array of created, patched, or otherwise present objects.
+
+
  
api_version @@ -1314,7 +1430,7 @@ Common return values are documented `here string
successwhen O(resource_definition) or O(src) contains a single object.
The versioned schema of this representation of an object.

@@ -1322,6 +1438,7 @@ Common return values are documented `here
  
duration @@ -1340,6 +1457,7 @@ Common return values are documented `here
  
error @@ -1356,21 +1474,6 @@ Common return values are documented `here
  -
- items - -
- list -
-
when resource_definition or src contains list of objects -
Returned only when multiple yaml documents are passed to src or resource_definition
-
-
 
@@ -1380,7 +1483,7 @@ Common return values are documented `here string
successwhen O(resource_definition) or O(src) contains a single object.
Represents the REST resource this object represents.

@@ -1388,6 +1491,7 @@ Common return values are documented `here
  
metadata @@ -1396,7 +1500,7 @@ Common return values are documented `here complex
successwhen O(resource_definition) or O(src) contains a single object.
Standard object metadata. Includes name, namespace, annotations, labels, etc.

@@ -1404,6 +1508,7 @@ Common return values are documented `here
  
spec @@ -1412,7 +1517,7 @@ Common return values are documented `here complex
successwhen O(resource_definition) or O(src) contains a single object.
Specific attributes of the object. Will vary based on the api_version and kind.

@@ -1420,6 +1525,7 @@ Common return values are documented `here
  
status @@ -1428,7 +1534,40 @@ Common return values are documented `here complex
successwhen O(resource_definition) or O(src) contains a single object. +
Current status details for the object.
+
+
  +
+ spec + +
+ complex +
+
when O(resource_definition) or O(src) contains a single object. +
Specific attributes of the object. Will vary based on the api_version and kind.
+
+
  +
+ status + +
+ complex +
+
when O(resource_definition) or O(src) contains a single object.
Current status details for the object.

diff --git a/docs/kubernetes.core.k8s_rollback_module.rst b/docs/kubernetes.core.k8s_rollback_module.rst index f5f29aa5..e0020598 100644 --- a/docs/kubernetes.core.k8s_rollback_module.rst +++ b/docs/kubernetes.core.k8s_rollback_module.rst @@ -503,7 +503,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_scale_module.rst b/docs/kubernetes.core.k8s_scale_module.rst index 101eee81..ffc1b34b 100644 --- a/docs/kubernetes.core.k8s_scale_module.rst +++ b/docs/kubernetes.core.k8s_scale_module.rst @@ -686,7 +686,7 @@ Examples Return Values ------------- -Common return values are documented `here `_, the following are the fields unique to this module: +Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html diff --git a/docs/kubernetes.core.k8s_service_module.rst b/docs/kubernetes.core.k8s_service_module.rst index 57ebe6d1..26219fe8 100644 --- a/docs/kubernetes.core.k8s_service_module.rst +++ b/docs/kubernetes.core.k8s_service_module.rst @@ -247,6 +247,7 @@ Parameters
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.
+
merge_type=json has been deprecated and will be removed in version 7.0.0. Use kubernetes.core.k8s_json_patch instead.