salt.returners.couchdb_return
Simple returner for CouchDB. Optional configuration settings are listed below, along with sane defaults:
couchdb.db: 'salt'
couchdb.url: 'http://salt:5984/'
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:
alternative.couchdb.db: 'salt'
alternative.couchdb.url: 'http://salt:5984/'
To use the couchdb returner, append --return couchdb to the salt command. Example:
salt '*' test.ping --return couchdb
To use the alternative configuration, append --return_config alternative to the salt command.
New in version 2015.5.0.
salt '*' test.ping --return couchdb --return_config alternative
On concurrent database access
As this returner creates a couchdb document whith the salt job id as document id
and as only one document with a given id can exist in a given couchdb database,
it is advised for most setups that every minion be configured to write to it own
database (the value of couchdb.db may be suffixed with the minion id),
otherwise multi-minion targetting can lead to losing output:
- the first returning minion is able to create a document in the database
- other minions fail with
{'error': 'HTTP Error 409: Conflict'}
-
salt.returners.couchdb_return.ensure_views() This function makes sure that all the views that should exist in the design document do exist.
-
salt.returners.couchdb_return.get_fun(fun) Return a dict with key being minion and value being the job details of the last run of function 'fun'.
-
salt.returners.couchdb_return.get_minions() Return a list of minion identifiers from a request of the view.
-
salt.returners.couchdb_return.get_valid_salt_views() Returns a dict object of views that should be part of the salt design document.
-
salt.returners.couchdb_return.prep_jid(nocache=False, passed_jid=None) Do any work necessary to prepare a JID, including sending a custom id
