8.7.2. Webhook 触发器
Webhook 触发器通过发送请求到 OpenShift Container Platform API 端点来触发新构建。您可以使用 GitHub、GitLab、Bitbucket 或通用 Webhook 来定义这些触发器。
目前，OpenShift Container Platform Webhook 仅支持各种基于 Git 的源代码管理系统 (SCM) 的推送事件的类同版本。所有其他事件类型都会忽略。
处理推送事件时，会确认事件内的分支引用是否与相应 BuildConfig 中的分支引用匹配。如果匹配，则针对 OpenShift Container Platform 构建签出 Webhook 事件中记录的准确提交引用。如果不匹配，则不触发构建。
oc new-app 和 oc new-build 将自动创建 GitHub 和通用 Webhook 触发器，但其他所需的 Webhook 触发器都必须手动添加（请参阅设置触发器）。
对于所有 Webhook，您必须使用名为 WebHookSecretKey 的键定义 Secret，并且其值是调用 Webhook 时要提供的值。然后，Webhook 定义必须引用该 secret。secret可确保 URL 的唯一性，防止他人触发构建。键的值将与 Webhook 调用期间提供的 secret 进行比较。
例如，此处的 GitHub Webhook 具有对名为 mysecret 的 secret 的引用：
type: "GitHub"
github:
secretReference:
name: "mysecret"
该 secret 的定义如下。注意 secret 的值采用 base64 编码，如 Secret 对象的 data 字段所要求。
- kind: Secret
apiVersion: v1
metadata:
name: mysecret
creationTimestamp:
data:
WebHookSecretKey: c2VjcmV0dmFsdWUx8.7.2.1. GitHub Webhook
当存储库更新时，GitHub Webhook 处理 GitHub 发出的调用。在定义触发器时，您必须指定一个 secret，它将是您在配置 Webhook 时提供给 GitHub 的 URL 的一部分。
GitHub Webhook 定义示例：
type: "GitHub"
github:
secretReference:
name: "mysecret"
Webhook 触发器配置中使用的 secret 与在 GitHub UI 中配置 Webhook 时遇到的 secret 字段不同。前者使 Webhook URL 唯一且难以预测，后者是一个可选的字符串字段，用于创建正文的 HMAC 十六进制摘要，作为 X-Hub-Signature 标头来发送。
oc describe 命令将有效负载 URL 返回为 GitHub Webhook URL（请参阅显示 Webhook URL），其结构如下：
https://<openshift_api_host:port>/oapi/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github
配置 GitHub Webhook：
从 GitHub 存储库创建
BuildConfig后，请运行：$ oc describe bc/<name-of-your-BuildConfig>
这会生成一个 Webhook GitHub URL，如下所示：
<https://api.starter-us-east-1.openshift.com:443/oapi/v1/namespaces/nsname/buildconfigs/bcname/webhooks/<secret>/github>.
- 从 GitHub Web 控制台将此 URL 剪切并粘贴到 GitHub 中。
-
在 GitHub 存储库中，从 Settings
Webhooks & Services 中选择 Add Webhook。 - 将 URL 输出（与上方相似）粘贴到 Payload URL 字段。
-
将 Content Type 从 GitHub 默认的
application/x-www-form-urlencoded更改为application/json。 - 点击 Add webhook。
您应该看到一条来自 GitHub 的消息，说明您的 Webhook 已配置成功。
现在，每当您将更改推送到 GitHub 存储库时，新构建会自动启动，成功构建后也会启动新部署。
Gogs 支持与 GitHub 相同的 Webhook 有效负载格式。因此，如果您使用 Gogs 服务器，您可以在 BuildConfig 中定义 GitHub Webhook 触发器，并通过 Gogs 服务器触发它。
根据包含有效 JSON 有效负载的文件，如 payload.json，您可以通过 curl 手动触发 Webhook：
$ curl -H "X-GitHub-Event: push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/oapi/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github
只有在 API 服务器没有适当签名的证书时，才需要 -k 参数。
