cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add documentation around commonly-used Facts for Conditionals (#34263)

Browse source 
* add documentation around commonly-used Facts for Conditionals

There are a few Facts that are often used for Conditionals, so
documenting them on the Conditionals page with their possible values.

* Edit
This commit is contained in:
Aidan Feldman 2018-01-22 16:37:19 -05:00 committed by scottb
parent 7f6feca82f
commit de60328d94
2 changed files with 66 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
docs/docsite/rst/playbooks_conditionals.rst
View file

@ -6,7 +6,7 @@ Conditionals
Often the result of a play may depend on the value of a variable, fact (something learned about the remote system), or previous task result.
In some cases, the values of variables may depend on other variables.
Further, additional groups can be created to manage hosts based on whether the hosts match other criteria. This topic covers how conditionals are used in playbooks.
Additional groups can be created to manage hosts based on whether the hosts match other criteria. This topic covers how conditionals are used in playbooks.
.. note:: There are many options to control execution flow in Ansible. More examples of supported conditionals can be located here: http://jinja.pocoo.org/docs/dev/templates/#comparisons.
@ -319,6 +319,69 @@ You may check the registered variable's string contents for emptiness::
debug: msg="Directory is empty"
when: contents.stdout == ""
Commonly Used Facts
```````````````````
The following Facts (see :ref:`_vars_and_facts`) are frequently used in Conditionals - see above for examples.
.. _ansible_distribution:
ansible_distribution
--------------------
Possible values::
Alpine
Altlinux
Amazon
Archlinux
ClearLinux
Coreos
Debian
Gentoo
Mandriva
NA
OpenWrt
OracleLinux
RedHat
Slackware
SMGL
SUSE
VMwareESX
.. See `OSDIST_LIST`
.. _ansible_distribution_major_version:
ansible_distribution_major_version
----------------------------------
This will be the major version of the operating system. For example, the value will be `16` for Ubuntu 16.04.
.. _ansible_os_family:
ansible_os_family
-----------------
Possible values::
AIX
Alpine
Altlinux
Archlinux
Darwin
Debian
FreeBSD
Gentoo
HP-UX
Mandrake
RedHat
SGML
Slackware
Solaris
Suse
.. See `OS_FAMILY_MAP`
.. seealso::

2
lib/ansible/module_utils/facts/system/distribution.py
View file

@ -55,6 +55,7 @@ class DistributionFiles:
# - allowempty == True
# - be listed in SEARCH_STRING
# - have a function get_distribution_DISTNAME implemented
# keep names in sync with Conditionals page of docs
OSDIST_LIST = (
{'path': '/etc/oracle-release', 'name': 'OracleLinux'},
{'path': '/etc/slackware-version', 'name': 'Slackware'},
@ -404,6 +405,7 @@ class Distribution(object):
'SMGL': 'Source Mage GNU/Linux',
}
# keep keys in sync with Conditionals page of docs
OS_FAMILY_MAP = {'RedHat': ['RedHat', 'Fedora', 'CentOS', 'Scientific', 'SLC',
'Ascendos', 'CloudLinux', 'PSBM', 'OracleLinux', 'OVS',
'OEL', 'Amazon', 'Virtuozzo', 'XenServer'],