Initial commit

plugins/modules/database/influxdb/influxdb_database.py

@@ -0,0 +1,146 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2016, Kamil Szczygiel <kamil.szczygiel () intel.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = r'''
+---
+module: influxdb_database
+short_description: Manage InfluxDB databases
+description:
+    - Manage InfluxDB databases.
+author: "Kamil Szczygiel (@kamsz)"
+requirements:
+    - "python >= 2.6"
+    - "influxdb >= 0.9 & <= 1.2.4"
+    - requests
+options:
+    database_name:
+        description:
+            - Name of the database.
+        required: true
+        type: str
+    state:
+        description:
+            - Determines if the database should be created or destroyed.
+        choices: [ absent, present ]
+        default: present
+        type: str
+extends_documentation_fragment:
+- community.general.influxdb
+
+'''
+
+EXAMPLES = r'''
+# Example influxdb_database command from Ansible Playbooks
+- name: Create database
+  influxdb_database:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+
+- name: Destroy database
+  influxdb_database:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+      state: absent
+
+- name: Create database using custom credentials
+  influxdb_database:
+      hostname: "{{influxdb_ip_address}}"
+      username: "{{influxdb_username}}"
+      password: "{{influxdb_password}}"
+      database_name: "{{influxdb_database_name}}"
+      ssl: yes
+      validate_certs: yes
+'''
+
+RETURN = r'''
+# only defaults
+'''
+
+try:
+    import requests.exceptions
+    from influxdb import exceptions
+except ImportError:
+    pass
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.influxdb import InfluxDb
+
+
+def find_database(module, client, database_name):
+    database = None
+
+    try:
+        databases = client.get_list_database()
+        for db in databases:
+            if db['name'] == database_name:
+                database = db
+                break
+    except requests.exceptions.ConnectionError as e:
+        module.fail_json(msg=str(e))
+    return database
+
+
+def create_database(module, client, database_name):
+    if not module.check_mode:
+        try:
+            client.create_database(database_name)
+        except requests.exceptions.ConnectionError as e:
+            module.fail_json(msg=str(e))
+
+    module.exit_json(changed=True)
+
+
+def drop_database(module, client, database_name):
+    if not module.check_mode:
+        try:
+            client.drop_database(database_name)
+        except exceptions.InfluxDBClientError as e:
+            module.fail_json(msg=e.content)
+
+    module.exit_json(changed=True)
+
+
+def main():
+    argument_spec = InfluxDb.influxdb_argument_spec()
+    argument_spec.update(
+        database_name=dict(required=True, type='str'),
+        state=dict(default='present', type='str', choices=['present', 'absent'])
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True
+    )
+
+    state = module.params['state']
+
+    influxdb = InfluxDb(module)
+    client = influxdb.connect_to_influxdb()
+    database_name = influxdb.database_name
+    database = find_database(module, client, database_name)
+
+    if state == 'present':
+        if database:
+            module.exit_json(changed=False)
+        else:
+            create_database(module, client, database_name)
+
+    if state == 'absent':
+        if database:
+            drop_database(module, client, database_name)
+        else:
+            module.exit_json(changed=False)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/database/influxdb/influxdb_query.py

