dyrnq/tektoncd-pipeline-cmd-git-init

Tekton Pipeline git-init 镜像文档

镜像概述

gcr.io/tekton-releases/github.com/tektoncd/pipeline/cmd/git-init 是 Tekton Pipeline 项目的官方组件镜像，包含 git-init 工具。该工具专为在 Tekton Task 中执行 Git 相关操作设计，主要用于从 Git 仓库获取源代码，是 Tekton CI/CD 流程中实现"源代码获取"步骤的关键组件。

核心功能与特性

• Git 仓库克隆：支持通过 HTTPS、SSH 协议克隆远程 Git 仓库
• 版本控制：支持指定分支（branch）、标签（tag）或提交哈希（commit SHA）进行代码检出
• 认证集成：兼容多种 Git 认证方式，包括 SSH 密钥、HTTPS 用户名密码、OAuth 令牌及凭证存储（如 Kubernetes Secret）
• Git 配置支持：可自定义 Git 全局配置（如 user.name、user.email、http.proxy 等）
• 轻量级设计：专注于 Git 操作的稳定性与兼容性，镜像体积小，启动速度快
• 子模块支持：可配置拉取仓库子模块（submodules）

使用场景与适用范围

• CI/CD 源代码获取：在 Tekton Task 中作为初始步骤，拉取源代码用于后续构建、测试或部署流程
• 多仓库协同：支持从多个 Git 仓库获取代码，满足复杂项目的多源依赖需求
• 版本化构建：通过指定分支、标签或提交哈希，实现基于特定代码版本的构建与发布
• 跨平台 Git 操作：兼容主流 Git 服务（GitHub、GitLab、Bitbucket、Gitea 等）

使用方法与配置说明

基本使用（Tekton Task 示例）

在 Tekton Task 中，通过 step 引用该镜像，配置 Git 操作参数。以下是典型的 Task 定义示例：

yaml
apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
  name: git-clone-example
spec:
  params:
    - name: repo-url
      type: string
      description: Git 仓库 URL（如 https://github.com/example/repo.git 或 git@github.com:example/repo.git）
    - name: branch
      type: string
      description: 分支或标签名
      default: main
  workspaces:
    - name: source
      description: 用于存放克隆代码的工作空间
  steps:
    - name: git-clone
      image: gcr.io/tekton-releases/github.com/tektoncd/pipeline/cmd/git-init
      workingDir: $(workspaces.source.path)
      args:
        - "-url=$(params.repo-url)"
        - "-revision=$(params.branch)"
        - "-path=."  # 克隆到当前工作目录（即工作空间路径）

关键配置参数

git-init 工具通过命令行参数接收配置，常用参数如下：

认证配置

git-init 支持多种 Git 认证方式，需通过 Kubernetes Secret 挂载或环境变量注入凭证：

1. SSH 认证

• 将 SSH 私钥（如 id_rsa）存储在 Kubernetes Secret 中
• 在 Task 中通过 Workspace 或 Volume 将 Secret 挂载至容器的 ~/.ssh 目录（通常路径为 /root/.ssh）

示例 Secret 定义：

yaml
apiVersion: v1
kind: Secret
metadata:
  name: git-ssh-cred
type: Opaque
data:
  id_rsa: <base64-encoded-ssh-private-key>  # 私钥内容经 base64 编码
  known_hosts: <base64-encoded-known-hosts>  # 可选，预配置 known_hosts 避免主机验证提示

Task 中挂载配置：

yaml
workspaces:
  - name: ssh-creds
    mountPath: /root/.ssh
    readOnly: true

2. HTTPS 认证（用户名密码/OAuth 令牌）

• 通过环境变量 GIT_USERNAME 和 GIT_PASSWORD 注入凭证（适用于 HTTPS 仓库）
• 若使用 OAuth 令牌（如 GitHub Personal Access Token），可将令牌作为 GIT_PASSWORD，GIT_USERNAME 可设为任意非空值（如 git）

示例 Task 步骤环境变量配置：

yaml
steps:
  - name: git-clone
    image: gcr.io/tekton-releases/github.com/tektoncd/pipeline/cmd/git-init
    env:
      - name: GIT_USERNAME
        valueFrom:
          secretKeyRef:
            name: git-https-cred
            key: username
      - name: GIT_PASSWORD
        valueFrom:
          secretKeyRef:
            name: git-https-cred
            key: password
    args: ["-url=https://github.com/private-repo.git", "-revision=main"]

环境变量

除认证相关变量外，git-init 还支持以下环境变量控制行为：

注意事项

• 该镜像仅用于 Tekton Task 中作为步骤执行，不建议直接通过 docker run 命令独立运行
• 需确保 Task 运行的 ServiceAccount 具有访问相关 Secret（如认证凭证）的权限
• 对于大型仓库，建议使用 -depth 参数启用浅克隆以提升性能
• 若仓库使用自签名 SSL 证书，需配置 sslVerify=false 或挂载 CA 证书至容器的信任根目录（如 /etc/ssl/certs）