community.general.librato_annotation 模块 – 在 Librato 中创建注释

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install community.general

要在 playbook 中使用它,请指定:community.general.librato_annotation

概要

  • 在给定的注释流 :name 上创建注释事件。如果注释流不存在,它将自动创建。

参数

参数

注释

api_key

字符串 / 必需

Librato 帐户 API 密钥

description

字符串

描述包含有关特定注释的额外元数据

描述应包含有关单个注释的详细信息,例如:部署 9b562b2 发布了新功能 foo!

end_time

整数

表示此注释引用的事件结束时间的 Unix 时间戳

对于具有持续时间的事件,这是一种注释事件持续时间的有用方法

列表 / 元素=字典

参见示例

name

字符串

注释流名称

如果注释流不存在,它将自动创建。

source

字符串

一个字符串,用于描述在跨多个群体成员跟踪注释时注释的来源

start_time

整数

表示此注释引用的事件开始时间的 Unix 时间戳

title

字符串 / 必需

注释的标题是一个字符串,可能包含空格。

标题应简短地概括注释,例如:v45 部署

user

字符串 / 必需

Librato 帐户用户名

属性

属性

支持

描述

check_mode

支持:不支持

可以在 check_mode 下运行并返回更改状态预测,而无需修改目标。

diff_mode

支持:不支持

在差异模式下,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息。

示例

- name: Create a simple annotation event with a source
  community.general.librato_annotation:
    user: [email protected]
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    source: foo.bar
    description: This is a detailed description of the config change

- name: Create an annotation that includes a link
  community.general.librato_annotation:
    user: [email protected]
    api_key: XXXXXXXXXXXXXXXXXX
    name: code.deploy
    title: app code deploy
    description: this is a detailed description of a deployment
    links:
      - rel: example
        href: http://www.example.com/deploy

- name: Create an annotation with a start_time and end_time
  community.general.librato_annotation:
    user: [email protected]
    api_key: XXXXXXXXXXXXXXXXXX
    name: maintenance
    title: Maintenance window
    description: This is a detailed description of maintenance
    start_time: 1395940006
    end_time: 1395954406

作者

  • Seth Edwards (@Sedward)