Python renderer that includes a Pythonic Object based interface
Evan Borgstrom <email@example.com>
Let's take a look at how you use pyobjects in a state file. Here's a quick
example that ensures the
/tmp directory is in the correct state.
1 2 3
#!pyobjects File.managed("/tmp", user='root', group='root', mode='1777')
Nice and Pythonic!
By using the "shebang" syntax to switch to the pyobjects renderer we can now write our state data using an object based interface that should feel at home to python developers. You can import any module and do anything that you'd like (with caution, importing sqlalchemy, django or other large frameworks has not been tested yet). Using the pyobjects renderer is exactly the same as using the built-in Python renderer with the exception that pyobjects provides you with an object based interface for generating state data.
Pyobjects takes care of creating an object for each of the available states on
the minion. Each state is represented by an object that is the CamelCase
version of its name (i.e.
User, etc), and these
objects expose all of their available state functions (i.e.
The name of the state is split based upon underscores (
_), then each part
is capitalized and finally the parts are joined back together.
How about something a little more complex. Here we're going to get into the core of how to use pyobjects to write states.
1 2 3 4 5 6 7 8 9
#!pyobjects with Pkg.installed("nginx"): Service.running("nginx", enable=True) with Service("nginx", "watch_in"): File.managed("/etc/nginx/conf.d/mysite.conf", owner='root', group='root', mode='0444', source='salt://nginx/mysite.conf')
The objects that are returned from each of the magic method calls are setup to
be used a Python context managers (
with) and when you use them as such all
declarations made within the scope will automatically use the enclosing
state as a requisite!
The above could have also been written use direct requisite statements as.
1 2 3 4 5 6 7 8
#!pyobjects Pkg.installed("nginx") Service.running("nginx", enable=True, require=Pkg("nginx")) File.managed("/etc/nginx/conf.d/mysite.conf", owner='root', group='root', mode='0444', source='salt://nginx/mysite.conf', watch_in=Service("nginx"))
You can use the direct requisite statement for referencing states that are generated outside of the current file.
1 2 3 4
#!pyobjects # some-other-package is defined in some other state file Pkg.installed("nginx", require=Pkg("some-other-package"))
The last thing that direct requisites provide is the ability to select which of the SaltStack requisites you want to use (require, require_in, watch, watch_in, use & use_in) when using the requisite as a context manager.
1 2 3 4
#!pyobjects with Service("my-service", "watch_in"): ...
The above example would cause all declarations inside the scope of the context
manager to automatically have their
watch_in set to
To include other states use the
include() function. It takes one name per
state to include.
To extend another state use the
extend() function on the name when creating
1 2 3 4 5 6
#!pyobjects include('http', 'ssh') Service.running(extend('apache'), watch=[File('/etc/httpd/extra/httpd-vhosts.conf')])
Like any Python project that grows you will likely reach a point where you want to create reusability in your state tree and share objects between state files, Map Data (described below) is a perfect example of this.
To facilitate this Python's
import statement has been augmented to allow
for a special case when working with a Salt state tree. If you specify a Salt
salt://...) as the target for importing from then the pyobjects
renderer will take care of fetching the file for you, parsing it with all of
the pyobjects features available and then place the requested objects in the
global scope of the template being rendered.
This works for all types of import statements;
from X import Y, and
from X import Y as Z.
1 2 3 4 5
#!pyobjects import salt://myfile.sls from salt://something/data.sls import Object from salt://something/data.sls import Object as Other
See the Map Data section for a more practical use.
Imported objects are ALWAYS put into the global scope of your template, regardless of where your import statement is.
In the spirit of the object interface for creating state data pyobjects also
provides a simple object interface to the
A function named
salt exists in scope for your sls files and will dispatch
its attributes to the
The following lines are functionally equivalent:
1 2 3 4
#!pyobjects ret = salt.cmd.run(bar) ret = __salt__['cmd.run'](bar)
Pyobjects provides shortcut functions for calling
config.get on the
__salt__ object. This
helps maintain the readability of your state files.
Each type of data can be access by a function of the same name:
The following pairs of lines are functionally equivalent:
1 2 3 4 5 6 7 8 9 10 11 12 13
#!pyobjects value = pillar('foo:bar:baz', 'qux') value = __salt__['pillar.get']('foo:bar:baz', 'qux') value = grains('pkg:apache') value = __salt__['grains.get']('pkg:apache') value = mine('os:Fedora', 'network.interfaces', 'grain') value = __salt__['mine.get']('os:Fedora', 'network.interfaces', 'grain') value = config('foo:bar:baz', 'qux') value = __salt__['config.get']('foo:bar:baz', 'qux')
When building complex states or formulas you often need a way of building up a map of data based on grain data. The most common use of this is tracking the package and service name differences between distributions.
To build map data using pyobjects we provide a class named Map that you use to build your own classes with inner classes for each set of values for the different grain matches.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
#!pyobjects class Samba(Map): merge = 'samba:lookup' # NOTE: priority is new to 2017.7.0 priority = ('os_family', 'os') class Ubuntu: __grain__ = 'os' service = 'smbd' class Debian: server = 'samba' client = 'samba-client' service = 'samba' class RHEL: __match__ = 'RedHat' server = 'samba' client = 'samba' service = 'smb'
By default, the
os_family grain will be used as the target for
matching. This can be overridden by specifying a
__match__ attribute is defined for a given class, then that value
will be matched against the targeted grain, otherwise the class name's
value will be be matched.
Given the above example, the following is true:
Minions with an
os_family of Debian will be assigned the
attributes defined in the Debian class.
Minions with an
os grain of Ubuntu will be assigned the
attributes defined in the Ubuntu class.
Minions with an
os_family grain of RedHat will be assigned the
attributes defined in the RHEL class.
That said, sometimes a minion may match more than one class. For instance,
in the above example, Ubuntu minions will match both the Debian and
Ubuntu classes, since Ubuntu has an
os_family grain of Debian
os grain of Ubuntu. As of the 2017.7.0 release, the order is
dictated by the order of declaration, with classes defined later overriding
earlier ones. Additionally, 2017.7.0 adds support for explicitly defining
the ordering using an optional attribute called
Given the above example,
os_family matches will be processed first,
os matches processed after. This would have the effect of
smbd as the
service attribute on Ubuntu minions. If the
priority item was not defined, or if the order of the items in the
priority tuple were reversed, Ubuntu minions would have a
os_family matches would have been
To use this new data you can import it into your state file and then access
your attributes. To access the data in the map you simply access the attribute
name on the base class that is extending Map. Assuming the above Map was in the
samba/map.sls, you could do the following.
1 2 3 4 5 6
#!pyobjects from salt://samba/map.sls import Samba with Pkg.installed("samba", names=[Samba.server, Samba.client]): Service.running("samba", name=Samba.service)
This provides a wrapper for bare imports.
This loads our states into the salt __context__
render(template, saltenv='base', sls='', salt_data=True, **kwargs)¶