@@ -0,0 +1,106 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2017, René Moser <mail@renemoser.net>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = r'''
+---
+module: influxdb_query
+short_description: Query data points from InfluxDB
+description:
+  - Query data points from InfluxDB.
+author: "René Moser (@resmo)"
+requirements:
+  - "python >= 2.6"
+  - "influxdb >= 0.9"
+options:
+  query:
+    description:
+      - Query to be executed.
+    required: true
+    type: str
+  database_name:
+    description:
+      - Name of the database.
+    required: true
+    type: str
+extends_documentation_fragment:
+- community.general.influxdb
+
+'''
+
+EXAMPLES = r'''
+- name: Query connections
+  influxdb_query:
+    hostname: "{{ influxdb_ip_address }}"
+    database_name: "{{ influxdb_database_name }}"
+    query: "select mean(value) from connections"
+  register: connection
+
+- name: Query connections with tags filters
+  influxdb_query:
+    hostname: "{{ influxdb_ip_address }}"
+    database_name: "{{ influxdb_database_name }}"
+    query: "select mean(value) from connections where region='zue01' and host='server01'"
+  register: connection
+
+- name: Print results from the query
+  debug:
+    var: connection.query_results
+'''
+
+RETURN = r'''
+query_results:
+  description: Result from the query
+  returned: success
+  type: list
+  sample:
+    - mean: 1245.5333333333333
+      time: "1970-01-01T00:00:00Z"
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+from ansible_collections.community.general.plugins.module_utils.influxdb import InfluxDb
+
+
+class AnsibleInfluxDBRead(InfluxDb):
+
+    def read_by_query(self, query):
+        client = self.connect_to_influxdb()
+        try:
+            rs = client.query(query)
+            if rs:
+                return list(rs.get_points())
+        except Exception as e:
+            self.module.fail_json(msg=to_native(e))
+
+
+def main():
+    argument_spec = InfluxDb.influxdb_argument_spec()
+    argument_spec.update(
+        query=dict(type='str', required=True),
+        database_name=dict(required=True, type='str'),
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True
+    )
+
+    influx = AnsibleInfluxDBRead(module)
+    query = module.params.get('query')
+    results = influx.read_by_query(query)
+    module.exit_json(changed=True, query_results=results)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/database/influxdb/influxdb_retention_policy.py

@@ -0,0 +1,201 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2016, Kamil Szczygiel <kamil.szczygiel () intel.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = r'''
+---
+module: influxdb_retention_policy
+short_description: Manage InfluxDB retention policies
+description:
+    - Manage InfluxDB retention policies.
+author: "Kamil Szczygiel (@kamsz)"
+requirements:
+    - "python >= 2.6"
+    - "influxdb >= 0.9"
+    - requests
+options:
+    database_name:
+        description:
+            - Name of the database.
+        required: true
+        type: str
+    policy_name:
+        description:
+            - Name of the retention policy.
+        required: true
+        type: str
+    duration:
+        description:
+            - Determines how long InfluxDB should keep the data.
+        required: true
+        type: str
+    replication:
+        description:
+            - Determines how many independent copies of each point are stored in the cluster.
+        required: true
+        type: int
+    default:
+        description:
+            - Sets the retention policy as default retention policy.
+        type: bool
+extends_documentation_fragment:
+- community.general.influxdb
+
+'''
+
+EXAMPLES = r'''
+# Example influxdb_retention_policy command from Ansible Playbooks
+- name: create 1 hour retention policy
+  influxdb_retention_policy:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+      policy_name: test
+      duration: 1h
+      replication: 1
+      ssl: yes
+      validate_certs: yes
+
+- name: create 1 day retention policy
+  influxdb_retention_policy:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+      policy_name: test
+      duration: 1d
+      replication: 1
+
+- name: create 1 week retention policy
+  influxdb_retention_policy:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+      policy_name: test
+      duration: 1w
+      replication: 1
+
+- name: create infinite retention policy
+  influxdb_retention_policy:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+      policy_name: test
+      duration: INF
+      replication: 1
+      ssl: no
+      validate_certs: no
+'''
+
+RETURN = r'''
+# only defaults
+'''
+
+import re
+
+try:
+    import requests.exceptions
+    from influxdb import exceptions
+except ImportError:
+    pass
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.influxdb import InfluxDb
+from ansible.module_utils._text import to_native
+
+
+def find_retention_policy(module, client):
+    database_name = module.params['database_name']
+    policy_name = module.params['policy_name']
+    hostname = module.params['hostname']
+    retention_policy = None
+
+    try:
+        retention_policies = client.get_list_retention_policies(database=database_name)
+        for policy in retention_policies:
+            if policy['name'] == policy_name:
+                retention_policy = policy
+                break
+    except requests.exceptions.ConnectionError as e:
+        module.fail_json(msg="Cannot connect to database %s on %s : %s" % (database_name, hostname, to_native(e)))
+    return retention_policy
+
+
+def create_retention_policy(module, client):
+    database_name = module.params['database_name']
+    policy_name = module.params['policy_name']
+    duration = module.params['duration']
+    replication = module.params['replication']
+    default = module.params['default']
+
+    if not module.check_mode:
+        try:
+            client.create_retention_policy(policy_name, duration, replication, database_name, default)
+        except exceptions.InfluxDBClientError as e:
+            module.fail_json(msg=e.content)
+    module.exit_json(changed=True)
+
+
+def alter_retention_policy(module, client, retention_policy):
+    database_name = module.params['database_name']
+    policy_name = module.params['policy_name']
+    duration = module.params['duration']
+    replication = module.params['replication']
+    default = module.params['default']
+    duration_regexp = re.compile(r'(\d+)([hdw]{1})|(^INF$){1}')
+    changed = False
+
+    duration_lookup = duration_regexp.search(duration)
+
+    if duration_lookup.group(2) == 'h':
+        influxdb_duration_format = '%s0m0s' % duration
+    elif duration_lookup.group(2) == 'd':
+        influxdb_duration_format = '%sh0m0s' % (int(duration_lookup.group(1)) * 24)
+    elif duration_lookup.group(2) == 'w':
+        influxdb_duration_format = '%sh0m0s' % (int(duration_lookup.group(1)) * 24 * 7)
+    elif duration == 'INF':
+        influxdb_duration_format = '0'
+
+    if (not retention_policy['duration'] == influxdb_duration_format or
+            not retention_policy['replicaN'] == int(replication) or
+            not retention_policy['default'] == default):
+        if not module.check_mode:
+            try:
+                client.alter_retention_policy(policy_name, database_name, duration, replication, default)
+            except exceptions.InfluxDBClientError as e:
+                module.fail_json(msg=e.content)
+        changed = True
+    module.exit_json(changed=changed)
+
+
+def main():
+    argument_spec = InfluxDb.influxdb_argument_spec()
+    argument_spec.update(
+        database_name=dict(required=True, type='str'),
+        policy_name=dict(required=True, type='str'),
+        duration=dict(required=True, type='str'),
+        replication=dict(required=True, type='int'),
+        default=dict(default=False, type='bool')
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True
+    )
+
+    influxdb = InfluxDb(module)
+    client = influxdb.connect_to_influxdb()
+
+    retention_policy = find_retention_policy(module, client)
+
+    if retention_policy:
+        alter_retention_policy(module, client, retention_policy)
+    else:
+        create_retention_policy(module, client)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/database/influxdb/influxdb_user.py

@@ -0,0 +1,265 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2017, Vitaliy Zhhuta <zhhuta () gmail.com>
+# insipred by Kamil Szczygiel <kamil.szczygiel () intel.com> influxdb_database module
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = r'''
+---
+module: influxdb_user
+short_description: Manage InfluxDB users
+description:
+  - Manage InfluxDB users.
+author: "Vitaliy Zhhuta (@zhhuta)"
+requirements:
+  - "python >= 2.6"
+  - "influxdb >= 0.9"
+options:
+  user_name:
+    description:
+      - Name of the user.
+    required: True
+    type: str
+  user_password:
+    description:
+      - Password to be set for the user.
+    required: false
+    type: str
+  admin:
+    description:
+      - Whether the user should be in the admin role or not.
+      - Since version 2.8, the role will also be updated.
+    default: no
+    type: bool
+  state:
+    description:
+      - State of the user.
+    choices: [ absent, present ]
+    default: present
+    type: str
+  grants:
+    description:
+      - Privileges to grant to this user.
+      - Takes a list of dicts containing the "database" and "privilege" keys.
+      - If this argument is not provided, the current grants will be left alone.
+      - If an empty list is provided, all grants for the user will be removed.
+    type: list
+    elements: dict
+extends_documentation_fragment:
+- community.general.influxdb
+
+'''
+
+EXAMPLES = r'''
+- name: Create a user on localhost using default login credentials
+  influxdb_user:
+    user_name: john
+    user_password: s3cr3t
+
+- name: Create a user on localhost using custom login credentials
+  influxdb_user:
+    user_name: john
+    user_password: s3cr3t
+    login_username: "{{ influxdb_username }}"
+    login_password: "{{ influxdb_password }}"
+
+- name: Create an admin user on a remote host using custom login credentials
+  influxdb_user:
+    user_name: john
+    user_password: s3cr3t
+    admin: yes
+    hostname: "{{ influxdb_hostname }}"
+    login_username: "{{ influxdb_username }}"
+    login_password: "{{ influxdb_password }}"
+
+- name: Create a user on localhost with privileges
+  influxdb_user:
+    user_name: john
+    user_password: s3cr3t
+    login_username: "{{ influxdb_username }}"
+    login_password: "{{ influxdb_password }}"
+    grants:
+      - database: 'collectd'
+        privilege: 'WRITE'
+      - database: 'graphite'
+        privilege: 'READ'
+
+- name: Destroy a user using custom login credentials
+  influxdb_user:
+    user_name: john
+    login_username: "{{ influxdb_username }}"
+    login_password: "{{ influxdb_password }}"
+    state: absent
+'''
+
+RETURN = r'''
+#only defaults
+'''
+
+from ansible.module_utils.urls import ConnectionError
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+import ansible_collections.community.general.plugins.module_utils.influxdb as influx
+
+
+def find_user(module, client, user_name):
+    user_result = None
+
+    try:
+        users = client.get_list_users()
+        for user in users:
+            if user['user'] == user_name:
+                user_result = user
+                break
+    except (ConnectionError, influx.exceptions.InfluxDBClientError) as e:
+        module.fail_json(msg=to_native(e))
+    return user_result
+
+
+def check_user_password(module, client, user_name, user_password):
+    try:
+        client.switch_user(user_name, user_password)
+        client.get_list_users()
+    except influx.exceptions.InfluxDBClientError as e:
+        if e.code == 401:
+            return False
+    except ConnectionError as e:
+        module.fail_json(msg=to_native(e))
+    finally:
+        # restore previous user
+        client.switch_user(module.params['username'], module.params['password'])
+    return True
+
+
+def set_user_password(module, client, user_name, user_password):
+    if not module.check_mode:
+        try:
+            client.set_user_password(user_name, user_password)
+        except ConnectionError as e:
+            module.fail_json(msg=to_native(e))
+
+
+def create_user(module, client, user_name, user_password, admin):
+    if not module.check_mode:
+        try:
+            client.create_user(user_name, user_password, admin)
+        except ConnectionError as e:
+            module.fail_json(msg=to_native(e))
+
+
+def drop_user(module, client, user_name):
+    if not module.check_mode:
+        try:
+            client.drop_user(user_name)
+        except influx.exceptions.InfluxDBClientError as e:
+            module.fail_json(msg=e.content)
+
+    module.exit_json(changed=True)
+
+
+def set_user_grants(module, client, user_name, grants):
+    changed = False
+
+    try:
+        current_grants = client.get_list_privileges(user_name)
+        # Fix privileges wording
+        for i, v in enumerate(current_grants):
+            if v['privilege'] == 'ALL PRIVILEGES':
+                v['privilege'] = 'ALL'
+                current_grants[i] = v
+            elif v['privilege'] == 'NO PRIVILEGES':
+                del(current_grants[i])
+
+        # check if the current grants are included in the desired ones
+        for current_grant in current_grants:
+            if current_grant not in grants:
+                if not module.check_mode:
+                    client.revoke_privilege(current_grant['privilege'],
+                                            current_grant['database'],
+                                            user_name)
+                changed = True
+
+        # check if the desired grants are included in the current ones
+        for grant in grants:
+            if grant not in current_grants:
+                if not module.check_mode:
+                    client.grant_privilege(grant['privilege'],
+                                           grant['database'],
+                                           user_name)
+                changed = True
+
+    except influx.exceptions.InfluxDBClientError as e:
+        module.fail_json(msg=e.content)
+
+    return changed
+
+
+def main():
+    argument_spec = influx.InfluxDb.influxdb_argument_spec()
+    argument_spec.update(
+        state=dict(default='present', type='str', choices=['present', 'absent']),
+        user_name=dict(required=True, type='str'),
+        user_password=dict(required=False, type='str', no_log=True),
+        admin=dict(default='False', type='bool'),
+        grants=dict(type='list', elements='dict'),
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True
+    )
+
+    state = module.params['state']
+    user_name = module.params['user_name']
+    user_password = module.params['user_password']
+    admin = module.params['admin']
+    grants = module.params['grants']
+    influxdb = influx.InfluxDb(module)
+    client = influxdb.connect_to_influxdb()
+    user = find_user(module, client, user_name)
+
+    changed = False
+
+    if state == 'present':
+        if user:
+            if not check_user_password(module, client, user_name, user_password) and user_password is not None:
+                set_user_password(module, client, user_name, user_password)
+                changed = True
+
+            try:
+                if admin and not user['admin']:
+                    client.grant_admin_privileges(user_name)
+                    changed = True
+                elif not admin and user['admin']:
+                    client.revoke_admin_privileges(user_name)
+                    changed = True
+            except influx.exceptions.InfluxDBClientError as e:
+                module.fail_json(msg=to_native(e))
+
+        else:
+            user_password = user_password or ''
+            create_user(module, client, user_name, user_password, admin)
+            changed = True
+
+        if grants is not None:
+            if set_user_grants(module, client, user_name, grants):
+                changed = True
+
+        module.exit_json(changed=changed)
+
+    if state == 'absent':
+        if user:
+            drop_user(module, client, user_name)
+        else:
+            module.exit_json(changed=False)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/database/influxdb/influxdb_write.py

@@ -0,0 +1,101 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2017, René Moser <mail@renemoser.net>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = r'''
+---
+module: influxdb_write
+short_description: Write data points into InfluxDB
+description:
+  - Write data points into InfluxDB.
+author: "René Moser (@resmo)"
+requirements:
+  - "python >= 2.6"
+  - "influxdb >= 0.9"
+options:
+  data_points:
+    description:
+      - Data points as dict to write into the database.
+    required: true
+    type: list
+    elements: dict
+  database_name:
+    description:
+      - Name of the database.
+    required: true
+    type: str
+extends_documentation_fragment:
+- community.general.influxdb
+
+'''
+
+EXAMPLES = r'''
+- name: Write points into database
+  influxdb_write:
+      hostname: "{{influxdb_ip_address}}"
+      database_name: "{{influxdb_database_name}}"
+      data_points:
+        - measurement: connections
+          tags:
+            host: server01
+            region: us-west
+          time: "{{ ansible_date_time.iso8601 }}"
+          fields:
+            value: 2000
+        - measurement: connections
+          tags:
+            host: server02
+            region: us-east
+          time: "{{ ansible_date_time.iso8601 }}"
+          fields:
+            value: 3000
+'''
+
+RETURN = r'''
+# only defaults
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+from ansible_collections.community.general.plugins.module_utils.influxdb import InfluxDb
+
+
+class AnsibleInfluxDBWrite(InfluxDb):
+
+    def write_data_point(self, data_points):
+        client = self.connect_to_influxdb()
+
+        try:
+            client.write_points(data_points)
+        except Exception as e:
+            self.module.fail_json(msg=to_native(e))
+
+
+def main():
+    argument_spec = InfluxDb.influxdb_argument_spec()
+    argument_spec.update(
+        data_points=dict(required=True, type='list', elements='dict'),
+        database_name=dict(required=True, type='str'),
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+    )
+
+    influx = AnsibleInfluxDBWrite(module)
+    data_points = module.params.get('data_points')
+    influx.write_data_point(data_points)
+    module.exit_json(changed=True)
+
+
+if __name__ == '__main__':
+    main()