centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-26 13:18:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add note about get_cache_key in the inventory plugin dev guide (#3468) (#3485)

Browse Source 
* Add notes about cache limitations in the inventory plugin development guide

* Update docs/docsite/rst/dev_guide/developing_inventory.rst



* Update docs/docsite/rst/dev_guide/developing_inventory.rst

* Update docs/docsite/rst/dev_guide/developing_inventory.rst



* Add recommendation to avoid multiple cache entries

---------



(cherry picked from commit 3bc7feb0f9)

Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
This commit is contained in:
patchback[bot]
2026-02-18 12:03:48 +00:00
committed by GitHub
parent 559bdd26d9
commit f975d5a4d5
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docsite/rst/dev_guide/developing_inventory.rst
View File

@@ -248,6 +248,8 @@ Before using the cache plugin, you must retrieve a unique cache key by using the
self.load_cache_plugin()
cache_key = self.get_cache_key(path)
.. note:: The ``get_cache_key`` is a helper method that retrieves a unique key for the plugin name and the ``path`` parameter. Inventory plugins that generate multiple unique cache entries should not use this helper method because it is designed to get one key per inventory source. In general we recommend that plugin developers refactor to avoid multiple cache entries for inventory sources.
Now that you've enabled caching, loaded the correct plugin, and retrieved a unique cache key, you can set up the flow of data between the cache and your inventory using the ``cache`` parameter of the ``parse`` method. This value comes from the inventory manager and indicates whether the inventory is being refreshed (such as by the ``--flush-cache`` or the meta task ``refresh_inventory``). Although the cache shouldn't be used to populate the inventory when being refreshed, the cache should be updated with the new inventory if the user has enabled caching. You can use ``self._cache`` like a dictionary. The following pattern allows refreshing the inventory to work in conjunction with caching.
.. code-block:: python