Merge pull request #43349 from michelsen/add-rethinkdb-external-pillar

Added RethinkDB external pillar module

salt/pillar/rethinkdb_pillar.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+'''
+Provide external pillar data from RethinkDB
+
+.. versionadded:: Oxygen
+
+:depends: rethinkdb (on the salt-master)
+
+
+salt master rethinkdb configuration
+===================================
+These variables must be configured in your master configuration file.
+    * ``rethinkdb.host`` - The RethinkDB server. Defaults to ``'salt'``
+    * ``rethinkdb.port`` - The port the RethinkDB server listens on.
+      Defaults to ``'28015'``
+    * ``rethinkdb.database`` - The database to connect to.
+      Defaults to ``'salt'``
+    * ``rethinkdb.username`` - The username for connecting to RethinkDB.
+      Defaults to ``''``
+    * ``rethinkdb.password`` - The password for connecting to RethinkDB.
+      Defaults to ``''``
+
+
+salt-master ext_pillar configuration
+====================================
+
+The ext_pillar function arguments are given in single line dictionary notation.
+
+.. code-block:: yaml
+
+  ext_pillar:
+    - rethinkdb: {table: ext_pillar, id_field: minion_id, field: pillar_root, pillar_key: external_pillar}
+
+In the example above the following happens.
+    * The salt-master will look for external pillars in the 'ext_pillar' table
+      on the RethinkDB host
+    * The minion id will be matched against the 'minion_id' field
+    * Pillars will be retrieved from the nested field 'pillar_root'
+    * Found pillars will be merged inside a key called 'external_pillar'
+
+
+Module Documentation
+====================
+'''
+from __future__ import absolute_import
+
+# Import python libraries
+import logging
+
+# Import 3rd party libraries
+try:
+    import rethinkdb
+    HAS_RETHINKDB = True
+except ImportError:
+    HAS_RETHINKDB = False
+
+__virtualname__ = 'rethinkdb'
+
+__opts__ = {
+    'rethinkdb.host': 'salt',
+    'rethinkdb.port': '28015',
+    'rethinkdb.database': 'salt',
+    'rethinkdb.username': None,
+    'rethinkdb.password': None
+}
+
+
+def __virtual__():
+    if not HAS_RETHINKDB:
+        return False
+    return True
+
+
+# Configure logging
+log = logging.getLogger(__name__)
+
+
+def ext_pillar(minion_id,
+               pillar,
+               table='pillar',
+               id_field=None,
+               field=None,
+               pillar_key=None):
+    '''
+    Collect minion external pillars from a RethinkDB database
+
+    Arguments:
+    * `table`: The RethinkDB table containing external pillar information.
+      Defaults to ``'pillar'``
+    * `id_field`: Field in document containing the minion id.
+      If blank then we assume the table index matches minion ids
+    * `field`: Specific field in the document used for pillar data, if blank
+      then the entire document will be used
+    * `pillar_key`: The salt-master will nest found external pillars under
+      this key before merging into the minion pillars. If blank, external
+      pillars will be merged at top level
+    '''
+    host = __opts__['rethinkdb.host']
+    port = __opts__['rethinkdb.port']
+    database = __opts__['rethinkdb.database']
+    username = __opts__['rethinkdb.username']
+    password = __opts__['rethinkdb.password']
+
+    log.debug('Connecting to {0}:{1} as user \'{2}\' for RethinkDB ext_pillar'
+              .format(host, port, username))
+
+    # Connect to the database
+    conn = rethinkdb.connect(host=host,
+                             port=port,
+                             db=database,
+                             user=username,
+                             password=password)
+
+    data = None
+
+    try:
+
+        if id_field:
+            log.debug('ext_pillar.rethinkdb: looking up pillar. '
+                      'table: {0}, field: {1}, minion: {2}'.format(
+                          table, id_field, minion_id))
+
+            if field:
+                data = rethinkdb.table(table).filter(
+                    {id_field: minion_id}).pluck(field).run(conn)
+            else:
+                data = rethinkdb.table(table).filter(
+                    {id_field: minion_id}).run(conn)
+
+        else:
+            log.debug('ext_pillar.rethinkdb: looking up pillar. '
+                      'table: {0}, field: id, minion: {1}'.format(
+                          table, minion_id))
+
+            if field:
+                data = rethinkdb.table(table).get(minion_id).pluck(field).run(
+                    conn)
+            else:
+                data = rethinkdb.table(table).get(minion_id).run(conn)
+
+    finally:
+        if conn.is_open():
+            conn.close()
+
+    if data.items:
+
+        # Return nothing if multiple documents are found for a minion
+        if len(data.items) > 1:
+            log.error('ext_pillar.rethinkdb: ambiguous documents found for '
+                      'minion {0}'.format(minion_id))
+            return {}
+
+        else:
+            result = data.items.pop()
+
+        if pillar_key:
+            return {pillar_key: result}
+        return result
+
+    else:
+        # No document found in the database
+        log.debug('ext_pillar.rethinkdb: no document found')
+        return {}