Add a deprecation notice for ENABLE_TURBO_MODE (#1242)

* Add a deprecation notice for ENABLE_TURBO_MODE

* minor fix

* fix(turbo): ensure deprecation warning reaches user and skip turbo on unsupported ansible-core

Move the ENABLE_TURBO_MODE deprecation warning to module import time,
since AnsibleTurboModule.__init__() exits the process before returning,
making the previous per-instance deprecate() call unreachable. Also
skip turbo mode on ansible-core >= 2.19.0, where cloud.common is not
supported and the import succeeding could otherwise fail later with
an unrelated traceback, and warn instead of silently falling back
when cloud.common is not installed.

Assisted-by: Claude Sonnet 5

* docs(turbo): clarify that turbo mode is ignored on ansible-core 2.19+

Turbo mode is now bypassed with a warning rather than failing on
unsupported ansible-core, so drop the "may lead to fails" wording from
the README note and the matching statement in the turbo mode guide.

Assisted-by: Claude Opus 5
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Mandar Kulkarni
2026-09-14 11:24:26 -07:00
committed by GitHub
co-authored by Claude Opus 5
parent c098ecc8c8
commit 031bc475fa
5 changed files with 62 additions and 2 deletions
+3 -1
View File
@@ -181,7 +181,9 @@ For documentation on how to use individual modules and other content included in
## Ansible Turbo Mode Tech Preview ## Ansible Turbo Mode Tech Preview
> **Note:** Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**. Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported, and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``. If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``, it may lead to fails. > **Deprecated:** Ansible Turbo mode (`ENABLE_TURBO_MODE`) is deprecated and will be removed in a future major release (planned for 8.0.0), since it depends on the `cloud.common` collection, which is being retired. Setting `ENABLE_TURBO_MODE` will keep emitting a deprecation warning until support is removed, at which point the variable will have no effect.
> **Note:** Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**. Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported, and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``. If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``, Turbo mode is ignored and a warning is emitted; modules run without it.
The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection (requires `ansible-core < 2.19`). By default, this feature is disabled. To enable Turbo mode for modules, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example: The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection (requires `ansible-core < 2.19`). By default, this feature is disabled. To enable Turbo mode for modules, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
@@ -0,0 +1,7 @@
---
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).
+8 -1
View File
@@ -12,12 +12,19 @@ Following document provides overview of Ansible Turbo mode in ``kubernetes.core`
:depth: 1 :depth: 1
.. warning::
Ansible Turbo mode is **deprecated** and will be removed in a future major release
(planned for 8.0.0), as it depends on the ``cloud.common`` collection, which is being
retired. Setting ``ENABLE_TURBO_MODE`` now emits a deprecation warning; once support is
removed, the variable will have no effect. Start planning your migration away from
Turbo mode.
.. warning:: .. warning::
Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**. Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**.
Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported, Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported,
and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``. and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``.
If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``, If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``,
it may lead to failures. Turbo mode is ignored and a warning is emitted; modules run without it.
Synopsis Synopsis
-------- --------
+14
View File
@@ -213,6 +213,7 @@ from collections.abc import KeysView
from ansible.errors import AnsibleError from ansible.errors import AnsibleError
from ansible.module_utils.common.validation import check_type_bool from ansible.module_utils.common.validation import check_type_bool
from ansible.utils.display import Display
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import ( from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
get_api_client, get_api_client,
) )
@@ -220,17 +221,30 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource impor
create_definitions, create_definitions,
) )
display = Display()
try: try:
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE")) enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
except TypeError: except TypeError:
enable_turbo_mode = False enable_turbo_mode = False
if enable_turbo_mode: if enable_turbo_mode:
display.deprecated(
"ENABLE_TURBO_MODE is deprecated, as it relies on the cloud.common "
"collection which is being retired. Setting this environment "
"variable will have no effect once support is removed.",
version="8.0.0",
collection_name="kubernetes.core",
)
try: try:
from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import ( from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import (
TurboLookupBase as LookupBase, TurboLookupBase as LookupBase,
) )
except ImportError: except ImportError:
display.warning(
"ENABLE_TURBO_MODE is set but the cloud.common collection is not installed. "
"Continuing without Turbo mode."
)
from ansible.plugins.lookup import LookupBase # noqa: F401 from ansible.plugins.lookup import LookupBase # noqa: F401
else: else:
from ansible.plugins.lookup import LookupBase # noqa: F401 from ansible.plugins.lookup import LookupBase # noqa: F401
+30
View File
@@ -5,13 +5,39 @@ __metaclass__ = type
import os import os
from ansible.module_utils.ansible_release import __version__ as ansible_version
from ansible.module_utils.common.validation import check_type_bool from ansible.module_utils.common.validation import check_type_bool
from ansible.module_utils.common.warnings import deprecate, warn
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
LooseVersion,
)
# cloud.common declares requires_ansible '>=2.15.0,<2.19'. On newer ansible-core the
# import still succeeds, so the version has to be checked explicitly: relying on
# ImportError alone lets turbo mode fail later with an unrelated traceback.
TURBO_UNSUPPORTED_CORE = "2.19.0"
try: try:
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE")) enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
except TypeError: except TypeError:
enable_turbo_mode = False enable_turbo_mode = False
if enable_turbo_mode:
deprecate(
"ENABLE_TURBO_MODE is deprecated, as it relies on the cloud.common collection "
"which is being retired. Setting this environment variable will have no effect "
"once support is removed.",
version="8.0.0",
collection_name="kubernetes.core",
)
if LooseVersion(ansible_version) >= LooseVersion(TURBO_UNSUPPORTED_CORE):
warn(
"ENABLE_TURBO_MODE is ignored on ansible-core %s: Ansible Turbo mode requires "
"the cloud.common collection, which supports ansible-core < %s only. "
"Continuing without Turbo mode." % (ansible_version, TURBO_UNSUPPORTED_CORE)
)
enable_turbo_mode = False
if enable_turbo_mode: if enable_turbo_mode:
try: try:
from ansible_collections.cloud.common.plugins.module_utils.turbo.module import ( # noqa: F401 from ansible_collections.cloud.common.plugins.module_utils.turbo.module import ( # noqa: F401
@@ -20,6 +46,10 @@ if enable_turbo_mode:
AnsibleModule.collection_name = "kubernetes.core" AnsibleModule.collection_name = "kubernetes.core"
except ImportError: except ImportError:
warn(
"ENABLE_TURBO_MODE is set but the cloud.common collection is not installed. "
"Continuing without Turbo mode."
)
from ansible.module_utils.basic import AnsibleModule # noqa: F401 from ansible.module_utils.basic import AnsibleModule # noqa: F401
else: else:
from ansible.module_utils.basic import AnsibleModule # noqa: F401 from ansible.module_utils.basic import AnsibleModule # noqa: F401