sensu.sensu_go.asset 模块 – 管理 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.asset。

注意

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

sensu.sensu_go 1.0.0 中的新增功能

概要 

创建、更新或删除 Sensu Go 资源。
更多信息，请参考 Sensu 文档：https://docs.sensu.io/sensu-go/latest/reference/assets/.

要求 

以下是执行此模块的主机所需的条件。

python >= 2.7

参数 

参数	注释
annotations 字典	具有较少限制的自定义元数据字段，作为键值对。这些由 Sensu 保留，但不能作为令牌或标识符访问，主要用于外部工具。默认值： `{}`
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` ← (默认)
builds 列表 / 元素=字典	用于定义提供命名资源的多个构件的资源构建列表。如果 state 为 `present`，则需要此参数。
filters 列表 / 元素=字符串	一组 Sensu 查询表达式，用于确定是否应安装资源。
headers 字典	检索资源时要发送的其他标头，例如用于授权。
sha512 字符串 / 必需	资源的校验和。
url 字符串 / 必需	资源的 URL 位置。
labels 字典	可在 Sensu 中访问的自定义元数据字段，作为键值对。默认值： `{}`
name 字符串 / 必需	Sensu 资源的名称。此名称（以及适用的命名空间）唯一标识 Ansible 操作的资源。如果具有所选名称的资源已存在，Ansible 模块将更新它以匹配任务中的规范。有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 name 元数据属性规范的说明：https://docs.sensu.io/sensu-go/latest/reference/。
namespace 字符串	要操作的 RBAC 命名空间。如果未设置此参数，则将使用 SENSU_NAMESPACE 环境变量的值。默认值： `"default"`
state 字符串	Sensu 对象的目标状态。选项 `"present"` ← (默认) `"absent"`

另请参阅 

另请参阅

sensu.sensu_go.asset_info: 列出 Sensu 资源。
sensu.sensu_go.bonsai_asset: 从 Bonsai 添加 Sensu 资源。

示例 

- name: Create a multiple-build asset
  sensu.sensu_go.asset:
    name: sensu-plugins-cpu-checks
    builds:
      - url: https://assets.bonsai.sensu.io/68546e739d96fd695655b77b35b5aabfbabeb056/sensu-plugins-cpu-checks_4.0.0_centos_linux_amd64.tar.gz
        sha512: 518e7c17cf670393045bff4af318e1d35955bfde166e9ceec2b469109252f79043ed133241c4dc96501b6636a1ec5e008ea9ce055d1609865635d4f004d7187b
        filters:
          - entity.system.os == 'linux'
          - entity.system.arch == 'amd64'
          - entity.system.platform == 'rhel'
      - url: https://assets.bonsai.sensu.io/68546e739d96fd695655b77b35b5aabfbabeb056/sensu-plugins-cpu-checks_4.0.0_alpine_linux_amd64.tar.gz
        sha512: b2da25ecd7642e6de41fde37d674fe19dcb6ee3d680e145e32289f7cfc352e6b5f9413ee9b701d61faeaa47b399aa30b25885dbc1ca432c4061c8823774c28f3
        filters:
          - entity.system.os == 'linux'
          - entity.system.arch == 'amd64'
          - entity.system.platform == 'alpine'

- name: Delete an asset
  sensu.sensu_go.asset:
    name: sensu-plugins-cpu-check
    state: absent

返回值 

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

键	描述
对象字典	表示Sensu资产的对象。返回：成功示例： `{"builds": [{"sha512": "4f926bf4328f...2c58ad9ab40c9e2edc31b288d066b195b21b", "url": "http://example.com/asset.tar.gz"}], "metadata": {"name": "check_script", "namespace": "default"}}`

作者

Cameron Hurst (@wakemaster39)
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Miha Plesko (@miha-plesko)
Tadej Borovsak (@tadeboro)