salt.pillar.file_tree¶

Master Configuration¶

ext_pillar:
  - file_tree:
      root_dir: /srv/ext_pillar
      follow_dir_links: False
      keep_newline: True

node_groups:
  internal_servers: 'L@bob,stuart,kevin'

Pillar Configuration¶

(salt-master) # tree /srv/ext_pillar
/srv/ext_pillar/
|-- hosts
|   |-- bob
|   |   |-- apache
|   |   |   `-- config.d
|   |   |       |-- 00_important.conf
|   |   |       `-- 20_bob_extra.conf
|   |   `-- corporate_app
|   |       `-- settings
|   |           `-- bob_settings.cfg
|   `-- kevin
|       |-- apache
|       |   `-- config.d
|       |       `-- 00_important.conf
|       `-- corporate_app
|           `-- settings
|               `-- kevin_settings.cfg
`-- nodegroups
    `-- internal_servers
        `-- corporate_app
            `-- settings
                `-- common_settings.cfg

Verify Pillar Data¶

(salt-master) # salt bob pillar.items
bob:
    ----------
    apache:
        ----------
        config.d:
            ----------
            00_important.conf:
                <important_config important_setting="yes" />
            20_bob_extra.conf:
                <bob_specific_cfg has_freeze_ray="yes" />
    corporate_app:
        ----------
        settings:
            ----------
            common_settings:
                // This is the main settings file for the corporate
                // internal web app
                main_setting: probably
            bob_settings:
                role: bob

salt.pillar.file_tree.ext_pillar(minion_id, pillar, root_dir=None, follow_dir_links=False, debug=False, keep_newline=False, render_default=None, renderer_blacklist=None, renderer_whitelist=None, template=False)¶

Compile pillar data from the given root_dir specific to Nodegroup names and Minion IDs.

If a Minion's ID is not found at <root_dir>/host/<minion_id> or if it is not included in any Nodegroups named at <root_dir>/nodegroups/<node_group>, no pillar data provided by this pillar module will be available for that Minion.

Changed in version 2017.7.0: Templating/rendering has been added. You can now specify a default render pipeline and a black- and whitelist of (dis)allowed renderers.

template must be set to True for templating to happen.

ext_pillar:
  - file_tree:
    root_dir: /path/to/root/directory
    render_default: jinja|yaml
    renderer_blacklist:
      - gpg
    renderer_whitelist:
      - jinja
      - yaml
    template: True

Parameters:

minion_id -- The ID of the Minion whose pillar data is to be collected pillar -- Unused by the file_tree pillar module root_dir -- Filesystem directory used as the root for pillar data (e.g. /srv/ext_pillar) follow_dir_links -- Follow symbolic links to directories while collecting pillar files. Defaults to False. Warning Care should be exercised when enabling this option as it will follow links that point outside of root_dir. Warning Symbolic links that lead to infinite recursion are not filtered. debug -- Enable debug information at log level debug. Defaults to False. This option may be useful to help debug errors when setting up the file_tree pillar module. keep_newline -- Preserve the end-of-file newline in files. Defaults to False. This option may either be a boolean or a list of file globs (as defined by the Python fnmatch package) for which end-of-file newlines are to be kept. keep_newline should be turned on if the pillar data is intended to be used to deploy a file using contents_pillar with a file.managed state. Changed in version 2015.8.4: The raw_data parameter has been renamed to keep_newline. In earlier releases, raw_data must be used. Also, this parameter can now be a list of globs, allowing for more granular control over which pillar values keep their end-of-file newline. The globs match paths relative to the directories named for Minion IDs and Nodegroup namess underneath the root_dir. ext_pillar: - file_tree: root_dir: /srv/ext_pillar keep_newline: - apache/config.d/* - corporate_app/settings/* Note In earlier releases, this documentation incorrectly stated that binary files would not affected by the keep_newline. However, this module does not actually distinguish between binary and text files. render_default -- Override Salt's default global renderer for the file_tree pillar. render_default: jinja renderer_blacklist -- Disallow renderers for pillar files. renderer_blacklist: - json renderer_whitelist -- Allow renderers for pillar files. renderer_whitelist: - yaml - jinja template -- Enable templating of pillar files. Defaults to False.