The template engines available to sls files and file templates come loaded with a number of context variables. These variables contain information and functions to assist in the generation of templates.
The salt variable is available to abstract the salt library functions. This variable is a python dictionary containing all of the functions available to the running salt minion:
{% for file in salt['cmd.run'](ls /opt/to_remove) %}
{{ file }}:
file.absent
{% endfor %}
The opts variable abstracts the contents of the minion's configuration file directly to the template. The opts variable is a dictionary.
{{ opts['cachedir'] }}
The config.get
function also searches for values in the opts dictionary.
The pillar dictionary can be referenced directly:
{{ pillar['key'] }}
Using the pillar.get
function via the salt variable is generally recommended since a default can be safely set in the event that the value is not available in pillar and dictionaries can be traversed directly:
{{ salt['pillar.get']('key', 'failover_value') }}
{{ salt['pillar.get']('stuff:more:deeper') }}
The grains dictionary makes the minion's grains directly available:
{{ grains['os'] }}
The grains.get
function can be used to traverse deeper grains and set defaults:
{{ salt['grains.get']('os') }}
The env variable is available in sls files when gathering the sls from an environment.
{{ env }}
The sls variable contains the sls reference value. The sls reference value is the value used to include the sls in top files or via the include option.
{{ sls }}