Модуль sensu.sensu_go.mutator – Управление мутаторами Sensu
Примечание
Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: sensu.sensu_go.mutator.
Новое в sensu.sensu_go 1.0.0
Краткое описание
- Создание, обновление или удаление мутатора Sensu.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/mutators/.
Требования
Указанные ниже требования необходимы на хосте, на котором выполняется этот модуль.
- python >= 2.7
Параметры
Параметр | Комментарии |
|---|---|
annotations dictionary | Пользовательские поля метаданных с меньшими ограничениями, в виде пар ключ/значение. Они сохраняются Sensu, но не доступны в качестве маркеров или идентификаторов и предназначены в основном для использования с внешними инструментами. По умолчанию: |
auth dictionary | Параметры аутентификации. Можно определить каждый из них с помощью ENV. |
|
api_key string added in 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 path added in sensu.sensu_go 1.5.0 |
Путь к пакету CA, который должен использоваться для проверки сертификата сервера. Если этот параметр не задан, модуль будет использовать пакет CA, используемый python. Этот параметр также можно задать через переменную среды SENSU_CA_PATH. |
|
password string |
Пароль пользователя Sensu. Если он не задан, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: |
|
url string |
Расположение API сервера Sensu. Если он не задан, будет проверено значение переменной среды SENSU_URL. По умолчанию: |
|
user string |
Имя пользователя для подключения к API Sensu. Если он не задан, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: |
|
verify boolean added in sensu.sensu_go 1.5.0 |
Флаг, управляющий проверкой сертификата. Если вы используете самоподписанные сертификаты, вы можете установить этот параметр в ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самоподписанные сертификаты в production, см. параметр auth.ca_path. Этот параметр также можно задать через переменную среды SENSU_VERIFY. Варианты:
|
command string | Команда мутатора, которая будет выполнена сервером Sensu. Обязательно, если state равно |
env_vars dictionary | Сопоставление имен и значений переменных среды для использования при выполнении команды. |
labels dictionary | Пользовательские поля метаданных, доступные в Sensu, в виде пар ключ/значение. По умолчанию: |
name string / required | Имя ресурса Sensu. Это имя (в сочетании с пространством имен, если применимо) однозначно идентифицирует ресурс, с которым работает модуль Ansible. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. Обратитесь к спецификации атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях. |
namespace string | Пространство имен RBAC для работы. Если он не задан, будет использовано значение переменной среды SENSU_NAMESPACE. По умолчанию: |
runtime_assets list / elements=string | Список runtime assets, необходимых для запуска команды мутатора. |
secrets list / elements=dictionary added in sensu.sensu_go 1.6.0 | Список секретов, доступных команде. |
|
name string / required added in sensu.sensu_go 1.6.0 |
Имя переменной, которая будет содержать конфиденциальные данные. |
|
secret string / required added in sensu.sensu_go 1.6.0 |
Имя секрета, содержащего конфиденциальные данные. |
state string | Целевое состояние объекта Sensu. Варианты:
|
timeout integer | Тайм-аут выполнения мутатора в секундах (жёсткая остановка). |
См. также
См. также
- sensu.sensu_go.mutator_info
-
Список мутаторов Sensu.
Примеры
- 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 dictionary | Объект, представляющий мутатор Sensu. Возвращается: успех Пример: |
Ссылки на коллекцию
© 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/mutator_module.html