Git 连接器
Git 连接器是一个与平台无关的连接器,可用于连接到任何 Git Server,例如 GitHub、GitLab、Bitbucket。
你可以使用 Git Connector 在 CICD pipeline 中安全地克隆私有仓库,或者在容器化工作负载中使用它,在不使用凭证的情况下执行 Git 操作。
此外,你可以跨 namespace 统一管理 Git 访问配置,避免在每个 namespace 中重复配置 Git 凭证。
本文将介绍:
- Git server 的要求
- 如何基于 Git connectorclass 创建 Git 连接器
- Git 连接器的代理和配置能力
目录
Git Server 要求基于 Git ConnectorClass 创建 Git 连接器快速开始spec.connectorClassName说明地址认证使用 Basic Authentication所需的凭证权限认证参数代理和配置代理地址配置更多Git Server 要求
要访问的 Git server 必须满足以下条件:
- 必须支持 HTTP/HTTPS 传输协议,并且仅兼容 Git 的 “smart HTTP” 协议模式。该模式是现代 Git server 的标准实现,支持高效的数据传输和认证机制。
基于 Git ConnectorClass 创建 Git 连接器
快速开始
spec.connectorClassName
固定值 git。
说明
你可以通过 annotations 字段为 Git 连接器添加描述信息。
cpaas.io/description:Git 连接器的描述信息。
例如:
地址
spec.address 指定 Git server 的访问地址,例如:https://github.com。需要注意的是,该地址用于克隆 Git 仓库,而不是 Git server 的 API 地址。
认证
Git 连接器支持以下认证类型:
basicAuth:基于用户名和密码的认证(可选),对应的 secret 类型:kubernetes.io/basic-auth
使用 Basic Authentication
例如:
你需要在同一个 namespace 中创建一个 Secret,例如:
注意:password 字段不局限于实际的用户密码。只要满足 所需的凭证权限 章节中列出的权限要求,你也可以使用其他类型的凭证,例如 Personal Access Tokens(PAT)或 API key。
如果 Git server 不需要认证,可以省略 secretRef 字段:
所需的凭证权限
配置的凭证所需权限取决于你计划如何在 Pod/Pipeline 中使用它。此外,凭证还必须具备 认证参数 章节中指定的认证仓库的克隆权限。
例如:
- 如果你需要在 pipeline 中使用该连接器同时执行 clone 和 push 操作,那么凭证必须对目标仓库同时具备 clone 和 push 权限。换句话说,该凭证应允许你既能从仓库 clone,也能向仓库 push。
- 如果你只需要在 pipeline 中克隆仓库,那么凭证只需要对目标仓库具备 clone 权限。
出于安全最佳实践,我们建议创建仅具备最小必要权限的凭证。当需要更高权限时,请创建使用权限更高的 secret 的独立连接器,并通过 namespace 隔离来控制哪些用户可以访问每个连接器。
认证参数
为了检查凭证是否有效,你需要指定一个 Git 仓库路径。连接器会在运行时使用该凭证访问该仓库,以确定凭证是否有效。
该认证参数通过 spec.auth.params 指定。
repository:指定用于认证检查的 Git 仓库路径,例如org/repo.git。
例如:
代理和配置
为了让客户端能够在不使用凭证的情况下访问 Git 仓库,Git connectorclass 提供了一个代理服务器,用于自动注入认证信息。
拥有该连接器访问权限的客户端可以使用此代理服务器访问 Git 仓库,而无需在客户端侧配置凭证。
为简化使用,Git connectorclass 提供了配置信息,可通过 CSI 挂载到 Pod 中。在 Pod 内执行 Git 操作时,可自动使用代理服务完成 Git 操作。
代理地址
创建 Git 连接器时,系统会自动创建一个用于代理访问 Git 仓库的 Service。
系统会将代理地址记录在 status.proxy.httpAddress 字段中。
例如:
配置
基于 Git connectorclass 创建的 Git 连接器提供以下配置:
gitconfig:Git 配置信息。
- 提供一个
.gitconfig配置文件,其中 Git 仓库地址会被替换为代理地址。结合 connector-csi-driver,该配置文件会挂载到 Pod 中,使得无需在客户端侧配置凭证即可通过代理访问 Git 仓库。
Pod 中生成的配置文件示例:
Authorization header 的作用域限定为代理地址,因此它只会在经过代理的请求中发送。对于其他主机的请求——例如在 git clone --recurse-submodules 期间托管在不同 git server 上的 submodule——不会携带由连接器注入的 header。
更多使用场景可参考 在 Clone Job 中使用 Git 连接器。