sensu.sensu_go.hook – Управление хуками Sensu

Примечание

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

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

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

Новое в версии 1.0.0: модуля sensu.sensu_go

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

Описание

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

Требования

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

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

См. также

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

Примеры

- name: Rudimentary auto-remediation hook
  sensu.sensu_go.hook:
    auth:
      url: http://localhost:8080
    name: restart_nginx
    command: sudo systemctl start nginx
    timeout: 60
    stdin: false

- name: Capture the process tree
  sensu.sensu_go.hook:
    auth:
      url: http://localhost:8080
    name: process_tree
    command: ps aux
    timeout: 60
    stdin: false

- name: Delete a hook
  sensu.sensu_go.hook:
    name: process_tree
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	success	Объект, представляющий хук Sensu. Пример: {'command': 'sudo systemctl start nginx', 'metadata': {'annotations': None, 'labels': None, 'name': 'restart_nginx', 'namespace': 'default'}, 'stdin': False, 'timeout': 60}

Авторы

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