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

Примечание

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

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

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

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

Новый в sensu.sensu_go 1.0.0

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

Описание

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

Требования

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

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` ← (по умолчанию)
command строка	Команда обработчика, которая должна быть выполнена. Данные события передаются процессу через стандартный ввод. Требуется, если state равен `present`.
env_vars словарь	Сопоставление имён переменных среды и значений, которые нужно использовать при выполнении команды.
filters список / элементы=строка	Список фильтров для определения того, нужно ли передавать результат проверки этому обработчику.
labels словарь	Пользовательские метаданные поля, доступные в Sensu, в виде пар «ключ-значение». По умолчанию: `{}`
mutator строка	Мутатор для преобразования результата проверки перед передачей его этому обработчику.
name строка / обязательный	Имя ресурса Sensu. Это имя (в сочетании с пространством имён, где применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операции. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
namespace строка	Пространство имён RBAC для работы. Если не задан, используется значение переменной среды SENSU_NAMESPACE. По умолчанию: `"default"`
runtime_assets список / элементы=строка	Список runtime-активов, необходимых для запуска обработчика `command`.
secrets список / элементы=словарь добавлен в sensu.sensu_go 1.6.0	Список секретов, доступных команде.
name строка / обязательный добавлен в sensu.sensu_go 1.6.0	Имя переменной, которая будет содержать конфиденциальные данные.

secret строка / обязательно добавлено в sensu.sensu_go 1.6.0	Имя секрета, содержащего конфиденциальные данные.
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Таймаут для выполнения обработчика.

См. также

sensu.sensu_go.socket_handler: Управление обработчиком Sensu TCP/UDP.
sensu.sensu_go.handler_info: Список обработчиков Sensu.
sensu.sensu_go.handler_set: Управление набором обработчиков Sensu.

Примеры

- 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. Возвращаемое значение: success Пример: `{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/pipe_handler_module.html