Current File : //lib/python2.7/site-packages/salt/returners/postgres.pyo
�
���^c @@ sc d Z d d l m Z m Z m 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 Z
d d l
Z
d d l m Z y d d l Z e Z Wn e k
r� e Z n Xd Z e j e � Z d � Z d d � Z e d e d � � Z d
� Z d � Z d d � Z d d
� Z d � Z! d � Z" d � Z# d � Z$ d � Z% e d d � Z& d S( u�
Return data to a postgresql server
.. note::
There are three PostgreSQL returners. Any can function as an external
:ref:`master job cache <external-job-cache>`. but each has different
features. SaltStack recommends
:mod:`returners.pgjsonb <salt.returners.pgjsonb>` if you are working with
a version of PostgreSQL that has the appropriate native binary JSON types.
Otherwise, review
:mod:`returners.postgres <salt.returners.postgres>` and
:mod:`returners.postgres_local_cache <salt.returners.postgres_local_cache>`
to see which module best suits your particular needs.
:maintainer: None
:maturity: New
:depends: psycopg2
:platform: all
To enable this returner the minion will need the psycopg2 installed and
the following values configured in the minion or master config:
.. code-block:: yaml
returner.postgres.host: 'salt'
returner.postgres.user: 'salt'
returner.postgres.passwd: 'salt'
returner.postgres.db: 'salt'
returner.postgres.port: 5432
Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location:
.. code-block:: yaml
alternative.returner.postgres.host: 'salt'
alternative.returner.postgres.user: 'salt'
alternative.returner.postgres.passwd: 'salt'
alternative.returner.postgres.db: 'salt'
alternative.returner.postgres.port: 5432
Running the following commands as the postgres user should create the database
correctly:
.. code-block:: sql
psql << EOF
CREATE ROLE salt WITH PASSWORD 'salt';
CREATE DATABASE salt WITH OWNER salt;
EOF
psql -h localhost -U salt << EOF
--
-- Table structure for table 'jids'
--
DROP TABLE IF EXISTS jids;
CREATE TABLE jids (
jid varchar(20) PRIMARY KEY,
load text NOT NULL
);
--
-- Table structure for table 'salt_returns'
--
DROP TABLE IF EXISTS salt_returns;
CREATE TABLE salt_returns (
fun varchar(50) NOT NULL,
jid varchar(255) NOT NULL,
return text NOT NULL,
full_ret text,
id varchar(255) NOT NULL,
success varchar(10) NOT NULL,
alter_time TIMESTAMP WITH TIME ZONE DEFAULT now()
);
CREATE INDEX idx_salt_returns_id ON salt_returns (id);
CREATE INDEX idx_salt_returns_jid ON salt_returns (jid);
CREATE INDEX idx_salt_returns_fun ON salt_returns (fun);
CREATE INDEX idx_salt_returns_updated ON salt_returns (alter_time);
--
-- Table structure for table `salt_events`
--
DROP TABLE IF EXISTS salt_events;
DROP SEQUENCE IF EXISTS seq_salt_events_id;
CREATE SEQUENCE seq_salt_events_id;
CREATE TABLE salt_events (
id BIGINT NOT NULL UNIQUE DEFAULT nextval('seq_salt_events_id'),
tag varchar(255) NOT NULL,
data text NOT NULL,
alter_time TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
master_id varchar(255) NOT NULL
);
CREATE INDEX idx_salt_events_tag on salt_events (tag);
EOF
Required python modules: psycopg2
To use the postgres returner, append '--return postgres' to the salt command.
.. code-block:: bash
salt '*' test.ping --return postgres
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.5.0
.. code-block:: bash
salt '*' test.ping --return postgres --return_config alternative
To override individual configuration items, append --return_kwargs '{"key:": "value"}' to the salt command.
.. versionadded:: 2016.3.0
.. code-block:: bash
salt '*' test.ping --return postgres --return_kwargs '{"db": "another-salt"}'
i ( t absolute_importt print_functiont unicode_literalsN( t contextmanager( t sixu postgresc C@ s t s t d f St S( Nu> Could not import postgres returner; psycopg2 is not installed.( t HAS_POSTGRESt Falset __virtualname__( ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt __virtual__� s
c
C@ s� i d d 6d d 6d d 6d d 6d d 6} i d d 6d d 6d d 6d d 6d d 6} t j j d j t � | | d
t d t d | �} d | k r� t | d � | d <n | S(
u-
Get the postgres options from salt.
u localhostu hostu saltu useru passwdu dbi8 u portu returner.{0}t __salt__t __opts__t defaults( t saltt returnerst get_returner_optionst formatR R R
t int( t retR t attrst _options( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt _get_options� s&
c c@ s: t | � } y[ t j d | j d � d | j d � d | j d � d | j d � d | j d
� � } Wn4 t j k
r� } t j j d j d | � � � n X| j � } z~ y | VWnK t j
k
r} | j } t j
j t j | � � | j d
� | � n$ X| r| j d � n
| j d
� Wd | j � Xd S( u
Return a Pg cursor
t hostu hostt useru usert passwordu passwdt databaseu dbt portu portu6 postgres returner could not connect to database: {exc}t excu ROLLBACKu COMMITN( R t psycopg2t connectt gett OperationalErrorR t
exceptionst SaltMasterErrorR t cursort
DatabaseErrort argst syst stderrt writeR t text_typet executet close( R t commitR t connR R! t errt error( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt _get_serv� s, "
c
C@ s� y� t | d t ��i } d } | j | | d | d t j j j | d � | d | j d t � t j j j | � f � Wd QXWn$ t j j
k
r� t j d � n Xd S(
u*
Return data to a postgres server
R* u� INSERT INTO salt_returns
(fun, jid, return, id, success, full_ret)
VALUES (%s, %s, %s, %s, %s, %s)u funu jidu returnu idu successNuM Could not store return with postgres returner. PostgreSQL server unavailable.(
R. t TrueR( R t utilst jsont dumpsR R R R t logt critical( R t curt sql( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt returner� s #c C@ s� t | d t ��n } xd | D]\ } | j d d � } | j d d � } d } | j | | t j j j | � t d f � q WWd QXd S( u
Return event to Pg server
Requires that configuration be enabled via 'event_return'
option in master config.
R* u tagu u datauW INSERT INTO salt_events (tag, data, master_id)
VALUES (%s, %s, %s)u idN( R. R/ R R( R R0 R1 R2 R
( t eventsR5 t eventt tagt dataR6 ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt event_return� s
c C@ sb t d t � �M } d } y) | j | | t j j j | � f � Wn t j k
rW n XWd QXd S( u/
Save the load to the specified jid id
R* uK INSERT INTO jids
(jid, load)
VALUES (%s, %s)N( R. R/ R( R R0 R1 R2 R t IntegrityError( t jidt loadt minionsR5 R6 ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt save_load s c C@ s d S( u&
Included for API consistency
N( ( R> R@ t syndic_id( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt save_minions s c C@ sh t d d d t � �M } d } | j | | f � | j � } | rZ t j j j | d � Si SWd QXd S( u9
Return the load data that marks a specified jid
R R* u% SELECT load FROM jids WHERE jid = %s;i N( R. t NoneR/ R( t fetchoneR R0 R1 t loads( R> R5 R6 R; ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt get_load! s c C@ s� t d d d t � �o } d } | j | | f � | j � } i } | r| x0 | D]% \ } } t j j j | � | | <qP Wn | SWd QXd S( uP
Return the information returned when the specified job id was executed
R R* uD SELECT id, full_ret FROM salt_returns
WHERE jid = %sN( R. RD R/ R( t fetchallR R0 R1 RF ( R> R5 R6 R; R t miniont full_ret( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt get_jid. s c C@ s� t d d d t � �r } d } | j | | f � | j � } i } | r x3 | D]( \ } } } t j j j | � | | <qP Wn | SWd QXd S( uC
Return a dict of the last function called for all minions
R R* u SELECT s.id,s.jid, s.full_ret
FROM salt_returns s
JOIN ( SELECT MAX(`jid`) as jid
from salt_returns GROUP BY fun, id) max
ON s.jid = max.jid
WHERE s.fun = %s
N( R. RD R/ R( RH R R0 R1 RF ( t funR5 R6 R; R RI t _RJ ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt get_fun@ s c C@ s� t d d d t � �r } d } | j | � | j � } i } x? | D]7 \ } } t j j j | t j j j
| � � | | <qD W| SWd QXd S( u&
Return a list of all job ids
R R* u* SELECT jid, load
FROM jidsN( R. RD R/ R( RH R R0 R> t format_jid_instanceR1 RF ( R5 R6 R; R R> R? ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt get_jidsX s
c C@ sm t d d d t � �R } d } | j | � | j � } g } x | D] } | j | d � qD W| SWd QXd S( u"
Return a list of minions
R R* u4 SELECT DISTINCT id
FROM salt_returnsi N( R. RD R/ R( RH t append( R5 R6 R; R RI ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt get_minionsj s
c C@ s# | d k r | St j j j t � S( uO
Do any work necessary to prepare a JID, including sending a custom id
N( RD R R0 R> t gen_jidR
( t nocachet
passed_jid( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt prep_jid{ s (' t __doc__t
__future__R R R R$ t loggingt
contextlibR t salt.utils.jidR t salt.utils.jsont salt.returnerst salt.exceptionst salt.extR R R/ R t ImportErrorR R t getLoggert __name__R3 R RD R R. R7 R< RA RC RG RK RN RP RR RV ( ( ( s; /usr/lib/python2.7/site-packages/salt/returners/postgres.pyt <module>� s<
!
Mini Shell