第 16 章 使用 Webhook
Webhook 是网页或 Web 应用程序的方法,为其他应用程序实时提供信息。Webhook 仅在事件发生后触发。该请求通常包含事件的详细信息。事件会触发回调,如发送电子邮件确认主机已调配。Webhook 允许您使用 fire-and-forget 消息交换模式,根据 Satellite 内部事件定义对外部 API 的调用。发送请求的应用程序不会等待响应,或者忽略它。
Webhook 的有效负载是从 Webhook 模板创建的。Webhook 模板使用与 Provisioning 模板相同的 ERB 语法。可用变量:
-
@event_name
:事件的名称。 -
@webhook_id
:唯一事件 ID。 -
@payload
: Payload 数据,每种事件类型都有所不同。要访问各个字段,请使用@payload[:key_name]
Ruby hash 语法。 -
@payload[:object]
: 数据库操作触发的事件的数据库对象(create、update、delete)。不适用于自定义事件。 -
@payload[:context]
:其他信息,如请求和会话 UUID、远程 IP 地址、用户、机构和位置。
由于 Webhook 使用 HTTP,因此不需要将新的基础架构添加到现有 Web 服务中。
Satellite 中 Webhook 的典型用例是在创建或删除主机时调用监控系统。
Webhook 可用于通过 API 来实现外部系统中要执行的操作。如果需要运行其他命令或编辑文件,则 Capsule 的 shellhooks 插件可用。shellhooks 插件允许您在 Capsule 上定义一个可通过 API 执行的 shell 脚本。
您可以在不安装 shellhooks 插件的情况下成功使用 Webhook。
有关可用事件的列表,请参阅 可用的 Webhook 事件。
16.1. 迁移到 Webhook 复制链接链接已复制到粘贴板!
传统的 foreman_hooks
插件提供对 webhook 插件不有意提供的模型对象的完整访问权限。
安全模式和所有对象和宏的限制范围取决于 API 稳定性承诺,并完全记录。
Webhook 触发的事件数量显著少于 foreman_hooks
。
Webhook 异步处理,从而对系统内部篡改的风险最小。在不为每个 Webhook 脚本创建有效负载的情况下,无法从 foreman_hooks
迁移。但是,webhook 插件附带了几个示例有效负载模板。您还可以使用带有 shellhooks 的示例有效负载来简化迁移。
必须自定义脚本和有效负载模板才能实现类似的结果。