Grains¶
Salt comes with an interface to derive information about the underlying system. This is called the grains interface, because it presents salt with grains of information.
- Grains
- Static bits of information that a minion collects about the system when the minion first starts.
The grains interface is made available to Salt modules and components so that the right salt minion commands are automatically available on the right systems.
It is important to remember that grains are bits of information loaded when the salt minion starts, so this information is static. This means that the information in grains is unchanging, therefore the nature of the data is static. So grains information are things like the running kernel, or the operating system.
Match all CentOS minions:
salt -G 'os:CentOS' test.ping
Match all minions with 64-bit CPUs, and return number of CPU cores for each matching minion:
salt -G 'cpuarch:x86_64' grains.item num_cpus
Additionally, globs can be used in grain matches, and grains that are nested in
a dictionary can be matched by adding a colon for
each level that is traversed. For example, the following will match hosts that
have a grain called ec2_tags
, which itself is a
dict with a key named environment
, which
has a value that contains the word production
:
salt -G 'ec2_tags:environment:*production*'
Listing Grains¶
Available grains can be listed by using the 'grains.ls' module:
salt '*' grains.ls
Grains data can be listed by using the 'grains.items' module:
salt '*' grains.items
Grains in the Minion Config¶
Grains can also be statically assigned within the minion configuration file.
Just add the option grains
and pass options to it:
grains:
roles:
- webserver
- memcache
deployment: datacenter4
cabinet: 13
cab_u: 14-15
Then status data specific to your servers can be retrieved via Salt, or used inside of the State system for matching. It also makes targeting, in the case of the example above, simply based on specific data about your deployment.
Grains in /etc/salt/grains¶
If you do not want to place your custom static grains in the minion config
file, you can also put them in /etc/salt/grains
. They are configured in the
same way as in the above example, only without a top-level grains:
key:
roles:
- webserver
- memcache
deployment: datacenter4
cabinet: 13
cab_u: 14-15
Precedece of Custom Static Grains
Be careful when defining grains both in /etc/salt/grains
and within the
minion config file. If a grain is defined in both places, the value in the
minion config file takes precedence, and will always be used over its
counterpart in /etc/salt/grains
.
Grains in Top file¶
With correctly setup grains on the Minion, the Top file used in Pillar or during Highstate can be made really efficient. Like for example, you could do:
'node_type:web':
- match: grain
- webserver
'node_type:postgres':
- match: grain
- database
'node_type:redis':
- match: grain
- redis
'node_type:lb':
- match: grain
- lb
For this example to work, you would need the grain node_type
and the correct value to match on. This simple example is nice, but too much of the code is similar. To go one step further, we can place some Jinja template code into the Top file.
{% set self = grains['node_type'] %}
'node_type:{{ self }}':
- match: grain
- {{ self }}
The Jinja code simplified the Top file, and allowed SaltStack to work its magic.
Writing Grains¶
Grains are easy to write. The grains interface is derived by executing all of the "public" functions found in the modules located in the grains package or the custom grains directory. The functions in the modules of the grains must return a Python dict, where the keys in the dict are the names of the grains and the values are the values.
Custom grains should be placed in a _grains
directory located under the
file_roots
specified by the master config file. They will be
distributed to the minions when state.highstate
is run, or by executing the
saltutil.sync_grains
or
saltutil.sync_all
functions.
Before adding a grain to Salt, consider what the grain is and remember that grains need to be static data. If the data is something that is likely to change, consider using Pillar instead.
Examples of Grains¶
The core module in the grains package is where the main grains are loaded by the Salt minion and provides the principal example of how to write grains:
https://github.com/saltstack/salt/blob/develop/salt/grains/core.py
Syncing Grains¶
Syncing grains can be done a number of ways, they are automatically synced when
state.highstate
is called, or (as noted
above) the grains can be manually synced and reloaded by calling the
saltutil.sync_grains
or
saltutil.sync_all
functions.