From d41050b28b2d3e8d4a97ce13344b04fc87f703a2 Mon Sep 17 00:00:00 2001 From: Sloane Hertel Date: Thu, 26 Sep 2019 12:00:26 -0400 Subject: Add some documentation about plugins in collections (#62465) * Add some documentation about using plugins in collections - FQCN requirements - Sharing code in collections - Limitations with inventory caching --- docs/docsite/rst/plugins/cache.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'docs/docsite/rst/plugins/cache.rst') diff --git a/docs/docsite/rst/plugins/cache.rst b/docs/docsite/rst/plugins/cache.rst index 66ffbc30e5..e6cad2b895 100644 --- a/docs/docsite/rst/plugins/cache.rst +++ b/docs/docsite/rst/plugins/cache.rst @@ -34,6 +34,13 @@ or in the ``ansible.cfg`` file: [defaults] fact_caching=redis +If the cache plugin is in a collection use the fully qualified name: + +.. code-block:: ini + + [defaults] + fact_caching = namespace.collection_name.cache_plugin_name + You will also need to configure other settings specific to each plugin. Consult the individual plugin documentation or the Ansible :ref:`configuration ` for more details. @@ -43,7 +50,7 @@ A custom cache plugin is enabled by dropping it into a ``cache_plugins`` directo Enabling Inventory Cache Plugins -------------------------------- -Inventory may be cached using a file-based cache plugin (like jsonfile). Check the specific inventory plugin to see if it supports caching. +Inventory may be cached using a file-based cache plugin (like jsonfile). Check the specific inventory plugin to see if it supports caching. Cache plugins inside a collection are not supported for caching inventory. If an inventory-specific cache plugin is not specified Ansible will fall back to caching inventory with the fact cache plugin options. The inventory cache is disabled by default. You may enable it via environment variable: -- cgit v1.2.1