sensu.sensu_go.etcd_replicator 模块 – 管理 Sensu Go etcd 复制器

注意

此模块是 sensu.sensu_go 集合 (版本 1.14.0) 的一部分。

如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install sensu.sensu_go。您需要其他要求才能使用此模块，请参阅 需求了解详情。

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

注意

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

sensu.sensu_go 1.9.0 中的新增功能

概要

• 创建、更新或删除 Sensu etcd 复制器。

• 有关更多信息，请参阅 Sensu 文档 https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/etcdreplicators/。

需求

执行此模块的主机需要以下要求。

• python >= 2.7

参数

参数	注释
api_version 字符串	要复制的资源的 Sensu API 版本。
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 ← (默认)
ca_cert 字符串	用于 TLS 客户端身份验证的 PEM 格式 CA 证书的路径。 如果 *insecure* 为 false，则需要此参数。
cert 字符串	用于 TLS 客户端身份验证的 PEM 格式证书的路径。此证书对于安全的客户端通信是必需的。 如果 *insecure* 为 false，则需要此参数。
insecure 布尔值	禁用传输安全。 仅在沙盒和实验环境中设置为 true。 选项 false ← (默认) true
key 字符串	与用于 TLS 客户端身份验证的 cert 关联的 PEM 格式密钥文件的路径。此密钥及其相应的证书对于安全的客户端通信是必需的。 如果 *insecure* 为 false，则需要此参数。
name 字符串 / 必需	Sensu 资源的名称。此名称（在适用的情况下与命名空间结合使用）唯一标识 Ansible 操作的资源。 如果具有所选名称的资源已存在，Ansible 模块会将其更新以匹配任务中的规范。 有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 https://docs.sensu.io/sensu-go/latest/reference/ 的 *name* 元数据属性规范。
namespace 字符串	限制复制到的命名空间。 如果您不包含命名空间，则会复制给定资源的所有命名空间。
replication_interval 整数	复制资源的间隔。以秒为单位。
resource 字符串	要复制的资源的名称。 所有资源的列表可在 https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#resources 查看。 如果 *state* 为 present，则需要此参数。
state 字符串	Sensu 对象的目标状态。 选项 "present" ← (默认) "absent"
url 列表 / 元素=字符串	目标集群 URL。 如果 *state* 为 present，则需要此参数。

另请参阅

另请参阅

sensu.sensu_go.etcd_replicator_info

列出可用的 Sensu Go etcd 复制器。

示例

- name: Create a minimal replicator
  sensu.sensu_go.etcd_replicator:
    name: cluster_role_replicator
    ca_cert: /etc/sensu/certs/ca.pem
    cert: /etc/sensu/certs/cert.pem
    key: /etc/sensu/certs/key.pem
    url: https://sensu.alpha.example.com:2379
    resource: ClusterRole

- name: Create an insecure minimal replicator
  sensu.sensu_go.etcd_replicator:
    name: role_replicator
    insecure: true
    url:
      - https://sensu.beta.example.com:2379
      - https://sensu.gamma.example.com:2379
    resource: Role

- name: Create a replicator with all parameters set
  sensu.sensu_go.etcd_replicator:
    name: role_binding_replicator
    ca_cert: /etc/sensu/certs/ca.pem
    cert: /etc/sensu/certs/cert.pem
    key: /etc/sensu/certs/key.pem
    insecure: false
    url: https://127.0.0.1:2379
    api_version: core/v2
    resource: RoleBinding
    namespace: default
    replication_interval_seconds: 30

- name: Delete a replicator
  sensu.sensu_go.etcd_replicator:
    name: my_replicator
    state: absent

返回值

常见的返回值已在此处记录，以下是此模块特有的字段：

键	描述
对象 字典	表示 Sensu etcd 复制器的对象。 返回：成功 示例： {"api_version": "core/v2", "ca_cert": "/etc/sensu/certs/ca.pem", "cert": "/etc/sensu/certs/cert.pem", "insecure": false, "key": "/etc/sensu/certs/key.pem", "metadata": {"created_by": "admin", "name": "cluster-role-replicator"}, "namespace": "", "replication_interval_seconds": 30, "resource": "ClusterRole", "url": "https://sensu.alpha.example.com:2379"}

作者

• Tadej Borovsak (@tadeboro)

资源链接

• 问题追踪器
• 代码仓库