rax_mon_alarm - Создание или удаление оповещения Rackspace Cloud Monitoring.
Новое в версии 2.0.
Описание
- Создание или удаление оповещения Rackspace Cloud Monitoring, которое связывает существующий rax_mon_entity, rax_mon_check и rax_mon_notification_plan с критериями, определяющими условия, которые будут запускать уровни оповещений. Поток модуля мониторинга Rackspace | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- pyrax
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key | Ключ API Rackspace, переопределяет credentials. псевдонимы: password | |
| auth_endpoint (добавлено в 1.5) | Значение по умолчанию: "https://identity.api.rackspacecloud.com/v2.0/" | URI службы аутентификации. |
| check_id обязательно | ID проверки, на которую необходимо настроить оповещение. Может быть получен путем регистрации значения задачи rax_mon_check. | |
| credentials | Файл, в котором содержатся учетные данные Rackspace. Игнорируется, если указаны api_key и username. псевдонимы: creds_file | |
| criteria | DSL оповещения, описывающий условия оповещения и их состояния вывода. Длина должна быть от 1 до 16384 символов. См. http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html для справки по языку оповещений. | |
| disabled bool |
| Если да, то создать это оповещение, но оставить его в неактивном состоянии. По умолчанию нет. |
| entity_id обязательно | ID объекта, к которому прикреплено это оповещение. Может быть получен путем регистрации значения задачи rax_mon_entity. | |
| env (добавлено в 1.5) | Среда, как настроено в ~/.pyrax.cfg, см. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| identity_type (добавлено в 1.5) | Значение по умолчанию: "rackspace" | Механизм аутентификации, например, rackspace или keystone. |
| label обязательно | Дружественное имя для этого оповещения, используемое для обеспечения идемпотентности. Должно быть строкой длиной от 1 до 255 символов. | |
| metadata | Произвольные пары ключ-значение для сопровождения оповещения. Должен быть хешем строк ключей и значений длиной от 1 до 255 символов. | |
| notification_plan_id обязательно | ID плана оповещения, который нужно запустить, если сработает это оповещение. Может быть получен путем регистрации значения задачи rax_mon_notification_plan. | |
| region | Значение по умолчанию: "DFW" | Регион для создания экземпляра. |
| state |
| Обеспечить, чтобы оповещение с этим label существовало или не существовало. |
| tenant_id (добавлено в 1.5) | Идентификатор клиента, используемый для аутентификации. | |
| tenant_name (добавлено в 1.5) | Имя клиента, используемое для аутентификации. | |
| username | Имя пользователя Rackspace, переопределяет credentials. | |
| verify_ssl (добавлено в 1.5) | Требовать или нет проверку SSL для API-точек входа. |
Примечания
Примечание
- Следующие переменные среды могут быть использованы,
RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION. -
RAX_CREDENTIALSиRAX_CREDS_FILEуказывают на файл учетных данных, подходящий для pyrax. См. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating -
RAX_USERNAMEиRAX_API_KEYисключают использование файла учетных данных -
RAX_REGIONопределяет регион Rackspace Public Cloud (DFW, ORD, LON, …)
Примеры
- name: Alarm example
gather_facts: False
hosts: local
connection: local
tasks:
- name: Ensure that a specific alarm exists.
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
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Эш Уилсон
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/rax_mon_alarm_module.html