internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 13:52:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

clarify insane ini typing (#48169)

Browse Source 
* clarify how variables are interpreted in the ini inventory plugin
This commit is contained in:
Brian Coca
2018-11-07 15:19:23 -05:00
committed by Alicia Cozine
parent 0d068f1e3a
commit 8ccb44aa63
2 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docsite/rst/user_guide/intro_inventory.rst
View File

@@ -94,9 +94,12 @@ In the above example, trying to ansible against the host alias "jumper" (which m
Note that this is using a feature of the inventory file to define some special variables.
Generally speaking, this is not the best way to define variables that describe your system policy, but we'll share suggestions on doing this later.
.. note:: Values passed in the INI format using the ``key=value`` syntax are not interpreted as Python literal structure
(strings, numbers, tuples, lists, dicts, booleans, None), but as a string. For example ``var=FALSE`` would create a string equal to 'FALSE'.
Do not rely on types set during definition, always make sure you specify type with a filter when needed when consuming the variable.
.. note:: Values passed in the INI format using the ``key=value`` syntax are interpreted differently depending on where they are declared.
* When declared inline with the host, INI values are interpreted as Python literal structures
(strings, numbers, tuples, lists, dicts, booleans, None). Host lines accept multiple ``key=value`` parameters per line. Therefore they need a way to indicate that a space is part of a value rather than a separator.
* When declared in a ``:vars`` section, INI values are interpreted as strings. For example ``var=FALSE`` would create a string equal to 'FALSE'. Unlike host lines, ``:vars`` sections accept only a single entry per line, so everything after the ``=`` must be the value for the entry.
* Do not rely on types set during definition, always make sure you specify type with a filter when needed when consuming the variable.
* Consider using YAML format for inventory sources to avoid confusion on the actual type of a variable. The YAML inventory plugin processes variable values consistently and correctly.
If you are adding a lot of hosts following similar patterns, you can do this rather than listing each hostname:
@@ -140,7 +143,7 @@ As described above, it is easy to assign variables to hosts that will be used la
The YAML version:
.. code-block:: yaml
atlanta:
host1:
http_port: 80
@@ -502,4 +505,3 @@ Here is an example of how to instantly deploy to created containers::
Questions? Help? Ideas? Stop by the list on Google Groups
`irc.freenode.net <http://irc.freenode.net>`_
#ansible IRC chat channel