在Knative中使用GitHub事件源

您可以在Knative中创建GitHub事件源(GitHubSource),用于接收GitHub产生的Event事件,适用于CI/CD、数据同步、自动化测试等场景。

前提条件

步骤一:创建GitHub Token

  1. 创建Personal Access Token,用于访问GitHub API。

    更多信息,请参见Personal access tokens

    下文以设置一个GitHubSource Sample Token为例。

    image.png

    创建github token

    • 自定义Token的名称。

    • 需要开启repo:public_repoadmin:repo_hook,以便通过公共仓库触发Event事件,并为这些公共仓库创建Webhooks。

  2. 基于secretToken内容通过以下方式生成随机字符串。

    head -c 8 /dev/urandom | base64
  3. 更新githubsecret.yaml。

    如果生成的是personal_access_token_value Token,则需要设置secretToken。示例如下。

    apiVersion: v1
    kind: Secret
    metadata:
      name: githubsecret
    type: Opaque
    stringData:
      accessToken: GitHubSourceSample
      secretToken: rVzY0DQ5AM8=
    apiVersion: v1
    kind: Secret
    metadata:
      name: githubsecret
    type: Opaque
    stringData:
      accessToken: personal_access_token_value
      secretToken: asdfasfdsaf
  4. 执行以下命令,创建GitHub Token。

    kubectl apply -f githubsecret.yaml --namespace default

步骤三:创建GitHub事件源

您可以创建GitHubSource用于接收GitHub产生的事件。

  1. 参见以下内容创建github-source.yaml文件。

    apiVersion: sources.eventing.knative.dev/v1alpha1
    kind: GitHubSource
    metadata:
      name: githubsourcesample
    spec:
      eventTypes:
        - pull_request
      ownerAndRepository: <YOUR USER>/<YOUR REPO> # 需要将<YOUR USER>替换为您的GitHub用户名,<YOUR REPO>替换为您的GitHub仓库名称。
      accessToken:
        secretKeyRef:
          name: githubsecret
          key: accessToken
      secretToken:
        secretKeyRef:
          name: githubsecret
          key: secretToken
      sink:
        apiVersion: serving.knative.dev/v1alpha1
        kind: Service
        name: github-event-display
  2. 执行以下命令,在命名空间default中创建GitHubSource。

    kubectl --namespace default apply github-source.yaml

结果验证

  1. 在GitHub repository中选择Settings > Webhooks,查看验证成功的Hook URL。

    说明

    域名需已完成备案。

  2. 在GitHub repository中执行以下命令,创建一个pull request,产生对应的Event事件。

    kubectl --namespace default get pods
    kubectl --namespace default logs github-event-display-XXXX user-container

    此时,Knative Eventing中可以查看到类似事件结果。

    2018/11/08 18:25:34 Message Dumper received a message: POST / HTTP/1.1
    Host: github-event-display.knative-demo.svc.cluster.local
    Accept-Encoding: gzip
    Ce-Cloudeventsversion: 0.1
    Ce-Eventid: a8d4cf20-e383-11e8-8069-46e3c8ad****
    Ce-Eventtime: 2018-11-08T18:25:32.819548012Z
    Ce-Eventtype: dev.knative.source.github.pull_request
    Ce-Source: https://github.com/someuser/somerepo/pull/1
    Content-Length: 21060
    Content-Type: application/json
    User-Agent: Go-http-client/1.1
    X-B3-Parentspanid: b2e514c3dbe94c03
    X-B3-Sampled: 1
    X-B3-Spanid: c85e346d89c8be4e
    X-B3-Traceid: abf6292d458fb8e7
    X-Envoy-Expected-Rq-Timeout-Ms: 60000
    X-Envoy-Internal: true
    X-Forwarded-For: 12*.*.*.*, 12*.*.*.*
    X-Forwarded-Proto: http
    X-Request-Id: 8a2201af-5075-9447-b593-ec3a243a****
    
    {"action":"opened","number":1,"pull_request": ...}

相关文档

您也可以EventBridge事件源实现事件驱动,请参见在Knative中使用EventBridge事件源