Salt sls files can include other sls files and exclude sls files that have been otherwise included. This allows for an sls file to easily extend or manipulate other sls files.
When other sls files are included, everything defined in the included sls file will be added to the state run. When including define a list of sls formulas to include:
include:
- http
- libvirt
The include statement will include sls formulas from the same environment that the including sls formula is in. But the environment can be explicitly defined in the configuration to override the running environment, therefore if an sls formula needs to be included from an external environment named "dev" the following syntax is used:
include:
- dev: http
NOTE: include does not simply inject the states where you place it in the sls file. If you need to guarantee order of execution, consider using requisites.
Do not use dots in SLS file names
The initial implementation of top.sls
and
Include declaration followed the python import model where a slash
is represented as a period. This means that a SLS file with a period in
the name ( besides the suffix period) can not be referenced. For example,
webserver_1.0.sls is not referenceable because webserver_1.0 would refer
to the directory/file webserver_1/0.sls
In Salt 0.16.0 the capability to include sls formulas which are relative to the running sls formula was added, simply precede the formula name with a .:
include:
- .virt
- .virt.hyper
The exclude statement, added in Salt 0.10.3 allows an sls to hard exclude another sls file or a specific id. The component is excluded after the high data has been compiled, so nothing should be able to override an exclude.
Since the exclude can remove an id or an sls the type of component to exclude needs to be defined. an exclude statement that verifies that the running highstate does not contain the http sls and the /etc/vimrc id would look like this:
exclude:
- sls: http
- id: /etc/vimrc