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 中的新功能

概要

要求

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

  • python >= 2.7

参数

参数

注释

annotations

字典

具有较少限制的自定义元数据字段,以键/值对的形式。

这些由 Sensu 保留,但不能作为令牌或标识符访问,主要用于外部工具。

默认值: {}

auth

字典

身份验证参数。也可以使用 ENV 定义它们中的每一个。

api_key

字符串

在 sensu.sensu_go 1.3.0 中添加

进行身份验证时应使用的 API 密钥。如果未设置此项,将检查 SENSU_API_KEY 环境变量的值。

这取代了 auth.userauth.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

列表 / 元素=字典

用于定义多个提供命名资产的构件的资产构建列表。

如果 statepresent,则为必需项。

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

返回值

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

描述

object

字典

表示 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)