From ddbc1611218c91cc608ee6efc950602783f61d78 Mon Sep 17 00:00:00 2001 From: Mike Graves Date: Thu, 2 Sep 2021 15:58:43 -0400 Subject: [PATCH] Add turbo mode docs (#221) Add turbo mode docs SUMMARY Add turbo mode docs ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Abhijeet Kasurde Reviewed-by: None --- README.md | 16 ++++++++++++++++ docs/ansible_turbo_mode.rst | 11 ++++++++++- 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fb4e9953..6c247bb2 100644 --- a/README.md +++ b/README.md @@ -161,6 +161,22 @@ If upgrading older playbooks which were built prior to Ansible 2.10 and this col For documentation on how to use individual modules and other content included in this collection, please see the links in the 'Included content' section earlier in this README. +## 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, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example: + +```yaml +--- +- hosts: remote + environment: + ENABLE_TURBO_MODE: 1 + tasks: + ... +``` + +Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst). + ## Testing and Development If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. diff --git a/docs/ansible_turbo_mode.rst b/docs/ansible_turbo_mode.rst index f85fb03b..f8114aaf 100644 --- a/docs/ansible_turbo_mode.rst +++ b/docs/ansible_turbo_mode.rst @@ -15,7 +15,7 @@ Following document provides overview of Ansible Turbo mode in ``kubernetes.core` Synopsis -------- - A brief introduction about Ansible Turbo mode in ``kuberentes.core`` collection. -- Ansible Turbo mode is an optional performance optimization. It can be enabled by simply installing the cloud.common collection. +- Ansible Turbo mode is an optional performance optimization. It can be enabled by installing the cloud.common collection and setting the ``ENABLE_TURBO_MODE`` environment variable. Requirements ------------ @@ -24,6 +24,15 @@ The following requirement is needed on the host that executes this module. - The ``cloud.common`` collection (https://github.com/ansible-collections/cloud.common) +You will also need to set the environment variable ``ENABLE_TURBO_MODE=1`` on the managed host. This can be done in the same ways you would usually do so, for example:: + + --- + - hosts: remote + environment: + ENABLE_TURBO_MODE: 1 + tasks: + ... + Installation ------------