sensu.sensu_go.silence – Управление сенсу-молчаниями

Примечание

Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).

Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.

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

Новое в версии 1.0.0: of sensu.sensu_go

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

Обзор

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

Требования

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

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
annotations словарь			Пользовательские метаданные с меньшими ограничениями, как пары ключ/значение. Они сохраняются Sensu, но не доступны как токены или идентификаторы, и предназначены в основном для использования с внешними инструментами.
auth словарь			Параметры аутентификации. Можно определить каждый из них с помощью переменных среды.
	api_key строка добавлен в 1.3.0 sensu.sensu_go		Ключ API, который должен использоваться при аутентификации. Если он не задан, будет проверено значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
	ca_path путь добавлен в 1.5.0 sensu.sensu_go		Путь к пакету CA, который должен использоваться для проверки сертификата бэкенда. Если этот параметр не установлен, модуль будет использовать пакет CA, который использует Python. Этот параметр также можно установить через переменную среды SENSU_CA_PATH.
	password строка	По умолчанию: "P@ssw0rd!"	Пароль пользователя Sensu. Если он не установлен, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если установлен параметр auth.api_key.
	url строка	По умолчанию: "http://localhost:8080"	Местоположение API Sensu бэкенда. Если он не установлен, будет проверено значение переменной среды SENSU_URL.
	user строка	По умолчанию: "admin"	Имя пользователя для подключения к API Sensu. Если он не установлен, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если установлен параметр auth.api_key.
	verify логическое значение добавлен в 1.5.0 sensu.sensu_go	Варианты: нет да ←	Флаг, контролирующий проверку сертификата. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самозаверяющие сертификаты в рабочей среде, обратитесь к параметру auth.ca_path. Этот параметр также можно установить через переменную среды SENSU_VERIFY.
begin целое число			Временная метка Unix, с которой вступает в силу запись о молчании.
check строка			Имя проверки, которой должна соответствовать запись. Если оставлено пустым, запись о молчании будет содержать звездочку в позиции проверки. Это означает, что любое событие, где подписки исходных сущностей соответствуют подписке, указанной в записи, будет помечено как отмолчавшееся, независимо от имени проверки. Этот параметр обязателен, если параметр subscription отсутствует.
expire целое число			Количество секунд до истечения молчания.
expire_on_resolve логическое значение		Варианты: нет да	Если запись должна быть удалена, когда проверка возвращает статус OK (разрешает).
labels словарь			Пользовательские метаданные, к которым можно получить доступ в Sensu, как пары ключ/значение.
namespace строка		По умолчанию: "default"	Пространство имен RBAC для работы. Если он не задан, используется значение переменной среды SENSU_NAMESPACE.
reason строка			Причина молчания.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
subscription строка			Имя подписки, которой должна соответствовать запись. Если оставлено пустым, запись о молчании будет содержать звездочку в позиции подписки. Это означает, что любое событие с соответствующим именем проверки будет помечено как отмолчавшееся, независимо от подписок исходных сущностей. Конкретная сущность также может быть назначена, используя подписку на уровне сущностей (entity:<имя_сущности>). Этот параметр обязателен, если параметр check отсутствует.

См. также

sensu.sensu_go.silence_info: Официальная документация модуля sensu.sensu_go.silence_info.

Примеры

- 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 словарь	успех	Объект, представляющий сенсу-молчание. Пример: {'begin': 1542671205, 'check': None, 'creator': 'admin', 'expire': -1, 'expire_on_resolve': False, 'metadata': {'annotations': None, 'labels': None, 'name': 'entity:i-424242:*', 'namespace': 'default'}, 'reason': None, 'subscription': 'entity:i-424242'}

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Tadej Borovsak (@tadeboro)

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