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。

要在 playbook 中使用它，请指定： sensu.sensu_go.pipeline。

注意

由于违反了 Ansible 包含要求，sensu.sensu_go 集合将在 Ansible 12 中移除。该集合存在未解决的完整性测试失败。有关更多信息，请参阅讨论主题。

sensu.sensu_go 1.14.0 中的新增功能

概要 

创建、更新或删除 Sensu 管道。
有关更多信息，请参阅 Sensu 文档：https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/pipelines/.

参数 

参数	注释
auth 字典	身份验证参数。也可以使用 ENV 定义每个参数。
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 证书包的路径。如果未设置此参数，模块将使用 python 使用的 CA 证书包。也可以通过 SENSU_CA_PATH 环境变量设置此参数。
password 字符串	Sensu 用户的密码。如果未设置此参数，则将检查 SENSU_PASSWORD 环境变量的值。如果设置了 auth.api_key 参数，则忽略此参数。默认值： `"P@ssw0rd!"`
url 字符串	Sensu 后端 API 的位置。如果未设置此参数，则将检查 SENSU_URL 环境变量的值。默认值： `"https://127.0.0.1:8080"`
user 字符串	用于连接到 Sensu API 的用户名。如果未设置此参数，则将检查 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 元数据属性规范的说明：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 处理程序的名称。您可以在管道工作流程中使用您现有的处理程序。管道会忽略处理程序定义中指定的任何过滤器和变异器。
type 字符串 / 必需	处理程序的 sensuctl create 资源类型。选项 `"handler"` `"tcp_stream_handler"` `"sumo_logic_metrics_handler"`
mutator 字典	用于变异工作流程的事件数据的 Sensu 变异器的引用。每个管道工作流程只能引用一个变异器。
name 字符串 / 必需	要用于工作流程的 Sensu 变异器的名称。您可以在管道工作流程中使用您现有的变异器。
type 字符串	变异器的 sensuctl create 资源类型。变异器始终应为 Mutator 类型。选项 `"mutator"` ← (默认)
name 字符串 / 必需	Sensu 管道工作流程的名称。

另请参阅 

另请参阅

sensu.sensu_go.socket_handler: 管理 Sensu TCP/UDP 处理程序。
sensu.sensu_go.handler_info: 列出 Sensu 处理程序。
sensu.sensu_go.pipe_handler: 管理 Sensu 管道处理器。
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 管道的对象。

返回：成功

示例： {"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)