获取 PAC Webhook URL

Important

在使用此页面之前,管理员必须按照 Configure Access 中的说明公开 PAC controller。

使用此页面获取 PAC 的 webhook URL。该 URL 使 Git provider 能够将仓库事件(如 commits 和 merge requests)通知 PAC,从而让 PAC 触发匹配的 PipelineRuns。

请选择与 PAC 暴露方式相匹配的部分:Gateway API、Ingress 或 NodePort。示例使用默认的 PAC 命名空间 tekton-pipelines;如果你的 TektonConfig 使用了不同的 targetNamespace,请在命令中替换它。

使用 Gateway API

如果 PAC 是通过 Gateway API 暴露的,请使用此部分。

从 HTTPRoute 中读取 host 并打印 webhook URL:

HOST=$(kubectl get httproute pipelines-as-code -n tekton-pipelines \
  -o jsonpath='{.spec.hostnames[0]}')

if [ -z "${HOST}" ]; then
  echo "HTTPRoute host is empty. Configure a hostname in the exposure manifest first."
  exit 1
fi

WEBHOOK_URL="http://${HOST}"
echo "${WEBHOOK_URL}"

预期结果:命令会打印基于 host 的 PAC webhook URL。

在配置 Git provider webhook 或设置仓库集成时使用此 URL。对于自动 webhook 注册,还需要按下文所述在 pipelines-as-code-info 中记录此 URL。

使用 Ingress

如果 PAC 是通过 Ingress 暴露的,请使用此部分。

从 Ingress 中读取 host 并打印 webhook URL:

HOST=$(kubectl get ingress pipelines-as-code -n tekton-pipelines \
  -o jsonpath='{.spec.rules[0].host}')

if [ -z "${HOST}" ]; then
  echo "Ingress host is empty. Configure a host rule or use a reachable address from the Ingress controller."
  exit 1
fi

WEBHOOK_URL="http://${HOST}"
echo "${WEBHOOK_URL}"

如果 Ingress 已配置 TLS,请改用 https://${HOST}:

WEBHOOK_URL="https://${HOST}"
echo "${WEBHOOK_URL}"

使用 NodePort

如果 PAC 是通过专用的 NodePort Service 暴露的,请使用此部分。从可达的节点 IP 和生成的 NodePort 打印 URL:

NODEPORT=$(kubectl get svc pipelines-as-code-controller-nodeport -n tekton-pipelines \
  -o jsonpath='{.spec.ports[?(@.name=="http-listener")].nodePort}')

NODE_IP=$(kubectl get nodes \
  -o jsonpath='{.items[0].status.addresses[?(@.type=="InternalIP")].address}')

WEBHOOK_URL="http://${NODE_IP}:${NODEPORT}"
echo "${WEBHOOK_URL}"

记录 Webhook URL

自动 webhook 注册会从 pipelines-as-code-info.data.controller-url 读取公开的 PAC webhook URL。在选择并验证 WEBHOOK_URL 后,请更新 PAC component options,以便由 Tekton Operator 管理该 ConfigMap。

在 TektonConfig 的 platforms.kubernetes 下更新 pipelinesAsCode options。operator 会在 platforms.openshift 下对相同的块返回验证错误:

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  targetNamespace: tekton-pipelines
  platforms:
    kubernetes:
      pipelinesAsCode:
        enable: true
        options:
          disabled: false
          configMaps:
            pipelines-as-code-info:
              data:
                controller-url: https://pac.example.com

不要把这个块放到派生的 OpenShiftPipelinesAsCode CR 上:operator 会在下一次 reconcile 时将 options 从 TektonConfig 重新复制回来,因此该 URL 会丢失。唯一的例外是 TektonConfig 完全不管理 PAC 的集群——即 spec.profile 为 basic 或 lite——在这种情况下,同样的 options 块应放在该 CR 的 spec.options 下。请参见 How the Operator Manages PAC。

将 https://pac.example.com 替换为打印出的 WEBHOOK_URL 值。此值变更后,webhook registration controller 会对所有 PAC Repository 资源执行 reconcile,使其 provider-side webhooks 使用新的 URL。

验证

Webhook URL 必须能够从你的 Git provider 访问。对于公共 Git provider,该 URL 必须可被公网访问。对于自托管 Git provider,只要 provider 主机能够访问集群即可。

如果 DNS 还未准备就绪,请从 Git provider 网络中使用解析到 Gateway 或 Ingress 外部地址的 host 来验证 route。除非 PAC 的暴露配置不要求 host,否则不要注册原始 IP URL。

设置 WEBHOOK_URL 后,从可以访问 PAC endpoint 的主机上执行一次快速检查:

curl -i "${WEBHOOK_URL}"

在当前 PAC 版本中,GET / 会返回 200 OK,并带有一个较小的 JSON status body。连接被拒绝或超时表示存在网络问题。

后续步骤