快速开始

本文档将帮助你快速了解如何创建 Git Connector,并将其用于安全地克隆仓库,而无需直接处理凭据。

简介

适用场景

Git Connector 允许你通过以下方式安全地执行代码克隆操作:

  • 集中管理凭据,而不是将其硬编码到工作负载中
  • 在克隆过程中自动注入身份验证
  • 为跨团队访问私有仓库提供受控权限

这种方式尤其适用于:

  • 需要安全访问私有仓库的 CI/CD pipeline
  • 多个团队共享仓库访问权限但不共享凭据
  • 需要集中管理 Git 凭据的环境

预计阅读时间

15 分钟

注意事项

  • Git connector 使用 CSI driver 集成来安全注入 Git 凭据。
  • Connector 生成的配置会在 30 分钟后过期。

前提条件

  • 已安装 Connectors system 的 Kubernetes 集群(Operator、Core 和 Git components)。有关安装这些组件的详细信息,请参阅 安装指南。
  • 已配置 kubectl 可与集群通信
  • 具有有效凭据的 Git repository(username/password 或 token)
  • 对 Kubernetes 资源的基本了解

流程概览

序号操作步骤描述
1创建 Namespace为演示创建一个专用 Namespace
2创建 Git 凭据和 Connector为 Git 访问设置凭据和 connector
3配置 RBAC 权限授予使用 connector 的相应权限
4创建 Clone Job部署一个使用 connector 克隆 repository 的 job
5验证操作检查 repository 是否已成功克隆

操作步骤

步骤 1:创建 Namespace

为本次演示创建一个专用 Namespace:

kubectl create ns git-connector-demo

步骤 2:创建 Git 凭据和 Connector

同时创建包含 Git 凭据的 Secret 和 Git Connector 资源。有关创建和配置 connector 的更详细信息,请参阅 Connectors 快速开始指南。

cat <<EOF | kubectl apply -f -
kind: Secret
apiVersion: v1
metadata:
  name: git-auth
  namespace: git-connector-demo
type: kubernetes.io/basic-auth
stringData:
  username: your-username # Replace with your Git username
  password: your-token    # Replace with your Git password or token
---
apiVersion: connectors.alauda.io/v1alpha1
kind: Connector
metadata:
  name: git-connector
  namespace: git-connector-demo
spec:
  connectorClassName: git
  address: https://github.com  # Replace with your Git server address
  auth:
    name: basicAuth
    secretRef:
      name: git-auth
    params:
    - name: repository
      value: your-org/your-repo.git  # Replace with your repository path
EOF

验证 connector 是否处于 "Ready" 状态:

kubectl get connector git-connector -n git-connector-demo

输出应显示:

NAME           CLASS   ADDRESS            READY   AGE
git-connector  git     https://github.com True    1m

步骤 3:创建 Clone Job

创建一个使用 connector 克隆 repository 的 job:

cat <<EOF | kubectl apply -f -
apiVersion: batch/v1
kind: Job
metadata:
  name: git-clone
  namespace: git-connector-demo
spec:
  template:
    spec:
      restartPolicy: Never
      containers:
      - name: git
        image: bitnami/git:2.47.1
        imagePullPolicy: IfNotPresent
        command:
        - "git"
        args: [ "clone", "--progress", "https://github.com/your-org/your-repo.git", "/tmp/repo" ]  # Replace with your repo
        volumeMounts:
        - name: gitconfig
          mountPath: /root/
      volumes:
      - name: gitconfig
        csi:
          readOnly: true
          driver: connectors-csi
          volumeAttributes:
            connector.name: "git-connector"
            configuration.names: "gitconfig"
EOF

关键参数:

  • connector.name:Git connector 的名称
  • configuration.names:设置为 "gitconfig",它引用了 Git ConnectorClass 中定义的一个特定配置模板。该模板用于生成 ".gitconfig" 文件,其中包含用于身份验证和 URL 重写的相应设置。
  • mountPath:必须设置为 "/root/",因为容器以 root 用户运行,Git 会在 "/root/.gitconfig" 路径下查找配置

步骤 4:验证操作

检查 job 日志,确认 repository 已成功克隆:

kubectl logs -f job/git-clone -n git-connector-demo

你应该会看到 Git clone 操作成功完成,且没有任何身份验证错误。

预期结果

在成功完成所有步骤后,你将看到:

  1. 一个处于 "Ready" 状态的 Git connector:

    NAME           CLASS   ADDRESS            READY   AGE
    git-connector  git     https://github.com True    5m
  2. job 日志中显示成功的 Git clone 操作:

    Cloning into '/tmp/repo'...
    remote: Enumerating objects: 1324, done.
    remote: Counting objects: 100% (1324/1324), done.
    remote: Compressing objects: 100% (712/712), done.
    remote: Total 1324 (delta 612), reused 1324 (delta 612), pack-reused 0
    Receiving objects: 100% (1324/1324), 2.56 MiB | 4.25 MiB/s, done.
    Resolving deltas: 100% (612/612), done.

工作原理

Git Connector 的工作方式如下:

  1. 用代理服务 URL 替换原始 Git repository URL
  2. 向代理服务请求中注入身份验证信息
  3. 代理服务在将请求转发到 Git server 时添加必要的凭据

要查看生成的配置:

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Pod
metadata:
  name: inspect-git-config
  namespace: git-connector-demo
spec:
  restartPolicy: Never
  containers:
  - name: git
    image: bitnami/git:2.47.1
    command: ["sleep", "3600"]
    volumeMounts:
    - name: gitconfig
      mountPath: /root/
  volumes:
  - name: gitconfig
    csi:
      readOnly: true
      driver: connectors-csi
      volumeAttributes:
        connector.name: "git-connector"
        configuration.names: "gitconfig"
EOF

查看生成的配置:

kubectl exec -it inspect-git-config -n git-connector-demo -- cat /root/.gitconfig

示例输出:

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

故障排查

如果你的 clone 操作失败,请检查以下内容:

  1. Connector 状态:确保 connector 处于 "Ready" 状态:

    kubectl describe connector git-connector -n git-connector-demo
  2. RBAC 权限:验证 RoleBinding 是否已正确配置。

  3. Job 配置:

    • 确保 volume mount path 正确(/root/)
    • 验证 repository URL 与 connector 中配置的内容一致

下一步

在成功使用 Git Connector 克隆第一个 repository 之后,你可以:

  • 将这种方式集成到你的 CI/CD pipeline 中
  • 在其他 Git 操作中使用 connector,例如 push、pull 和 fetch
  • 为不同的 Git 服务创建 connector