diff options
author | Sloane Hertel <shertel@redhat.com> | 2020-05-05 16:10:57 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-05 15:10:57 -0500 |
commit | 34458f3569be1b8592e0c433ce09c6add86893da (patch) | |
tree | 0a5500b68cf5887c27b616fe0902a1dcfa9d18fd /docs/docsite/rst/plugins/cache.rst | |
parent | f6860a7a89c30a3dce1ab54d4964dc188cba82c2 (diff) | |
download | ansible-34458f3569be1b8592e0c433ce09c6add86893da.tar.gz |
Update inventory caching documentation (#69100)
Diffstat (limited to 'docs/docsite/rst/plugins/cache.rst')
-rw-r--r-- | docs/docsite/rst/plugins/cache.rst | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/docsite/rst/plugins/cache.rst b/docs/docsite/rst/plugins/cache.rst index ba03b1d76c..ce7e848743 100644 --- a/docs/docsite/rst/plugins/cache.rst +++ b/docs/docsite/rst/plugins/cache.rst @@ -90,7 +90,14 @@ or if the inventory plugin accepts a YAML configuration source, in the configura To cache inventory with a custom plugin in your plugin path, follow the :ref:`developer guide on cache plugins<developing_cache_plugins>`. -You can use any cache plugin shipped with Ansible to cache inventory, but you cannot use a cache plugin inside a collection. If you enable caching for inventory plugins without selecting an inventory-specific cache plugin, Ansible falls back to caching inventory with the fact cache plugin you configured. Consult the individual inventory plugin documentation or the Ansible :ref:`configuration <ansible_configuration_settings>` for more details. +To cache inventory with a cache plugin in a collection, use the FQCN: + +.. code-block:: ini + + [inventory] + cache_plugin=collection_namespace.collection_name.cache_plugin + +If you enable caching for inventory plugins without selecting an inventory-specific cache plugin, Ansible falls back to caching inventory with the fact cache plugin you configured. Consult the individual inventory plugin documentation or the Ansible :ref:`configuration <ansible_configuration_settings>` for more details. .. Note: In Ansible 2.7 and earlier, inventory plugins can only use file-based cache plugins, such as jsonfile, pickle, and yaml. |