mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 02:41:25 -07:00
5589bcb659
Add attributes to oneandone, ovh, and rackspace modules (#5948)
Add attributes to oneandone, ovh, and rackspace modules.
(cherry picked from commit 6bd131f2fb)
237 lines
7.7 KiB
Python
237 lines
7.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: rax_mon_alarm
|
|
short_description: Create or delete a Rackspace Cloud Monitoring alarm
|
|
description:
|
|
- Create or delete a Rackspace Cloud Monitoring alarm that associates an
|
|
existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with
|
|
criteria that specify what conditions will trigger which levels of
|
|
notifications. Rackspace monitoring module flow | rax_mon_entity ->
|
|
rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan ->
|
|
*rax_mon_alarm*.
|
|
- This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
|
|
- Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
|
|
attributes:
|
|
check_mode:
|
|
support: none
|
|
diff_mode:
|
|
support: none
|
|
options:
|
|
state:
|
|
type: str
|
|
description:
|
|
- Ensure that the alarm with this C(label) exists or does not exist.
|
|
choices: [ "present", "absent" ]
|
|
required: false
|
|
default: present
|
|
label:
|
|
type: str
|
|
description:
|
|
- Friendly name for this alarm, used to achieve idempotence. Must be a String
|
|
between 1 and 255 characters long.
|
|
required: true
|
|
entity_id:
|
|
type: str
|
|
description:
|
|
- ID of the entity this alarm is attached to. May be acquired by registering
|
|
the value of a rax_mon_entity task.
|
|
required: true
|
|
check_id:
|
|
type: str
|
|
description:
|
|
- ID of the check that should be alerted on. May be acquired by registering
|
|
the value of a rax_mon_check task.
|
|
required: true
|
|
notification_plan_id:
|
|
type: str
|
|
description:
|
|
- ID of the notification plan to trigger if this alarm fires. May be acquired
|
|
by registering the value of a rax_mon_notification_plan task.
|
|
required: true
|
|
criteria:
|
|
type: str
|
|
description:
|
|
- Alarm DSL that describes alerting conditions and their output states. Must
|
|
be between 1 and 16384 characters long. See
|
|
http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html
|
|
for a reference on the alerting language.
|
|
disabled:
|
|
description:
|
|
- If yes, create this alarm, but leave it in an inactive state. Defaults to
|
|
no.
|
|
type: bool
|
|
default: false
|
|
metadata:
|
|
type: dict
|
|
description:
|
|
- Arbitrary key/value pairs to accompany the alarm. Must be a hash of String
|
|
keys and values between 1 and 255 characters long.
|
|
author: Ash Wilson (@smashwilson)
|
|
extends_documentation_fragment:
|
|
- community.general.rackspace.openstack
|
|
- community.general.attributes
|
|
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Alarm example
|
|
gather_facts: false
|
|
hosts: local
|
|
connection: local
|
|
tasks:
|
|
- name: Ensure that a specific alarm exists.
|
|
community.general.rax_mon_alarm:
|
|
credentials: ~/.rax_pub
|
|
state: present
|
|
label: uhoh
|
|
entity_id: "{{ the_entity['entity']['id'] }}"
|
|
check_id: "{{ the_check['check']['id'] }}"
|
|
notification_plan_id: "{{ defcon1['notification_plan']['id'] }}"
|
|
criteria: >
|
|
if (rate(metric['average']) > 10) {
|
|
return new AlarmStatus(WARNING);
|
|
}
|
|
return new AlarmStatus(OK);
|
|
register: the_alarm
|
|
'''
|
|
|
|
try:
|
|
import pyrax
|
|
HAS_PYRAX = True
|
|
except ImportError:
|
|
HAS_PYRAX = False
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.general.plugins.module_utils.rax import rax_argument_spec, rax_required_together, setup_rax_module
|
|
|
|
|
|
def alarm(module, state, label, entity_id, check_id, notification_plan_id, criteria,
|
|
disabled, metadata):
|
|
|
|
if len(label) < 1 or len(label) > 255:
|
|
module.fail_json(msg='label must be between 1 and 255 characters long')
|
|
|
|
if criteria and len(criteria) < 1 or len(criteria) > 16384:
|
|
module.fail_json(msg='criteria must be between 1 and 16384 characters long')
|
|
|
|
# Coerce attributes.
|
|
|
|
changed = False
|
|
alarm = None
|
|
|
|
cm = pyrax.cloud_monitoring
|
|
if not cm:
|
|
module.fail_json(msg='Failed to instantiate client. This typically '
|
|
'indicates an invalid region or an incorrectly '
|
|
'capitalized region name.')
|
|
|
|
existing = [a for a in cm.list_alarms(entity_id) if a.label == label]
|
|
|
|
if existing:
|
|
alarm = existing[0]
|
|
|
|
if state == 'present':
|
|
should_create = False
|
|
should_update = False
|
|
should_delete = False
|
|
|
|
if len(existing) > 1:
|
|
module.fail_json(msg='%s existing alarms have the label %s.' %
|
|
(len(existing), label))
|
|
|
|
if alarm:
|
|
if check_id != alarm.check_id or notification_plan_id != alarm.notification_plan_id:
|
|
should_delete = should_create = True
|
|
|
|
should_update = (disabled and disabled != alarm.disabled) or \
|
|
(metadata and metadata != alarm.metadata) or \
|
|
(criteria and criteria != alarm.criteria)
|
|
|
|
if should_update and not should_delete:
|
|
cm.update_alarm(entity=entity_id, alarm=alarm,
|
|
criteria=criteria, disabled=disabled,
|
|
label=label, metadata=metadata)
|
|
changed = True
|
|
|
|
if should_delete:
|
|
alarm.delete()
|
|
changed = True
|
|
else:
|
|
should_create = True
|
|
|
|
if should_create:
|
|
alarm = cm.create_alarm(entity=entity_id, check=check_id,
|
|
notification_plan=notification_plan_id,
|
|
criteria=criteria, disabled=disabled, label=label,
|
|
metadata=metadata)
|
|
changed = True
|
|
else:
|
|
for a in existing:
|
|
a.delete()
|
|
changed = True
|
|
|
|
if alarm:
|
|
alarm_dict = {
|
|
"id": alarm.id,
|
|
"label": alarm.label,
|
|
"check_id": alarm.check_id,
|
|
"notification_plan_id": alarm.notification_plan_id,
|
|
"criteria": alarm.criteria,
|
|
"disabled": alarm.disabled,
|
|
"metadata": alarm.metadata
|
|
}
|
|
module.exit_json(changed=changed, alarm=alarm_dict)
|
|
else:
|
|
module.exit_json(changed=changed)
|
|
|
|
|
|
def main():
|
|
argument_spec = rax_argument_spec()
|
|
argument_spec.update(
|
|
dict(
|
|
state=dict(default='present', choices=['present', 'absent']),
|
|
label=dict(required=True),
|
|
entity_id=dict(required=True),
|
|
check_id=dict(required=True),
|
|
notification_plan_id=dict(required=True),
|
|
criteria=dict(),
|
|
disabled=dict(type='bool', default=False),
|
|
metadata=dict(type='dict')
|
|
)
|
|
)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
required_together=rax_required_together()
|
|
)
|
|
|
|
if not HAS_PYRAX:
|
|
module.fail_json(msg='pyrax is required for this module')
|
|
|
|
state = module.params.get('state')
|
|
label = module.params.get('label')
|
|
entity_id = module.params.get('entity_id')
|
|
check_id = module.params.get('check_id')
|
|
notification_plan_id = module.params.get('notification_plan_id')
|
|
criteria = module.params.get('criteria')
|
|
disabled = module.boolean(module.params.get('disabled'))
|
|
metadata = module.params.get('metadata')
|
|
|
|
setup_rax_module(module, pyrax)
|
|
|
|
alarm(module, state, label, entity_id, check_id, notification_plan_id,
|
|
criteria, disabled, metadata)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|