Spec-Zone.ru › Ansible 2.8

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
-
По умолчанию:
"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
boolean
    Варианты:
  • нет
  • да
Если да, создать это оповещение, но оставить его в неактивном состоянии. По умолчанию нет.
entity_id
- / обязательно
ID сущности, к которой прикреплено это оповещение. Может быть получен путем регистрации значения задачи rax_mon_entity.
env
-
Среда, как настроена в ~/.pyrax.cfg, см. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type
-
По умолчанию:
"rackspace"
Используемый механизм аутентификации, например rackspace или keystone.
label
- / обязательно
Дружественное имя для этого оповещения, используемое для достижения идемпотентности. Должно быть строкой длиной от 1 до 255 символов.
metadata
-
Произвольные пары ключ/значение для сопровождения оповещения. Должно быть хэш-таблицей со строковыми ключами и значениями длиной от 1 до 255 символов.
notification_plan_id
- / обязательно
ID плана уведомлений для запуска, если сработает это оповещение. Может быть получен путем регистрации значения задачи rax_mon_notification_plan.
region
-
По умолчанию:
"DFW"
Регион для создания экземпляра.
state
-
    Варианты:
  • present ←
  • absent
Обеспечить, чтобы оповещение с этим label существовало или не существовало.
tenant_id
-
ID клиента, используемый для аутентификации.
tenant_name
-
Имя клиента, используемое для аутентификации.
username
-
Имя пользователя Rackspace, переопределяет credentials.
validate_certs
boolean
    Варианты:
  • нет
  • да
Необходимо ли проверять SSL-подключения к API-точкам.

псевдонимы: verify_ssl

Примечания

Примечание

  • Можно использовать следующие переменные окружения: 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. [сообщество]

Авторы

  • Эш Уилсон (@smashwilson)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/rax_mon_alarm_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API