wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

inventory plugin order: update doc

Browse source 
add doc for #44428:
- add changelog fragment
- update porting guide
also:
- update auto inventory plugin doc
- mention toml plugin in examples
This commit is contained in:
Pierre-Louis Bonicoli 2018-12-12 01:34:25 +01:00 committed by Toshio Kuratomi
parent 2f8001a7af
commit 7e278b23b4
5 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
changelogs/fragments/44428-inventory-plugin-list.yml Normal file
View file

@ -0,0 +1,3 @@
minor_changes:
- "default value for ``INVENTORY_ENABLED`` option was ``['host_list', 'script', 'yaml', 'ini', 'toml', 'auto']``
and is now ``['host_list', 'script', 'auto', 'yaml', 'ini', 'toml']``"

2
docs/docsite/rst/plugins/inventory.rst
View file

@ -22,7 +22,7 @@ config file that ships with Ansible:
.. code-block:: ini .. code-block:: ini
[inventory] [inventory]
enable_plugins = host_list, script, auto, yaml, ini enable_plugins = host_list, script, auto, yaml, ini, toml
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: 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:

2
docs/docsite/rst/porting_guides/porting_guide_2.8.rst
View file

@ -139,6 +139,8 @@ Plugins
has changed to ``%USERPROFILE%\.ansible_async``. To control this path now, either set the ``ansible_async_dir`` has changed to ``%USERPROFILE%\.ansible_async``. To control this path now, either set the ``ansible_async_dir``
variable or the ``async_dir`` value in the ``powershell`` section of the config ini. variable or the ``async_dir`` value in the ``powershell`` section of the config ini.
* 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>`.
Porting custom scripts Porting custom scripts
====================== ======================

2
examples/ansible.cfg
View file

@ -324,7 +324,7 @@
#any_errors_fatal = False #any_errors_fatal = False
[inventory] [inventory]
# enable inventory plugins, default: 'host_list', 'script', 'auto', 'yaml', 'ini' # enable inventory plugins, default: 'host_list', 'script', 'auto', 'yaml', 'ini', 'toml'
#enable_plugins = host_list, virtualbox, yaml, constructed #enable_plugins = host_list, virtualbox, yaml, constructed
# ignore these extensions when parsing a directory as inventory source # ignore these extensions when parsing a directory as inventory source

2
lib/ansible/plugins/inventory/auto.py
View file

@ -11,7 +11,7 @@ DOCUMENTATION = '''
- Matt Davis <@nitzmahone> - Matt Davis <@nitzmahone>
short_description: Loads and executes an inventory plugin specified in a YAML config short_description: Loads and executes an inventory plugin specified in a YAML config
description: description:
- By whitelisting C(auto) as the final inventory plugin, any YAML inventory config file with a - By whitelisting C(auto) inventory plugin, any YAML inventory config file with a
C(plugin) key at its root will automatically cause the named plugin to be loaded and executed with that C(plugin) key at its root will automatically cause the named plugin to be loaded and executed with that
config. This effectively provides automatic whitelisting of all installed/accessible inventory plugins. config. This effectively provides automatic whitelisting of all installed/accessible inventory plugins.
- To disable this behavior, remove C(auto) from the C(INVENTORY_ENABLED) config element. - To disable this behavior, remove C(auto) from the C(INVENTORY_ENABLED) config element.