快速开始
本文档将帮助你快速了解如何创建一个 Git Connector,并将其用于安全克隆仓库,而无需直接处理凭据。
目录
简介适用场景预计阅读时间注意事项前提条件流程概览操作步骤步骤 1:创建命名空间步骤 2:创建 Git 凭据和 Connector步骤 3:创建克隆 Job步骤 4:验证操作预期结果工作原理故障排查后续步骤简介
适用场景
Git Connector 可通过以下方式安全地执行代码克隆操作:
- 集中管理凭据,而不是将其硬编码到工作负载中
- 在克隆过程中自动注入认证信息
- 为跨团队访问私有仓库提供受控访问
这种方式尤其适用于:
- 需要安全访问私有仓库的 CI/CD pipeline
- 需要在不共享凭据的情况下共享仓库访问权限的团队
- 需要集中管理 Git 凭据的环境
预计阅读时间
15 分钟
注意事项
- Git connector 使用 CSI driver 集成安全地注入 Git 凭据。
- Connector 生成的配置将在 30 分钟后过期。
前提条件
- 已安装 Connectors system 的 Kubernetes 集群(Operator、Core 和 Git 组件)。有关安装这些组件的详细信息,请参阅 安装指南。
- 已配置可与集群通信的 kubectl
- 带有有效凭据的 Git 仓库(用户名/密码或 令牌)
- 对 Kubernetes 资源的基本了解
流程概览
操作步骤
步骤 1:创建命名空间
为此演示创建一个专用的命名空间:
步骤 2:创建 Git 凭据和 Connector
创建包含 Git 凭据的 Secret 和 Git Connector 资源。有关创建和配置 connector 的更多详细信息,请参阅 Connectors 快速开始指南。
验证 connector 处于 "Ready" 状态:
输出应显示:
步骤 3:创建克隆 Job
创建一个使用 connector 克隆仓库的 job:
关键参数:
connector.name:Git connector 的名称configuration.names:设置为 "gitconfig",它引用了 Git ConnectorClass 中定义的特定配置模板。该模板用于生成 ".gitconfig" 文件,并为认证和 URL 重写提供相应设置。mountPath:必须设置为 "/root/",因为容器以 root 用户运行,Git 会在 "/root/.gitconfig" 路径下查找配置
步骤 4:验证操作
检查 job 日志,确认仓库已成功克隆:
你应该会看到 Git 克隆操作成功完成,且没有任何认证错误。
预期结果
成功完成所有步骤后,你将看到:
-
处于 "Ready" 状态的 Git connector:
-
job 日志中的一次成功 Git 克隆操作:
工作原理
Git Connector 的工作方式如下:
- 将原始 Git 仓库 URL 替换为代理服务 URL
- 将认证信息注入到发往代理服务的请求中
- 代理服务在将请求转发到 Git server 时添加必要的凭据
若要查看生成的配置:
查看生成的配置:
示例输出:
故障排查
如果克隆操作失败,请检查以下内容:
-
Connector 状态:确保 connector 处于 "Ready" 状态:
-
RBAC 权限:验证 RoleBinding 是否正确配置。
-
Job 配置:
- 确保卷挂载路径正确(/root/)
- 验证仓库 URL 与 connector 中配置的一致
后续步骤
成功使用 Git Connector 克隆第一个仓库后,你可以:
- 将这种方式集成到你的 CI/CD pipeline 中
- 在其他 Git 操作中使用该 connector,例如 push、pull 和 fetch
- 为不同的 Git 服务创建 connector