Spec-Zone.ru › Ansible

sensu.sensu_go.silence модуль — Управление молчанием Sensu

Примечание

Этот модуль входит в состав коллекции sensu.sensu_go (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.silence.

Новый в sensu.sensu_go 1.0.0

  • Описание
  • Требования
  • Параметры
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Создание, обновление или удаление молчания Sensu.
  • Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/silencing/.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется данный модуль.

  • python >= 2.7

Параметры

Параметр

Комментарии

annotations

словарь

Пользовательские поля метаданных с меньшими ограничениями, как пары ключ/значение.

Они сохраняются Sensu, но не доступны в качестве токенов или идентификаторов, и предназначены в основном для использования с внешними инструментами.

По умолчанию: {}

auth

словарь

Параметры аутентификации. Можно определить каждый из них с помощью переменной среды.

api_key

строка

добавлен в sensu.sensu_go 1.3.0

Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверена переменная среды SENSU_API_KEY.

Заменяет параметры auth.user и auth.password.

Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

ca_path

путь

добавлен в sensu.sensu_go 1.5.0

Путь к файлу сертификата CA, который следует использовать для проверки сертификата бэкенда.

Если этот параметр не задан, модуль будет использовать файл CA, используемый Python.

Также можно установить этот параметр через переменную среды SENSU_CA_PATH.

password

строка

Пароль пользователя Sensu. Если он не задан, будет проверена переменная среды SENSU_PASSWORD.

Этот параметр игнорируется, если задан параметр auth.api_key.

По умолчанию: "P@ssw0rd!"

url

строка

Местоположение API Sensu бэкенда. Если он не задан, будет проверена переменная среды SENSU_URL.

По умолчанию: "http://localhost:8080"

user

строка

Имя пользователя для подключения к API Sensu. Если он не задан, будет проверена переменная среды SENSU_USER.

Этот параметр игнорируется, если задан параметр auth.api_key.

По умолчанию: "admin"

verify

логический

добавлен в sensu.sensu_go 1.5.0

Флаг, который управляет проверкой сертификата.

Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в false.

ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самозаверяющие сертификаты в продакшене, обратитесь к параметру auth.ca_path.

Также можно установить этот параметр через переменную среды SENSU_VERIFY.

Варианты:

  • false
  • true ← (по умолчанию)

begin

целое число

Временная метка Unix, с которой вступает в силу запись молчания.

check

строка

Имя проверки, с которой должна совпадать запись.

Если оставить пустым, запись молчания будет содержать звездочку в поле проверки. Это означает, что любое событие, где подписки исходных сущностей соответствуют подписке, указанной в записи, будет помечено как беззвучное, независимо от имени проверки.

Этот параметр обязателен, если параметр subscription отсутствует.

expire

целое число

Количество секунд до истечения срока действия молчания.

expire_on_resolve

логический

Если запись должна быть удалена, когда проверка возвращает статус OK (разрешается).

Варианты:

  • false
  • true

labels

словарь

Пользовательские поля метаданных, доступные в Sensu, в виде пар ключ/значение.

По умолчанию: {}

namespace

строка

Пространство имён RBAC для работы. Если не задано, используется значение переменной среды SENSU_NAMESPACE.

По умолчанию: "default"

reason

строка

Причина молчания.

state

строка

Целевое состояние объекта Sensu.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subscription

строка

Имя подписки, с которой должна совпадать запись.

Если оставить пустым, запись молчания будет содержать звездочку в поле подписки. Это означает, что любое событие с совпадающим именем проверки будет помечено как беззвучное, независимо от подписок исходных сущностей.

Можно также нацелить на конкретную сущность, используя подписку на уровне сущности (entity:<имя_сущности>).

Этот параметр обязателен, если параметр check отсутствует.

См. также

См. также

sensu.sensu_go.silence_info

Список записей молчания Sensu.

Примеры

- name: Silence a specific check
  sensu.sensu_go.silence:
    subscription: proxy
    check: check-disk

- name: Silence specific check regardless of the originating entities subscription
  sensu.sensu_go.silence:
    check: check-cpu

- name: Silence all checks on a specific entity
  sensu.sensu_go.silence:
    subscription: entity:important-entity
    expire: 120
    reason: rebooting the world

- name: Delete a silencing entry
  sensu.sensu_go.silence:
    subscription: entity:important-entity
    state: absent

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ

Описание

object

словарь

Объект, представляющий заглушку Sensu.

Возвращено: успех

Пример: {"begin": 1542671205, "check": null, "creator": "admin", "expire": -1, "expire_on_resolve": false, "metadata": {"annotations": null, "labels": null, "name": "entity:i-424242:*", "namespace": "default"}, "reason": null, "subscription": "entity:i-424242"}

Авторы

  • Пол Артур (@flowerysong)
  • Альджаз Косир (@aljazkosir)
  • Манка Биджак (@mancabizjak)
  • Тадей Боровсак (@tadeboro)

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/silence_module.html

Spec-Zone.ru

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