快速开始
本文档将帮助你快速了解如何创建 GitLab Connector,并将其用于安全克隆仓库以及执行 GitLab 操作,而无需直接处理凭据。
预计阅读时间
15 分钟
前提条件
- 已安装 Connectors 系统的 Kubernetes 集群(ConnectorsCore 和 ConnectorsGitLab 组件)。有关安装这些组件的详细信息,请参阅 安装指南。
- 已配置 kubectl 可与集群通信
- 带有有效 Private Access Token(PAT)的 GitLab 仓库
- 对 Kubernetes 资源的基本了解
流程概览
操作步骤
步骤 1:创建 Namespace
为此演示创建一个专用命名空间:
步骤 2:创建 GitLab 凭据和 Connector
同时创建包含 GitLab Private Access Token 的 Secret 和 GitLab Connector 资源。有关创建和配置 connector 的更多详细信息,请参阅 Connectors 快速开始指南。
重要说明:
- Secret 类型必须为
connectors.cpaas.io/gitlab-pat-auth - 对于 GitLab.com,请使用
https://gitlab.com作为地址 - 对于自托管 GitLab,请使用你的 GitLab 服务器 URL(例如
https://gitlab.example.com) address应该是用于仓库克隆的 GitLab 服务器 URL,而不是 API 地址
验证 connector 处于“Ready”状态:
输出应显示:
步骤 3:创建克隆 Job
创建一个使用 Connector 通过 Git CLI 克隆 GitLab 仓库的 Job:
请将 https://<your-gitlab-server>/<your-group>/<your-repo>.git 替换为你的实际 GitLab 仓库 URL。
关键参数:
connector.name:你的 GitLab connector 的名称configuration.names:设置为 "gitconfig" 以挂载 Git 配置文件mountPath:将配置挂载到/opt/git,并复制到/root/供 Git 使用
步骤 4:验证操作
检查 Job 的日志,确认仓库已成功克隆:
你应该看到 Git clone 操作成功完成,且没有任何身份验证错误。输出应包含:
工作原理
GitLab Connector 的工作方式如下:
- 将原始 GitLab 仓库 URL 替换为代理服务 URL
- 向发送到代理服务的请求中注入身份验证信息(K8S API 令牌)
- 代理服务在将请求转发到 GitLab 服务器时添加所需的凭据(Connector 的 Secret)
- 对于 Git 操作,
.gitconfig文件包含 URL 重写规则和身份验证头
要检查生成的配置:
查看生成的 Git 配置:
示例输出:
此配置:
- 为编码后的 K8S API 令牌添加 Authorization 头,且仅应用于发送到代理服务地址的请求
- 将 GitLab URL 重写为使用代理服务
故障排除
如果克隆操作失败,请检查以下内容:
-
Connector 状态:确保 connector 处于“Ready”状态:
-
Private Access Token:验证你的 GitLab PAT 具有必要的权限:
- 克隆需要
read_repository范围
- 克隆需要
-
Job 配置:
- 确保卷挂载路径正确
- 验证仓库 URL 与你的 GitLab 仓库一致
- 检查
.gitconfig文件是否已正确复制到/root/
-
网络连接:确保你的集群可以访问 GitLab 服务器
下一步
在使用 GitLab Connector 成功克隆第一个仓库后,你可以:
- 了解如何将 GitLab CLI(glab)与 Connector 配合使用,以便在 使用 GitLab CLI 指南 中与 GitLab 交互
- 使用自定义 CLI 工具,例如 reviewdog,在 使用 Reviewdog CLI 工具指南 中与 GitLab 交互
- 在 CI/CD 集成指南 中将此方法集成到你的 CI/CD 流水线中
- 浏览 GitLab ConnectorClass 概念 以了解高级配置选项