sensu.sensu_go.bonsai_asset 模块 – 从 Bonsai 添加 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.bonsai_asset。

注意

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

sensu.sensu_go 1.0.0 中的新增功能

概要 

创建或更新 Sensu Go 资产，其定义可在 Sensu 资产索引 Bonsai 中找到。
有关更多信息，请参阅 Sensu 文档：https://docs.sensu.io/sensu-go/latest/reference/assets/ 和 https://bonsai.sensu.io/。

注意

此模块具有相应的操作插件。

要求 

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

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` ← (默认)
labels 字典	可以在 Sensu 中访问的自定义元数据字段，以键/值对的形式呈现。默认值： `{}`
name 字符串 / 必需	Sensu 资源的名称。此名称（如果适用，则与命名空间结合使用）唯一标识 Ansible 操作的资源。如果具有选定名称的资源已存在，则 Ansible 模块将更新它以匹配任务中的规范。有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于https://docs.sensu.io/sensu-go/latest/reference/中的 name 元数据属性规范。
namespace 字符串	要在其中操作的 RBAC 命名空间。如果未设置此项，将使用 SENSU_NAMESPACE 环境变量的值。默认值： `"default"`
on_remote 布尔值在 sensu.sensu_go 1.13.0 中添加	如果设置为 `true`，则模块将在远程主机上下载资产定义。如果未设置或设置为 `false`，则 ansible 将在控制节点上下载资产定义。选项 `false` `true`
rename 字符串	将资产添加到 Sensu 时使用的名称。如果不存在，将使用 name 参数的值。
version 字符串 / 必需	要安装的资产的版本号。

说明 

注意

labels 和 annotations 的值将与从 Bonsai 获取的值合并。作为参数传入的值优先于从 Bonsai 获取的值。
要删除资产，请使用常规的 sensu.sensu_go.asset 模块。

另请参阅 

另请参阅

sensu.sensu_go.asset: 管理 Sensu 资产。
sensu.sensu_go.asset_info: 列出 Sensu 资产。

示例 

- name: Make sure specific version of asset is installed
  sensu.sensu_go.bonsai_asset:
    name: sensu/monitoring-plugins
    version: 2.2.0-1

- name: Remove previously added asset
  sensu.sensu_go.asset:
    name: sensu/monitoring-plugins
    state: absent

- name: Store Bonsai asset under a different name
  sensu.sensu_go.bonsai_asset:
    name: sensu/monitoring-plugins
    version: 2.2.0-1
    rename: sensu-monitoring-2.2.0-1

- name: Display asset info
  sensu.sensu_go.asset_info:
    name: sensu-monitoring-2.2.0-1  # value from rename field

返回值 

通用返回值在这里有文档记录，以下是此模块独有的字段

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

作者

Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Tadej Borovsak (@tadeboro)