Add examples to clarify inventory plugin usage (#1347)

* Add examples to clarify inventory plugin usage * Update docs/docsite/rst/plugins/inventory.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/plugins/inventory.rst Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Don Naro <[email protected]> (cherry picked from commit d61e53a)
ansible · Apr 26, 2024 · 8f8ff99 · 8f8ff99
1 parent d2e6eda
commit 8f8ff99
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/docsite/rst/plugins/inventory.rst b/docs/docsite/rst/plugins/inventory.rst
@@ -52,6 +52,13 @@ To use an inventory plugin, you must provide an inventory source. Most of the ti
 
 To start using an inventory plugin with a YAML configuration source, create a file with the accepted file name schema documented for the plugin in question, then add ``plugin: plugin_name``. Use the fully qualified name if the plugin is in a collection.
 
+
+.. note:: Inventory plugins have required name patterns to which they must conform, for example:
+
+  An inventory that includes the ``kubevirt.core.kubevirt`` inventory plugin must use the ``*.kubevirt.yml`` filename pattern. 
+  An inventory that includes the ``servicenow.servicenow.now`` inventory plugin must use the ``*.servicenow.yml`` filename pattern.
+
+
 .. code-block:: yaml
 
    # demo.aws_ec2.yml