获取 PAC Webhook URL

Important

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

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

请选择与 PAC 暴露方式相匹配的部分:Gateway API、Ingress 或主机端口。示例使用默认的 PAC namespace tekton-pipelines;如果你的 OpenShiftPipelinesAsCode CR 使用了不同的 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 或设置 repository integration 时使用此 URL。若要进行自动 webhook 注册,还需按下文所述将此 URL 记录到 pipelines-as-code-info 中。

使用 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}"

使用主机端口

如果 PAC 是通过专用的主机端口 Service 暴露的,请使用本部分。从可访问的节点 IP 和生成的主机端口打印 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。

如果 PAC 由 OpenShiftPipelinesAsCode 管理,请按如下方式更新该资源:

apiVersion: operator.tekton.dev/v1alpha1
kind: OpenShiftPipelinesAsCode
metadata:
  name: pipelines-as-code
spec:
  targetNamespace: tekton-pipelines
  options:
    configMaps:
      pipelines-as-code-info:
        data:
          controller-url: https://pac.example.com

如果 PAC 由 TektonConfig 管理,请改为更新 platforms.openshift.pipelinesAsCode 选项:

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

请将 https://pac.example.com 替换为打印出的 WEBHOOK_URL 值。当该值发生变化时,webhook registration controller 会协调所有 PAC Repository 资源,使其 provider 端的 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 状态 body。连接被拒绝或超时通常表示网络问题。

下一步