Browse code

inventory plugin order: update doc

add doc for #44428:
- add changelog fragment
- update porting guide
also:
- update auto inventory plugin doc
- mention toml plugin in examples

Pierre-Louis Bonicoli authored on 2018/12/12 09:34:25
Showing 5 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,3 @@
0
+minor_changes:
1
+  - "default value for ``INVENTORY_ENABLED`` option was ``['host_list', 'script', 'yaml', 'ini', 'toml', 'auto']``
2
+    and is now ``['host_list', 'script', 'auto', 'yaml', 'ini', 'toml']``"
... ...
@@ -22,7 +22,7 @@ config file that ships with Ansible:
22 22
 .. code-block:: ini
23 23
 
24 24
    [inventory]
25
-   enable_plugins = host_list, script, auto, yaml, ini
25
+   enable_plugins = host_list, script, auto, yaml, ini, toml
26 26
 
27 27
 This list also establishes the order in which each plugin tries to parse an inventory source. Any plugins left out of the list will not be considered, so you can 'optimize' your inventory loading by minimizing it to what you actually use. For example:
28 28
 
... ...
@@ -139,6 +139,8 @@ Plugins
139 139
   has changed to ``%USERPROFILE%\.ansible_async``. To control this path now, either set the ``ansible_async_dir``
140 140
   variable or the ``async_dir`` value in the ``powershell`` section of the config ini.
141 141
 
142
+* Order of enabled inventory plugins (:ref:`INVENTORY_ENABLED`) has been updated, :ref:`auto <auto_inventory>` is now before :ref:`yaml <yaml_inventory>` and :ref:`ini <ini_inventory>`.
143
+
142 144
 Porting custom scripts
143 145
 ======================
144 146
 
... ...
@@ -324,7 +324,7 @@
324 324
 #any_errors_fatal = False
325 325
 
326 326
 [inventory]
327
-# enable inventory plugins, default: 'host_list', 'script', 'auto', 'yaml', 'ini'
327
+# enable inventory plugins, default: 'host_list', 'script', 'auto', 'yaml', 'ini', 'toml'
328 328
 #enable_plugins = host_list, virtualbox, yaml, constructed
329 329
 
330 330
 # ignore these extensions when parsing a directory as inventory source
... ...
@@ -11,7 +11,7 @@ DOCUMENTATION = '''
11 11
       - Matt Davis <@nitzmahone>
12 12
     short_description: Loads and executes an inventory plugin specified in a YAML config
13 13
     description:
14
-        - By whitelisting C(auto) as the final inventory plugin, any YAML inventory config file with a
14
+        - By whitelisting C(auto) inventory plugin, any YAML inventory config file with a
15 15
           C(plugin) key at its root will automatically cause the named plugin to be loaded and executed with that
16 16
           config. This effectively provides automatic whitelisting of all installed/accessible inventory plugins.
17 17
         - To disable this behavior, remove C(auto) from the C(INVENTORY_ENABLED) config element.