mirror of https://github.com/ansible/ansible.git
influxdb database module
parent
aa36ed8612
commit
4a93ebd97b
@ -0,0 +1,194 @@
|
||||
#!/usr/bin/python
|
||||
|
||||
# (c) 2016, Kamil Szczygiel <kamil.szczygiel () intel.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: influxdb_database
|
||||
short_description: Manage InfluxDB databases
|
||||
description:
|
||||
- Manage InfluxDB databases
|
||||
version_added: 2.2
|
||||
author: "Kamil Szczygiel (@kamsz)"
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "influxdb >= 0.9"
|
||||
options:
|
||||
hostname:
|
||||
description:
|
||||
- The hostname or IP address on which InfluxDB server is listening
|
||||
required: true
|
||||
username:
|
||||
description:
|
||||
- Username that will be used to authenticate against InfluxDB server
|
||||
default: root
|
||||
required: false
|
||||
password:
|
||||
description:
|
||||
- Password that will be used to authenticate against InfluxDB server
|
||||
default: root
|
||||
required: false
|
||||
port:
|
||||
description:
|
||||
- The port on which InfluxDB server is listening
|
||||
default: 8086
|
||||
required: false
|
||||
database_name:
|
||||
description:
|
||||
- Name of the database that will be created/destroyed
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- Determines if the database should be created or destroyed
|
||||
choices: ['present', 'absent']
|
||||
default: present
|
||||
required: false
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example influxdb_database command from Ansible Playbooks
|
||||
- name: Create database
|
||||
influxdb_database:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
state: present
|
||||
|
||||
- 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}}"
|
||||
state: present
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
#only defaults
|
||||
'''
|
||||
|
||||
try:
|
||||
import requests.exceptions
|
||||
from influxdb import InfluxDBClient
|
||||
from influxdb import exceptions
|
||||
HAS_INFLUXDB = True
|
||||
except ImportError:
|
||||
HAS_INFLUXDB = False
|
||||
|
||||
|
||||
def influxdb_argument_spec():
|
||||
return dict(
|
||||
hostname=dict(required=True, type='str'),
|
||||
port=dict(default=8086, type='int'),
|
||||
username=dict(default='root', type='str'),
|
||||
password=dict(default='root', type='str', no_log=True),
|
||||
database_name=dict(required=True, type='str')
|
||||
)
|
||||
|
||||
|
||||
def connect_to_influxdb(module):
|
||||
hostname = module.params['hostname']
|
||||
port = module.params['port']
|
||||
username = module.params['username']
|
||||
password = module.params['password']
|
||||
database_name = module.params['database_name']
|
||||
|
||||
client = InfluxDBClient(
|
||||
host=hostname,
|
||||
port=port,
|
||||
username=username,
|
||||
password=password,
|
||||
database=database_name
|
||||
)
|
||||
return client
|
||||
|
||||
|
||||
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_argument_spec()
|
||||
argument_spec.update(
|
||||
state=dict(default='present', type='str', choices=['present', 'absent'])
|
||||
)
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not HAS_INFLUXDB:
|
||||
module.fail_json(msg='influxdb python package is required for this module')
|
||||
|
||||
state = module.params['state']
|
||||
database_name = module.params['database_name']
|
||||
|
||||
client = connect_to_influxdb(module)
|
||||
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)
|
||||
|
||||
from ansible.module_utils.basic import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in New Issue