Модуль sensu.sensu_go.pipeline – Управление конвейером Sensu

Примечание

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

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

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

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

Новое в sensu.sensu_go 1.14.0

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

Описание

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

Параметры

Параметр	Комментарии
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	Путь к файлу с корневым сертификатом, который должен использоваться для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать корневой сертификат, используемый 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` ← (по умолчанию)
labels словарь	Дополнительные метаданные, которые могут быть доступны в Sensu в виде пар ключ/значение. Значение по умолчанию: `{}`
name строка / обязательно	Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операцию. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/, чтобы узнать больше о допустимых именах и других ограничениях.
namespace строка	Пространство имен RBAC для работы. Если параметр не задан, будет использовано значение переменной среды SENSU_NAMESPACE. Значение по умолчанию: `"default"`
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`
workflows список / элементы=словарь	Массив рабочих процессов (по именам), используемых при фильтрации, модификации и обработке событий с помощью конвейера.
filters список / элементы=словарь	Ссылка на фильтры событий Sensu, которые нужно использовать при фильтрации событий для конвейера. Каждый рабочий процесс конвейера может ссылаться на более чем один фильтр событий. Если у рабочего процесса несколько фильтров, Sensu применяет фильтры последовательно, начиная с первого в списке.
name строка / обязательно	Имя фильтра событий Sensu для использования в рабочем процессе. В рабочих процессах конвейера можно использовать встроенные фильтры событий, а также ваши собственные фильтры событий.
type строка	Тип ресурса sensuctl create для фильтра событий. Фильтры событий всегда должны быть типа EventFilter. Варианты: `"event_filter"` ← (по умолчанию)
handler словарь / обязательно	Ссылка на обработчик Sensu для обработки событий в рабочем процессе. Каждый рабочий процесс конвейера должен ссылаться на один обработчик. Конвейеры игнорируют любые фильтры и мутаторы, указанные в определениях обработчика.
name строка / обязательно	Имя обработчика Sensu для использования в рабочем процессе. В рабочих процессах конвейера можно использовать существующие обработчики. Конвейеры игнорируют любые фильтры и мутаторы, указанные в определениях обработчика.

тип строка / обязательно	Тип ресурса sensuctl для обработчика. Варианты: `"handler"` `"tcp_stream_handler"` `"sumo_logic_metrics_handler"`
мутатор словарь	Ссылка на Sensu мутатор для изменения данных события для потока. Каждый поток конвейера может ссылаться только на один мутатор.
имя строка / обязательно	Имя Sensu мутатора для использования в потоке. Вы можете использовать существующие мутаторы в потоках конвейера.
тип строка	Тип ресурса sensuctl для мутатора. Мутаторы всегда должны быть типа Mutator. Варианты: `"mutator"` ← (по умолчанию)
имя строка / обязательно	Имя потока Sensu конвейера.

См. также

sensu.sensu_go.socket_handler: Управление обработчиком Sensu TCP/UDP.
sensu.sensu_go.handler_info: Список обработчиков Sensu.
sensu.sensu_go.pipe_handler: Управление обработчиком Sensu pipe.
sensu.sensu_go.filter: Управление фильтрами Sensu.
sensu.sensu_go.filter_info: Список сведений Sensu.
sensu.sensu_go.mutator: Управление мутаторами Sensu.
sensu.sensu_go.mutator_info: Список мутаторов Sensu.

Примеры

- name: Create a pipeline
  sensu.sensu_go.pipeline:
    name: this_pipeline
    workflows:
      - name: this-wf
        handler:
          name: this_handler
          type: tcp_stream_handler
        filters:
          - name: this_filter
          - name: this_filter_2
        mutator:
          name: this_mutator

- name: Delete pipeline
  sensu.sensu_go.pipeline:
    name: this_pipeline
    state: absent

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

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

Ключ	Описание
объект словарь	Объект, представляющий конвейер Sensu. Возвращается: success Пример: `{"metadata": {"created_by": "admin", "name": "this_pipeline", "namespace": "default"}, "workflows": [{"filters": [{"api_version": "core/v2", "name": "this_filter", "type": "EventFilter"}, {"api_version": "core/v2", "name": "this_filter_2", "type": "EventFilter"}], "handler": {"api_version": "pipeline/v1", "name": "this_handler", "type": "TCPStreamHandler"}, "mutator": {"api_version": "core/v2", "name": "this_mutator", "type": "Mutator"}, "name": "this-wf"}]}`

Ключ

Описание

объект

словарь

Объект, представляющий конвейер Sensu.

Возвращается: success

Пример: {"metadata": {"created_by": "admin", "name": "this_pipeline", "namespace": "default"}, "workflows": [{"filters": [{"api_version": "core/v2", "name": "this_filter", "type": "EventFilter"}, {"api_version": "core/v2", "name": "this_filter_2", "type": "EventFilter"}], "handler": {"api_version": "pipeline/v1", "name": "this_handler", "type": "TCPStreamHandler"}, "mutator": {"api_version": "core/v2", "name": "this_mutator", "type": "Mutator"}, "name": "this-wf"}]}

Авторы

Domen Dobnikar (@domen_dobnikar)

Ссылки на коллекции

© 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/pipeline_module.html