在 Tekton Task 中使用 GitLab Connector

在 Tekton Tasks 中使用 GitLab Connector 可以集中管理 GitLab 凭据,并在 Tekton Task 执行期间安全访问 GitLab 仓库。

Tekton Task 的要求

并非所有 Tekton Tasks 都可以使用 GitLab Connector。

GitLab Connector 通过 CSI Driver 注入临时凭据。它提供一些配置,用于生成带有临时认证和 URL 重写设置的配置文件:

  • gitconfig:为 Git CLI 操作提供 .gitconfig 文件
  • gitlabconfig:为 GitLab CLI (glab) 操作提供 config.yml 文件

生成的 .gitconfig 示例:

[http "http://c-gitlab-connector.gitlab-demo.svc"]
    extraHeader = Authorization: Basic OmV5Smhixxxxxxxxx==
[url "http://c-gitlab-connector.gitlab-demo.svc"]
    insteadOf = https://gitlab.com

生成的 config.yml 示例:

git_protocol: http
host: c-gitlab-connector.gitlab-demo.svc
no_prompt: true
telemetry: false
hosts:
  c-gitlab-connector.gitlab-demo.svc:
    token: k8s-api-token-xxxxxxxx

因此,Tekton Tasks 必须满足以下要求才能使用 GitLab Connector:

对于 Git CLI 操作:

  • 支持通过 Workspace 挂载 .gitconfig 文件

对于 GitLab CLI (glab) 操作:

  • 支持通过 Workspace 挂载 config.yml 文件
  • 支持通过 Workspace 挂载 .gitconfig 文件(使用 glab 克隆仓库或与仓库目录交互时必需)

使用说明

为 Git CLI 操作使用 GitConfig

在 Tekton Tasks 中使用 Git CLI 时,挂载 gitconfig 配置:

apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: git-demo
spec:
  # . . .
  workspaces:
  - name: git-auth
    csi:
      driver: connectors-csi
      readOnly: true
      volumeAttributes:
        connector.name: gitlab-connector
        configuration.names: "gitconfig"

参数说明:

  • name:在 Task 中定义的 Workspace 名称
  • csi:
    • driver:固定值 connectors-csi
    • readOnly:固定值 true
    • volumeAttributes:CSI Volume 属性
      • connector.name:GitLab Connector 的名称
      • connector.namespace:(可选)GitLab Connector 的 Namespace;如果未指定,则使用 TaskRun 的 Namespace
      • configuration.names:配置名称(Git CLI 操作为 gitconfig)

为 GitLab CLI 操作使用 GitLabConfig

在 Tekton Tasks 中使用 GitLab CLI (glab) 时,同时挂载 gitlabconfig 和 gitconfig:

apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: glab-demo
spec:
  # . . .
  workspaces:
  - name: gitlab-auth
    csi:
      driver: connectors-csi
      readOnly: true
      volumeAttributes:
        connector.name: gitlab-connector
        connector.namespace: ""
        configuration.names: "gitlabconfig,gitconfig"

Task 应当:

  1. 将配置文件复制到相应位置:

    • .gitconfig → ~/.gitconfig
    • config.yml → ~/.config/glab-cli/config.yml
  2. 设置正确的文件权限:

    • ~/.gitconfig → 644
    • ~/.config/glab-cli/config.yml → 600

结合 GitLab Connector 使用自定义 CLI 工具

当结合 GitLab Connector 使用自定义 CLI 工具(如 reviewdog)时,可以使用内置配置文件通过代理服务访问 GitLab API。

有关更多详情,请参阅:Connectors CSI 内置配置

或者参考 将 Reviewdog 与 GitLab Connector 一起使用 了解更多详情。

延伸阅读