第 8 章 触发和修改构建

流程

1. 配置 GitHub Webhook：

   1. 从 GitHub 存储库创建 BuildConfig 后，运行以下命令：

      $ oc describe bc/<name-of-your-BuildConfig>

      这会生成一个 Webhook GitHub URL，如下所示：

      输出示例

      <https://api.starter-us-east-1.openshift.com:443/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github

   2. 从 GitHub Web 控制台将此 URL 剪切并粘贴到 GitHub 中。
   3. 在 GitHub 存储库中，从 Settings → Webhooks 中选择 Add Webhook。
   4. 将 URL 输出粘贴到 Payload URL 字段。
   5. 将 Content Type 从 GitHub 默认的 application/x-www-form-urlencoded 更改为 application/json。

   6. 点击 Add webhook。

      您应该看到一条来自 GitHub 的消息，说明您的 Webhook 已配置成功。

      现在，每当您将更改推送到 GitHub 存储库时，新构建会自动启动，成功构建后也会启动新部署。

      注意

      Gogs 支持与 GitHub 相同的 Webhook 有效负载格式。因此，如果您使用的是 Gogs 服务器，也可以在 BuildConfig 中定义 GitHub Webhook 触发器，并由 Gogs 服务器触发它。

2. 提供含有有效 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>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github

   只有在 API 服务器没有适当签名的证书时，才需要 -k 参数。

流程

1. 配置 GitLab Webhook：

   1. 描述 BuildConfig 以获取 Webhook URL：

      $ oc describe bc <name>

   2. 复制 Webhook URL，将 <secret> 替换为您的 secret 值。
   3. 按照 GitLab 设置说明，将 Webhook URL 粘贴到 GitLab 存储库设置中。

2. 提供含有有效 JSON 内容的文件后，如 payload.json，您可以使用 curl 手动触发 Webhook：

   $ curl -H "X-GitLab-Event: Push Hook" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/gitlab

   只有在 API 服务器没有适当签名的证书时，才需要 -k 参数。

流程

1. 配置 Bitbucket Webhook：

   1. 描述 BuildConfig 以获取 Webhook URL：

      $ oc describe bc <name>

   2. 复制 Webhook URL，将 <secret> 替换为您的 secret 值。
   3. 按照 Bitbucket 设置说明，将 Webhook URL 粘贴到 Bitbucket 存储库设置中。

2. 提供含有有效 JSON 内容的文件后，如 payload.json，您可以使用 curl 手动触发 Webhook：

   $ curl -H "X-Event-Key: repo:push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/bitbucket

   只有在 API 服务器没有适当签名的证书时，才需要 -k 参数。

流程

1. 要设置调用者，请为调用系统提供构建的通用 Webhook 端点的 URL：

   输出示例

   https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   调用者必须以 POST 操作形式调用 Webhook。

2. 要手动调用 Webhook，您可以使用 curl：

   $ curl -X POST -k https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   HTTP 操作动词必须设置为 POST。指定了不安全 -k 标志以忽略证书验证。如果集群拥有正确签名的证书，则不需要此第二个标志。

   端点可以接受具有以下格式的可选有效负载：

   git:
     uri: "<url to git repository>"
     ref: "<optional git reference>"
     commit: "<commit hash identifying a specific git commit>"
     author:
       name: "<author name>"
       email: "<author e-mail>"
     committer:
       name: "<committer name>"
       email: "<committer e-mail>"
     message: "<commit message>"
   env: 1
      - name: "<variable name>"
        value: "<variable value>"

   1

   与 BuildConfig 环境变量类似，此处定义的环境变量也可供您的构建使用。如果这些变量与 BuildConfig 环境变量发生冲突，则以这些变量为准。默认情况下，Webhook 传递的环境变量将被忽略。在 Webhook 定义上将 allowEnv 字段设为 true 即可启用此行为。

3. 要使用 curl 传递此有效负载，请在名为 payload_file.yaml 的文件中进行定义，再运行以下命令：

   $ curl -H "Content-Type: application/yaml" --data-binary @payload_file.yaml -X POST -k https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   参数与前一个示例相同，但添加了标头和 payload。-H 参数将 Content-Type 标头设置为 application/yaml 或 application/json，具体取决于您的 payload 格式。--data-binary 参数用于通过 POST 请求发送带有换行符的二进制 payload。