mirror of
https://github.com/valitydev/salt.git
synced 2024-11-09 01:36:48 +00:00
Add influx module for InfluxDB 0.9+
This commit is contained in:
Wolodja Wentland
parent
8e5cdabf16
commit
00351cbb2e
499
salt/modules/influx.py
Normal file
499
salt/modules/influx.py
Normal file
@ -0,0 +1,499 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
'''
|
||||
InfluxDB - A distributed time series database
|
||||
|
||||
Module to provide InfluxDB compatibility to Salt (compatible with InfluxDB
|
||||
version 0.9+)
|
||||
|
||||
:depends: - influxdb Python module (>= 3.0.0)
|
||||
|
||||
:configuration: This module accepts connection configuration details either as
|
||||
parameters or as configuration settings in /etc/salt/minion on the relevant
|
||||
minions::
|
||||
|
||||
influxdb.host: 'localhost'
|
||||
influxdb.port: 8086
|
||||
influxdb.user: 'root'
|
||||
influxdb.password: 'root'
|
||||
|
||||
This data can also be passed into pillar. Options passed into opts will
|
||||
overwrite options passed into pillar.
|
||||
|
||||
Most functions in this module allow you to override or provide some or all
|
||||
of these settings via keyword arguments::
|
||||
|
||||
salt '*' influxdb.foo_function user='influxadmin' password='s3cr1t'
|
||||
|
||||
would override ``user`` and ``password`` while still using the defaults for
|
||||
``host`` and ``port``.
|
||||
'''
|
||||
from __future__ import absolute_import
|
||||
|
||||
try:
|
||||
import influxdb
|
||||
HAS_INFLUXDB = True
|
||||
except ImportError:
|
||||
HAS_INFLUXDB = False
|
||||
|
||||
import logging
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
# name used to refer to this module in __salt__
|
||||
__virtualname__ = 'influxdb'
|
||||
|
||||
|
||||
def __virtual__():
|
||||
'''
|
||||
Only load if influxdb lib is present
|
||||
'''
|
||||
if HAS_INFLUXDB:
|
||||
return __virtualname__
|
||||
return (False, ('The influxdb execution module could not be loaded:'
|
||||
'influxdb library not available.'))
|
||||
|
||||
|
||||
def _client(user=None, password=None, host=None, port=None, **client_args):
|
||||
if not user:
|
||||
user = __salt__['config.option']('influxdb.user', 'root')
|
||||
if not password:
|
||||
password = __salt__['config.option']('influxdb.password', 'root')
|
||||
if not host:
|
||||
host = __salt__['config.option']('influxdb.host', 'localhost')
|
||||
if not port:
|
||||
port = __salt__['config.option']('influxdb.port', 8086)
|
||||
return influxdb.InfluxDBClient(host=host,
|
||||
port=port,
|
||||
username=user,
|
||||
password=password)
|
||||
|
||||
|
||||
def list_dbs(**client_args):
|
||||
'''
|
||||
List all InfluxDB databases.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.list_dbs
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
|
||||
return client.get_list_database()
|
||||
|
||||
|
||||
def db_exists(name, **client_args):
|
||||
'''
|
||||
Checks if a database exists in InfluxDB.
|
||||
|
||||
name
|
||||
Name of the database to check.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.db_exists <name>
|
||||
'''
|
||||
if name in [db['name'] for db in list_dbs(**client_args)]:
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def create_db(name, **client_args):
|
||||
'''
|
||||
Create a database.
|
||||
|
||||
name
|
||||
Name of the database to create.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.create_db <name>
|
||||
'''
|
||||
if db_exists(name, **client_args):
|
||||
log.info('DB \'{0}\' already exists'.format(name))
|
||||
return False
|
||||
|
||||
client = _client(**client_args)
|
||||
client.create_database(name)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def drop_db(name, **client_args):
|
||||
'''
|
||||
Drop a database.
|
||||
|
||||
name
|
||||
Name of the database to drop.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.drop_db <name>
|
||||
'''
|
||||
if not db_exists(name, **client_args):
|
||||
log.info('DB \'{0}\' does not exist'.format(name))
|
||||
return False
|
||||
|
||||
client = _client(**client_args)
|
||||
client.drop_database(name)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def list_users(**client_args):
|
||||
'''
|
||||
List all users.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.list_users
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
|
||||
return client.get_list_users()
|
||||
|
||||
|
||||
def user_exists(name, **client_args):
|
||||
'''
|
||||
Check if a user exists.
|
||||
|
||||
name
|
||||
Name of the user to check.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.user_exists <name>
|
||||
'''
|
||||
if user_info(name, **client_args):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def user_info(name, **client_args):
|
||||
'''
|
||||
Get information about given user.
|
||||
|
||||
name
|
||||
Name of the user for which to get information.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.user_info <name>
|
||||
'''
|
||||
matching_users = (user for user in list_users(**client_args)
|
||||
if user.get('user') == name)
|
||||
|
||||
try:
|
||||
return next(matching_users)
|
||||
except StopIteration:
|
||||
pass
|
||||
|
||||
|
||||
def create_user(name, password, admin=False, **client_args):
|
||||
'''
|
||||
Create a user.
|
||||
|
||||
name
|
||||
Name of the user to create.
|
||||
|
||||
password
|
||||
Password of the new user.
|
||||
|
||||
admin : False
|
||||
Whether the user should have cluster administration
|
||||
privileges or not.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.create_user <name> <password>
|
||||
salt '*' influxdb.create_user <name> <password> admin=True
|
||||
'''
|
||||
if user_exists(name, **client_args):
|
||||
log.info("User '{0}' already exists".format(name))
|
||||
return False
|
||||
|
||||
client = _client(**client_args)
|
||||
client.create_user(name, password, admin)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def set_user_password(name, password, **client_args):
|
||||
'''
|
||||
Change password of a user.
|
||||
|
||||
name
|
||||
Name of the user for whom to set the password.
|
||||
|
||||
password
|
||||
New password of the user.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.set_user_password <name> <password>
|
||||
'''
|
||||
if not user_exists(name, **client_args):
|
||||
log.info('User \'{0}\' does not exist'.format(name))
|
||||
return False
|
||||
|
||||
client = _client(**client_args)
|
||||
client.set_user_password(name, password)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def grant_admin_privileges(name, **client_args):
|
||||
'''
|
||||
Grant cluster administration privileges to a user.
|
||||
|
||||
name
|
||||
Name of the user to whom admin privileges will be granted.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.grant_admin_privileges <name>
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
client.grant_admin_privileges(name)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def revoke_admin_privileges(name, **client_args):
|
||||
'''
|
||||
Revoke cluster administration privileges from a user.
|
||||
|
||||
name
|
||||
Name of the user from whom admin privileges will be revoked.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.revoke_admin_privileges <name>
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
client.revoke_admin_privileges(name)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def remove_user(name, **client_args):
|
||||
'''
|
||||
Remove a user.
|
||||
|
||||
name
|
||||
Name of the user to remove
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.remove_user <name>
|
||||
'''
|
||||
if not user_exists(name, **client_args):
|
||||
log.info('User \'{0}\' does not exist'.format(name))
|
||||
return False
|
||||
|
||||
client = _client(**client_args)
|
||||
client.drop_user(name)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def get_retention_policy(database, name, **client_args):
|
||||
'''
|
||||
Get an existing retention policy.
|
||||
|
||||
database
|
||||
Name of the database for which the retention policy was
|
||||
defined.
|
||||
|
||||
name
|
||||
Name of the retention policy.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.get_retention_policy metrics default
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
|
||||
try:
|
||||
return next((p for p in client.get_list_retention_policies(database)
|
||||
if p.get('name') == name))
|
||||
except StopIteration:
|
||||
return {}
|
||||
|
||||
|
||||
def retention_policy_exists(database, name, **client_args):
|
||||
'''
|
||||
Check if retention policy with given name exists.
|
||||
|
||||
database
|
||||
Name of the database for which the retention policy was
|
||||
defined.
|
||||
|
||||
name
|
||||
Name of the retention policy to check.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.retention_policy_exists metrics default
|
||||
'''
|
||||
if get_retention_policy(database, name, **client_args):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def create_retention_policy(database,
|
||||
name,
|
||||
duration,
|
||||
replication,
|
||||
default=False,
|
||||
**client_args):
|
||||
'''
|
||||
Create a retention policy.
|
||||
|
||||
database
|
||||
Name of the database for which the retention policy will be created.
|
||||
|
||||
name
|
||||
Name of the new retention policy.
|
||||
|
||||
duration
|
||||
Duration of the new retention policy.
|
||||
|
||||
Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported and mean
|
||||
1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks, respectively. For
|
||||
infinite retention – meaning the data will never be deleted – use 'INF'
|
||||
for duration. The minimum retention period is 1 hour.
|
||||
|
||||
replication
|
||||
Replication factor of the retention policy.
|
||||
|
||||
This determines how many independent copies of each data point are
|
||||
stored in a cluster.
|
||||
|
||||
default : False
|
||||
Whether or not the policy as default will be set as default.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.create_retention_policy metrics default 1d 1
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
client.create_retention_policy(name, duration, replication, database,
|
||||
default)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def alter_retention_policy(database,
|
||||
name,
|
||||
duration,
|
||||
replication,
|
||||
default=False,
|
||||
**client_args):
|
||||
'''
|
||||
Modify an existing retention policy.
|
||||
|
||||
name
|
||||
Name of the retention policy to modify.
|
||||
|
||||
database
|
||||
Name of the database for which the retention policy was defined.
|
||||
|
||||
duration
|
||||
New duration of given retention policy.
|
||||
|
||||
Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported
|
||||
and mean 1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks,
|
||||
respectively. For infinite retention – meaning the data will
|
||||
never be deleted – use 'INF' for duration.
|
||||
The minimum retention period is 1 hour.
|
||||
|
||||
replication
|
||||
New replication of given retention policy.
|
||||
|
||||
This determines how many independent copies of each data point are
|
||||
stored in a cluster.
|
||||
|
||||
default : False
|
||||
Whether or not to set the modified policy as default.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' influxdb.alter_retention_policy metrics default 1d 1
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
client.alter_retention_policy(name, database, duration, replication,
|
||||
default)
|
||||
return True
|
||||
|
||||
|
||||
def grant_privilege(database, privilege, username, **client_args):
|
||||
'''
|
||||
Grant a privilege on a database to a user.
|
||||
|
||||
database
|
||||
Name of the database to grant the privilege on.
|
||||
|
||||
privilege
|
||||
Privilege to grant. Can be one of 'read', 'write' or 'all'.
|
||||
|
||||
username
|
||||
Name of the user to grant the privilege to.
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
client.grant_privilege(privilege, database, username)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def revoke_privilege(database, privilege, username, **client_args):
|
||||
'''
|
||||
Revoke a privilege on a database from a user.
|
||||
|
||||
database
|
||||
Name of the database to grant the privilege on.
|
||||
|
||||
privilege
|
||||
Privilege to grant. Can be one of 'read', 'write' or 'all'.
|
||||
|
||||
username
|
||||
Name of the user to grant the privilege to.
|
||||
'''
|
||||
client = _client(**client_args)
|
||||
client.revoke_privilege(privilege, database, username)
|
||||
|
||||
return True
|
||||
Loading…
Reference in New Issue
Block a user