sensu.sensu_go.mutator – Управление мутаторами Sensu

Примечание

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

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

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

Введено в версии 1.0.0: of sensu.sensu_go

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

Обзор

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

Требования

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

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

Примеры

- name: Create a mutator
  sensu.sensu_go.mutator:
    name: mutator
    command: sensu-influxdb-mutator
    timeout: 30
    env_vars:
      INFLUXDB_ADDR: http://influxdb.default.svc.cluster.local:8086
      INFLUXDB_USER: sensu
    runtime_assets:
      - sensu-influxdb-mutator

- name: Delete a mutator
  sensu.sensu_go.mutator:
    name: mutator
    state: absent

Значения возврата

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

Ключ	Возвращённое значение	Описание
object словарь	success	Объект, представляющий мутатор Sensu. Пример: {'command': 'example_mutator.go', 'env_vars': [], 'metadata': {'annotations': None, 'labels': None, 'name': 'example-mutator', 'namespace': 'default'}, 'runtime_assets': [], 'timeout': 0}

Авторы

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