saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #39297 from cro/pg_returner_docs

Browse source 
Add doc to recommend pgjsonb for master job caches
This commit is contained in:
Mike Place 2017-02-09 15:49:58 -07:00 • committed by GitHub
commit f16027d30e
3 changed files with 30 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
salt/returners/pgjsonb.py
View file

@ -3,10 +3,21 @@
Return data to a PostgreSQL server with json data stored in Pg's jsonb data type
:maintainer: Dave Boucha <dave@saltstack.com>, Seth House <shouse@saltstack.com>, C. R. Oldham <cr@saltstack.com>
:maturity: new
:maturity: Stable
:depends: python-psycopg2
:platform: all
.. note::
There are three PostgreSQL returners. Any can function as an external
:ref:`master job cache <external-master-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.
To enable this returner, the minion will need the python client for PostgreSQL
installed and the following values configured in the minion or master
config. These are the defaults:

12
salt/returners/postgres.py
View file

@ -3,11 +3,15 @@
Return data to a postgresql server
.. note::
There are three PostgreSQL returners. Any can function as an external
:ref:`master job cache <external-master-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>`
is recommended instead of this module when using PostgreSQL as a
:ref:`master job cache <external-master-cache>`. These two modules
provide different functionality so you should compare each to see which
module best suits your particular needs.
to see which module best suits your particular needs.
:maintainer: None
:maturity: New

16
salt/returners/postgres_local_cache.py
View file

@ -4,14 +4,18 @@ Use a postgresql server for the master job cache. This helps the job cache to
cope with scale.
.. note::
:mod:`returners.postgres <salt.returners.postgres>` is also available if
you are not using PostgreSQL as a :ref:`master job cache
<external-master-cache>`. These two modules provide different
functionality so you should compare each to see which module best suits
your particular needs.
There are three PostgreSQL returners. Any can function as an external
:ref:`master job cache <external-master-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: gjredelinghuys@gmail.com
:maturity: New
:maturity: Stable
:depends: psycopg2
:platform: all