community.general.pagerduty_change 模块 – 将代码或基础设施更改追踪为 PagerDuty 更改事件

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.general。您需要其他要求才能使用此模块,有关详细信息,请参阅 需求

要在剧本中使用它,请指定:community.general.pagerduty_change

community.general 1.3.0 中的新增功能

概要

  • 每次运行此模块时,此模块都允许您创建一个 PagerDuty 更改事件。

  • 这不是一个幂等操作,每次运行时都会创建一个新的更改事件。

需求

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

  • PagerDuty 集成密钥

参数

参数

注释

environment

字符串

环境名称,通常为 productionstaging 等。

integration_key

字符串 / 必需

标识更改所做的服务的集成密钥。这可以通过向 PagerDuty 中的服务添加集成来找到。

字符串

用于 URL 的描述性文本,从中可以获取有关部署的更多信息。

字符串

用于获取有关部署的更多信息的 URL。

repo

字符串

项目存储库的 URL。

revision

字符串

正在部署的修订版的标识符,通常是版本控制系统中的数字或 SHA。

source

字符串

更改事件的来源。

默认值: "Ansible"

summary

字符串 / 必需

发生的更改的简短描述。

url

字符串

提交更改事件的 URL。

默认值: "https://events.pagerduty.com/v2/change/enqueue"

user

字符串

触发此部署的用户或进程的名称。

validate_certs

布尔值

如果为 false,则不会验证目标 URL 的 SSL 证书。这应该只在使用自签名证书的个人控制站点上使用。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持:完全支持

检查模式只做一件事,除了在 url 看起来正确的情况下返回 changed=true

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

diff_mode

支持:不支持

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

示例

- name: Track the deployment as a PagerDuty change event
  community.general.pagerduty_change:
    integration_key: abc123abc123abc123abc123abc123ab
    summary: The application was deployed

- name: Track the deployment as a PagerDuty change event with more details
  community.general.pagerduty_change:
    integration_key: abc123abc123abc123abc123abc123ab
    summary: The application was deployed
    source: Ansible Deploy
    user: ansible
    repo: github.com/ansible/ansible
    revision: '4.2'
    environment: production
    link_url: https://github.com/ansible-collections/community.general/pull/1269
    link_text: View changes on GitHub

作者

  • Adam Vaughan (@adamvaughan)