mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-06-09 18:16:09 +00:00
docs: clarify ansible turbo mode with version compatibility notice (#1120)
The docs/ansible_turbo_mode.rst file was accidentally removed in PR#988, breaking the link referenced in README.md. Restore it so users following that link get the full Turbo mode documentation rather than a 404. Additionally, document the ansible-core version compatibility issue for cloud.common (see ansible-collections/cloud.common@5e3430d and kubernetes.core PR #1109): Turbo mode is incompatible with ansible-core >= 2.19 because cloud.common no longer supports it. Without this clarification users on newer ansible-core versions encounter silent or confusing failures when ENABLE_TURBO_MODE=1 is set. Update README.md with the same warning so the incompatibility is visible before users follow the link to the full docs. Addresses: #927
This commit is contained in:
committed by
GitHub
parent
53c6c0ee80
commit
248e0d7db9
@@ -200,7 +200,9 @@ For documentation on how to use individual modules and other content included in
|
||||
|
||||
## Ansible Turbo Mode Tech Preview
|
||||
|
||||
The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection. 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:
|
||||
> **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.
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user