Current File : //lib/python2.7/site-packages/salt/renderers/pyobjects.pyc
�
���^c @@ sI d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m Z d d l
Z d d l Z d d l
m Z d d l m Z m Z m Z m Z d d l m Z e j d � Z e j d � Z e j d � Z e j e � Z y e e d
<Wn e k
ri Z n Xd e f d � � YZ d
� Z d d e d � Z! d S( ub&
Python renderer that includes a Pythonic Object based interface
:maintainer: Evan Borgstrom <evan@borgstrom.ca>
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.
.. code-block:: python
:linenos:
#!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.
Creating 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. ``File``, ``Service``, ``User``, etc), and these
objects expose all of their available state functions (i.e. ``File.managed``,
``Service.running``, etc).
The name of the state is split based upon underscores (``_``), then each part
is capitalized and finally the parts are joined back together.
Some examples:
* ``postgres_user`` becomes ``PostgresUser``
* ``ssh_known_hosts`` becomes ``SshKnownHosts``
Context Managers and requisites
-------------------------------
How about something a little more complex. Here we're going to get into the
core of how to use pyobjects to write states.
.. code-block:: python
:linenos:
#!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.
.. code-block:: python
:linenos:
#!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.
.. code-block:: python
:linenos:
#!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.
.. code-block:: python
:linenos:
#!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
``Service("my-service")``.
Including and Extending
-----------------------
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
a state.
.. code-block:: python
:linenos:
#!pyobjects
include('http', 'ssh')
Service.running(extend('apache'),
watch=[File('/etc/httpd/extra/httpd-vhosts.conf')])
Importing from other state files
--------------------------------
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
url (``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; ``import X``,
``from X import Y``, and ``from X import Y as Z``.
.. code-block:: python
:linenos:
#!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.
Caveats:
* Imported objects are ALWAYS put into the global scope of your template,
regardless of where your import statement is.
Salt object
-----------
In the spirit of the object interface for creating state data pyobjects also
provides a simple object interface to the ``__salt__`` object.
A function named ``salt`` exists in scope for your sls files and will dispatch
its attributes to the ``__salt__`` dictionary.
The following lines are functionally equivalent:
.. code-block:: python
:linenos:
#!pyobjects
ret = salt.cmd.run(bar)
ret = __salt__['cmd.run'](bar)
Pillar, grain, mine & config data
---------------------------------
Pyobjects provides shortcut functions for calling ``pillar.get``,
``grains.get``, ``mine.get`` & ``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: ``pillar()``,
``grains()``, ``mine()`` and ``config()``.
The following pairs of lines are functionally equivalent:
.. code-block:: python
:linenos:
#!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')
Map Data
--------
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.
.. code-block:: python
:linenos:
#!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'
.. note::
By default, the ``os_family`` grain will be used as the target for
matching. This can be overridden by specifying a ``__grain__`` attribute.
If 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:
1. Minions with an ``os_family`` of **Debian** will be assigned the
attributes defined in the **Debian** class.
2. Minions with an ``os`` grain of **Ubuntu** will be assigned the
attributes defined in the **Ubuntu** class.
3. 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**
and an ``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 ``priority``.
Given the above example, ``os_family`` matches will be processed first,
with ``os`` matches processed after. This would have the effect of
assigning ``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 ``service``
attribute of ``samba``, since ``os_family`` matches would have been
processed second.
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
file ``samba/map.sls``, you could do the following.
.. code-block:: python
:linenos:
#!pyobjects
from salt://samba/map.sls import Samba
with Pkg.installed("samba", names=[Samba.server, Samba.client]):
Service.running("samba", name=Samba.service)
i ( t absolute_importt print_functiont unicode_literalsN( t six( t get_file_client( t Registryt StateFactoryt
SaltObjectt Mapu' ^\s*from\s+(salt:\/\/.*)\s+import (.*)$u ^\s*import\s+(salt:\/\/.*)$u ^(.*) as (.*)$u pyobjects_loadedt PyobjectsModulec B@ s e Z d Z d � Z d � Z RS( u) This provides a wrapper for bare imports.c C@ s | | _ | | _ d S( N( t namet __dict__( t selfR
t attrs( ( s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyt __init__K s c C@ s d j | j � S( Nu <module '{0!s}' (pyobjects)>( t formatR
( R ( ( s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyt __repr__O s ( t __name__t
__module__t __doc__R R ( ( ( s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyR H s c C@ s� i } t j j t � t d <t t d <t j j t � } t j j t d | �} t j j t � } t j j t | | | � } xn t j
| � D]] \ } } d | k r� q� n | j d d � \ } } | | k r� i | | <n | | | | <q� W| t d <d S( u9
This loads our states into the salt __context__
u grainsu pillart utilsu .i u pyobjects_statesN(
t saltt loadert grainst __opts__t
__pillar__R t minion_modst serializerst statesR t iteritemst splitt __context__( R t
lazy_utilst
lazy_funcst lazy_serializerst lazy_statest keyt funct mod_namet func_name( ( s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyt load_statesS s$
u baseu c @ s� d t k r t � n i � i t d 6} x� t d D]� } i } d j g | j d � D] } | j � ^ qV � } d j t d | � }
d j | | |
� } t j | | | � | | � | <q4 Wt j
� d <t j � d <t t
_ t
� d <y_ � j i t t � d
6t d d 6t d
d 6t d d 6t d d 6t d 6t d 6t d 6� Wn t k
ran X| sl� St t � � t t _ � � � � f d � � � | � \ } }
� j |
� t t _ t j | � � t j � S( Nu pyobjects_statesu StateFactoryu u _u ','u0 {0} = StateFactory('{1!s}', valid_funcs=['{2}'])u includeu extendu Mapu saltu
pillar.getu pillaru
grains.getu grainsu mine.getu mineu
config.getu configu __salt__u
__pillar__u
__grains__c @ s= g } t � � } x| j � D]} | j d � } t } x�t t f D]�} | j | � } | sh qG n | j d � j � } y | j d � j d � } Wn t
k
r� d } n X� j | � � } | s� t
d j | � � � n t j j j | � � }
� |
� \ } } Wd QXt j | | � | d k rgt j j t j j | � � d }
t |
| � | |
<n� x� | D]� } | j � } } t j | � } | d k r�| j d � j � } | j d � j � } n | | k r�t
d j | | � � � n | | | | <qnWt } PqG W| s | j | � q q Wd j | � | f S( Nu
i i u ,u Could not find the file '{0}'i u '{0}' was not found in '{1}'u
( t dictt readlinest rstript Falset IMPORT_REt FROM_REt matcht groupt stripR t
IndexErrort Nonet
cache_filet ImportErrorR R R t filest fopenR t exec_t ost patht splitextt basenameR t
FROM_AS_REt Truet appendt join( t templatet
template_datat template_globalst linet matchedt REt matchest import_filet importst
state_filet state_fht state_contentst
state_globalst import_nameR
t alias( t _globalst clientt process_templatet saltenv( s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyRR � sR
"
( R R( R R@ R t
capitalizeR R R8 R t includet make_extendt __salt__R t updateR R t
__grains__t NameErrorR R R, t enabledR> t salt_data( RA RS t slsR\ t kwargst mod_globalst modt
mod_localst partt mod_camelt valid_funcst mod_cmdt final_templatet
final_globals( ( RP RQ RR RS s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyt renderp sV
(
?
(" R t
__future__R R R t loggingR9 t ret salt.extR t salt.utils.filesR t salt.loadert salt.fileclientR t salt.utils.pyobjectsR R R R t compileR. R- R= t getLoggerR t logR> R RZ t objectR R( Rh ( ( ( s< /usr/lib/python2.7/site-packages/salt/renderers/pyobjects.pyt <module>* s* "
Mini Shell