sensu.sensu_go.filter – Управление фильтрами Sensu

Примечание

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

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

Для использования в книге задач укажите: sensu.sensu_go.filter.

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

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

Обзор

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

Требования

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

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
action строка		Варианты: allow deny	Действие, которое должно быть выполнено с событием, если выражения фильтра совпадают. Требуется, если state имеет значение `present`.
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	Варианты: no да ←	Флаг, контролирующий проверку сертификатов. Если вы используете самоподписанные сертификаты, вы можете установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самоподписанные сертификаты в рабочей среде, см. параметр auth.ca_path. Также этот параметр можно задать через переменную среды SENSU_VERIFY.
expressions список / элементы=строка			Выражения фильтра, которые будут сравниваться с данными событий. Требуется, если state имеет значение `present`.
labels словарь			Пользовательские поля метаданных, к которым можно получить доступ в Sensu, представленные в виде пар «ключ/значение».
name строка / обязательно			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, на котором Ansible выполняет операции. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его, чтобы соответствовать спецификации в задаче. См. спецификацию атрибута метаданных name в документации источника по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.
namespace строка		По умолчанию: "default"	Пространство имен RBAC для работы. Если этот параметр не задан, используется значение переменной среды SENSU_NAMESPACE.
runtime_assets список / элементы=строка			Актив, применяемый к контексту выполнения фильтра. Файлы JavaScript в каталоге lib актива будут оценены.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.

См. также

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

Примеры

- name: Create a filter
  sensu.sensu_go.filter:
    name: filter
    action: deny
    expressions:
      - event.check.interval == 10
      - event.check.occurrences == 1
    runtime_assets: awesomeness

- name: Create a production filter
  sensu.sensu_go.filter:
    name: filter
    action: allow
    expressions:
      - event.entity.labels['environment'] == 'production'

- name: Create a filter with JS expression
  sensu.sensu_go.filter:
    name: filter
    action: deny
    expressions:
      - "_.reduce(event.check.history, function(memo, h) { return (memo || h.status != 0); })"
    runtime_assets:
      - underscore

- name: Handling repeated events
  sensu.sensu_go.filter:
    name: filter_interval_60_hourly
    action: allow
    expressions:
      - event.check.interval == 60
      - event.check.occurrences == 1 || event.check.occurrences % 60 == 0

- name: Delete a filter
  sensu.sensu_go.filter:
    name: filter_interval_60_hourly
    state: absent

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
object словарь	успешно	Объект, представляющий фильтр Sensu. Пример: {'action': 'allow', 'expressions': ['event.check.occurrences == 1'], 'metadata': {'name': 'filter_minimum', 'namespace': 'default'}}

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
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/filter_module.html