配置GitHub push自动触发OpenShift自动构建和部署

你的名字 2022-12-24 13:59 206阅读 0赞

### 文章目录 ###

*  配置GitHub push自动触发OpenShift自动构建和部署
 *   *  查看BuildConfig的GitHub Webhook配置
     *  在GitHub上配置Webhook
     *  测试Webhook
     *  Troubleshooting
     *   *  Push代码后没有触发自动构建
     *  参考文档

# 配置GitHub push自动触发OpenShift自动构建和部署 #

## 查看BuildConfig的GitHub Webhook配置 ##

在OpenShift上，打开BuildConfig，查看Webhooks。

在GitHub Webhook后，点击“Copy URL with Secret“，内容类似：

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

## 在GitHub上配置Webhook ##

登录GitHub。

打开Repository，打开Settings / Webhooks。

点击“Add webhook”。

填写Webhook信息：

*  Payload URL：复制粘贴上一步的GitHub Webhook的“URL with Secret”。
 *  Content Type: `application/json`。
 *  Secret：不填写，默认为空。（这个secret不是Payload URL中的Secret）
 *  SSL verification：默认Enable SSL verification，如果OpenShift集群没有SSL，则勾选Disable。
 *  Events：默认为“Just the push event"。
 *  Active：默认勾选。

> The secret used in the webhook trigger configuration is not the same as `secret` field you encounter when configuring webhook in GitHub UI. The former is to make the webhook URL unique and hard to predict, the latter is an optional string field used to create HMAC hex digest of the body, which is sent as an `X-Hub-Signature` header.

## 测试Webhook ##

测试push代码到GitHub repository。

打开GitHub repository / Settings / Webhook，打开配置的OpenShift Webhook，检查Recent Deliveries中最近的webhook是否调用成功。

查看是否会通过GitHub Webhook通知OpenShift自动触发构建镜像（BuildConfig的GitHub trigger)。

查看构建镜像完成后是否自动触发部署（DeploymentConfig的ImageChange trigger)。

## Troubleshooting ##

### Push代码后没有触发自动构建 ###

打开GitHub repository / Settings / Webhook，打开配置的OpenShift Webhook，检查Recent Deliveries中最近的webhook是否调用成功。

如果调用成功，检查BuildConfig的`source.git.ref`和GitHub repository的默认branch是否相同。

BuildConfig的默认`source.git.ref`是`master`，但是GitHub已经将默认branch改为`main`，因此需要在BuildConfig中指定`source.git.ref`为`main`。

示例：

source:
        type: Git
        git:
          uri: 'https://github.com/cookcodeblog/spring-db-demo.git'
          ref: main
        contextDir: /

参考：

*  [https://stackoverflow.com/questions/46058226/openshift-3-github-webhook-setup][https_stackoverflow.com_questions_46058226_openshift-3-github-webhook-setup]
 *  [https://stackoverflow.com/questions/36789424/openshift-webhook-branch-filter][https_stackoverflow.com_questions_36789424_openshift-webhook-branch-filter]

## 参考文档 ##

*  [https://docs.openshift.com/container-platform/4.6/builds/triggering-builds-build-hooks.html][https_docs.openshift.com_container-platform_4.6_builds_triggering-builds-build-hooks.html]

[https_stackoverflow.com_questions_46058226_openshift-3-github-webhook-setup]: https://stackoverflow.com/questions/46058226/openshift-3-github-webhook-setup
[https_stackoverflow.com_questions_36789424_openshift-webhook-branch-filter]: https://stackoverflow.com/questions/36789424/openshift-webhook-branch-filter
[https_docs.openshift.com_container-platform_4.6_builds_triggering-builds-build-hooks.html]: https://docs.openshift.com/container-platform/4.6/builds/triggering-builds-build-hooks.html