Current File : //usr/lib/python2.7/site-packages/salt/pillar/mongo.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l m Z y d d l Z e
Z Wn e k
ry e
Z n Xi d d 6d d 6d d 6d
d 6d d 6Z d
� Z e j e � Z d d d d d d � Z d S( u
Read Pillar data from a mongodb collection
:depends: pymongo (for salt-master)
This module will load a node-specific pillar dictionary from a mongo
collection. It uses the node's id for lookups and can load either the whole
document, or just a specific field from that
document as the pillar dictionary.
Salt Master Mongo Configuration
===============================
The module shares the same base mongo connection variables as
:py:mod:`salt.returners.mongo_return`. These variables go in your master
config file.
* ``mongo.db`` - The mongo database to connect to. Defaults to ``'salt'``.
* ``mongo.host`` - The mongo host to connect to. Supports replica sets by
specifying all hosts in the set, comma-delimited. Defaults to ``'salt'``.
* ``mongo.port`` - The port that the mongo database is running on. Defaults
to ``27017``.
* ``mongo.user`` - The username for connecting to mongo. Only required if
you are using mongo authentication. Defaults to ``''``.
* ``mongo.password`` - The password for connecting to mongo. Only required
if you are using mongo authentication. Defaults to ``''``.
Configuring the Mongo ext_pillar
================================
The Mongo ext_pillar takes advantage of the fact that the Salt Master
configuration file is yaml. It uses a sub-dictionary of values to adjust
specific features of the pillar. This is the explicit single-line dictionary
notation for yaml. One may be able to get the easier-to-read multi-line dict to
work correctly with some experimentation.
.. code-block:: yaml
ext_pillar:
- mongo: {collection: vm, id_field: name, re_pattern: \.example\.com, fields: [customer_id, software, apache_vhosts]}
In the example above, we've decided to use the ``vm`` collection in the
database to store the data. Minion ids are stored in the ``name`` field on
documents in that collection. And, since minion ids are FQDNs in most cases,
we'll need to trim the domain name in order to find the minion by hostname in
the collection. When we find a minion, return only the ``customer_id``,
``software``, and ``apache_vhosts`` fields, as that will contain the data we
want for a given node. They will be available directly inside the ``pillar``
dict in your SLS templates.
Module Documentation
====================
i ( t absolute_importt print_functiont unicode_literalsN( t sixu saltu mongo.dbu
mongo.hostu u mongo.passwordi�i u
mongo.portu
mongo.userc C@ s t s
t Sd S( Nu mongo( t HAS_PYMONGOt False( ( ( s5 /usr/lib/python2.7/site-packages/salt/pillar/mongo.pyt __virtual__O s u pillaru _idc C@ sg t d } t d } t j d | | � t j | | � } t j d t d � | t d }
t j d � } t j d � } | r� | r� t j d | � |
j | | � n | r� t j | | | � } n t j d | | � |
| j
i | | 6d
| �}
|
rO| rt j d | � n
t j d � d
|
k rKt j |
d
� |
d
<n |
St j d | � i Sd S( u
Connect to a mongo database and read per-node pillar information.
Parameters:
* `collection`: The mongodb collection to read data from. Defaults to
``'pillar'``.
* `id_field`: The field in the collection that represents an individual
minion id. Defaults to ``'_id'``.
* `re_pattern`: If your naming convention in the collection is shorter
than the minion id, you can use this to trim the name.
`re_pattern` will be used to match the name, and `re_replace` will
be used to replace it. Backrefs are supported as they are in the
Python standard library. If ``None``, no mangling of the name will
be performed - the collection will be searched with the entire
minion id. Defaults to ``None``.
* `re_replace`: Use as the replacement value in node ids matched with
`re_pattern`. Defaults to ''. Feel free to use backreferences here.
* `fields`: The specific fields in the document to use for the pillar
data. If ``None``, will use the entire document. If using the
entire document, the ``_id`` field will be converted to string. Be
careful with other fields in the document as they must be string
serializable. Defaults to ``None``.
u
mongo.hostu
mongo.portu( connecting to %s:%s for mongo ext_pillaru using database '%s'u mongo.dbu
mongo.useru mongo.passwordu authenticating as '%s'uA ext_pillar.mongo: looking up pillar def for {'%s': '%s'} in mongot
projectionu7 ext_pillar.mongo: found document, returning fields '%s'u5 ext_pillar.mongo: found document, returning whole docu _idu4 ext_pillar.mongo: no document found in collection %sN(
t __opts__t logt infot pymongot MongoClientt debugt gett authenticatet ret subt find_oneR t text_type( t minion_idt pillart
collectiont id_fieldt
re_patternt
re_replacet fieldst hostt portt connt mdbt usert passwordt result( ( s5 /usr/lib/python2.7/site-packages/salt/pillar/mongo.pyt
ext_pillarY s<
( t __doc__t
__future__R R R t loggingR t salt.extR R t TrueR t ImportErrorR R R t getLoggert __name__R t NoneR" ( ( ( s5 /usr/lib/python2.7/site-packages/salt/pillar/mongo.pyt <module>8 s*
Mini Shell