sensu.sensu_go.cluster 模块 – 管理 Sensu Go 集群

注意

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

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install sensu.sensu_go。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

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

注意

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

sensu.sensu_go 1.9.0 中的新增功能

概要 

创建、更新或删除 Sensu 集群。
有关更多信息，请参阅 Sensu 文档，网址为 https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/cluster-sensu/。

要求 

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

python >= 2.7

参数 

参数	注释
api_urls 列表 / 元素=字符串	构成单个集群的 API URL 列表。如果 state 为 `present`，则为必需项。
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` ←（默认值）
name 字符串 / 必需	Sensu 资源的名称。此名称（与适用的命名空间结合使用）唯一标识 Ansible 操作的资源。如果具有所选名称的资源已存在，Ansible 模块将更新它以匹配任务中的规范。有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于https://docs.sensu.io/sensu-go/latest/reference/的 name 元数据属性规范。
state 字符串	Sensu 对象的期望状态。选项 `"present"` ←（默认值） `"absent"`

另请参阅 

另请参阅

sensu.sensu_go.cluster_info: 列出可用的 Sensu Go 集群。

示例 

- name: Create a small cluster
  sensu.sensu_go.cluster:
    name: small-cluster
    api_urls: https://sensu.alpha.example.com:8080

- name: Create a larger cluster
  sensu.sensu_go.cluster:
    name: large-cluster
    api_urls:
      - https://sensu.alpha.example.com:8080
      - https://sensu.beta.example.com:8080
      - https://sensu.gamma.example.com:8080

- name: Delete a cluster
  sensu.sensu_go.cluster:
    name: small-cluster
    state: absent

返回值 

通用返回值已在此处文档化：这里，以下是此模块独有的字段。

键	描述
object 字典	代表 Sensu 集群的对象。已返回: 成功示例: `{"api_urls": ["http://10.10.0.1:8080"], "metadata": {"name": "alpha-cluster"}}`

作者

Tadej Borovsak (@tadeboro)