sensu.sensu_go.pipe_handler – Управление обработчиком Sensu pipe

Примечание

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

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

Для использования в плейбуке укажите: sensu.sensu_go.pipe_handler.

Новый в версии 1.0.0: коллекции sensu.sensu_go

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

Обзор

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

Требования

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

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	Варианты: no да ←	Флаг, управляющий проверкой сертификатов. Если вы используете самозаверенные сертификаты, можно установить этот параметр в `false`. ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! При использовании самозаверенных сертификатов в продакшене используйте параметр auth.ca_path. Также можно задать этот параметр через переменную окружения SENSU_VERIFY.
command строка			Команда обработчика, которая будет выполнена. Данные события передаются в процесс через стандартный ввод. Требуется, если state равен `present`.
env_vars словарь			Сопоставление имён и значений переменных среды, которые необходимо использовать при выполнении команды.
filters список / элементы=строка			Список фильтров, используемых при определении того, следует ли передавать результат проверки в этот обработчик.
labels словарь			Пользовательские метаданные, к которым можно получить доступ в Sensu, в виде пар «ключ-значение».
mutator строка			Мутатор, вызываемый для преобразования результата проверки перед передачей в этот обработчик.
name строка / обязательно			Имя ресурса Sensu. Это имя (в сочетании с пространством имён, если применимо) однозначно идентифицирует ресурс, с которым взаимодействует Ansible. Если ресурс с указанным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. Обратитесь к спецификации атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
namespace строка		По умолчанию: "default"	Пространство имён RBAC для работы. Если не задан, используется значение переменной окружения SENSU_NAMESPACE.
runtime_assets список / элементы=строка			Список необходимых runtime-активов для запуска обработчика `command`.
secrets список / элементы=словарь добавлен в 1.6.0 sensu.sensu_go			Список секретов, доступных для команды.
	name строка / обязательно добавлен в 1.6.0 sensu.sensu_go		Имя переменной, которая будет содержать конфиденциальные данные.
	secret строка / обязательно добавлен в 1.6.0 sensu.sensu_go		Имя секрета, содержащего конфиденциальные данные.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
timeout целое число			Таймаут для выполнения обработчика.

См. также

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

Примеры

- name: Setup InfluxDB handler
  sensu.sensu_go.pipe_handler:
    name: influx-db
    command: sensu-influxdb-handler -d sensu
    env_vars:
      INFLUXDB_ADDR: http://influxdb.default.svc.cluster.local:8086
      INFLUXDB_USER: sensu
      INFLUXDB_PASS: password
    runtime_assets:
      - sensu-influxdb-handler

- name: Delete  handler
  sensu.sensu_go.pipe_handler:
    name: influx-db
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	успех	Объект, представляющий обработчик Sensu pipe. Пример: {'command': 'command-example', 'metadata': {'name': 'pipe_handler_minimum', 'namespace': 'default'}, 'type': 'pipe'}

Авторы

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/pipe_handler_module.html