快速开始
本文档将帮助你快速了解并使用 Connectors 系统。
目录
简介适用场景预计阅读时间注意事项前提条件流程概览操作步骤第 1 步:验证所需组件第 2 步:创建认证 Secret第 3 步:创建 GitHub connector第 4 步:验证 connector 状态预期结果故障排查下一步简介
适用场景
Connectors 系统为在整个 Kubernetes 集群中安全管理外部系统连接提供了一种统一方式。通过使用 connectors,你可以:
- 集中管理外部服务的凭证
- 消除应用代码中的硬编码凭证
- 确保整个组织内一致的访问模式
- 在一个位置监控和审计服务连接
本指南以 GitHub 为例,但相同的原则也适用于连接其他服务。
预计阅读时间
10-15 分钟
注意事项
- 本快速开始假设你已经安装了 Connectors Operator,并且
ConnectorsConfig已协调到Ready(operator 会自动创建一个 — 参见 安装指南)。默认安装会启用所有组件,包括本指南所需的core和git。 - 你需要一个 GitHub 账户以及一个具有适当权限的 Personal Access Token (PAT)。
- connector 状态反映连接的健康状况和可访问性。
前提条件
- 已安装 Connectors Operator 且
ConnectorsConfig已协调到Ready的 Kubernetes 集群。默认安装会启用本指南所需的core和git组件。 - 已配置 kubectl 以便与集群通信
- GitHub 账户和有效的 Personal Access Token (PAT)
- 对 Kubernetes 资源的基本了解
流程概览
操作步骤
第 1 步:验证所需组件
在创建 GitHub connector 之前,请验证集群中的 connector 基础设施已正确安装。
-
检查
ConnectorsConfig是否已协调到Ready:READY应显示为True。若要查看各组件的阶段,请运行kubectl describe connectorsconfig connectors-config -n <namespace>。 -
验证 Git ConnectorClass 是否存在:
如果未找到 Git ConnectorClass,则说明
git组件已禁用或尚未完成安装。请在ConnectorsConfig中启用它(spec.components.git.enabled: true),然后重新检查 — 配置语法请参见 安装指南。
第 2 步:创建认证 Secret
创建一个包含 GitHub 凭证的 Kubernetes Secret。
-
执行以下命令,使用你的 GitHub 凭证创建一个 Secret:
将
your-github-username替换为你的 GitHub 用户名,将your-github-token替换为你的 GitHub Personal Access Token。 -
验证 Secret 是否已成功创建:
第 3 步:创建 GitHub connector
使用 Git ConnectorClass 创建一个到 GitHub 的 connector。
-
将以下 YAML 保存为
github-connector.yaml: -
应用该 connector:
第 4 步:验证 connector 状态
创建 connector 后,请检查其状态以确保其正常工作。
-
使用以下命令检查 connector 状态:
-
如需查看详细状态信息,请使用:
预期结果
成功完成所有步骤后,你将看到以下结果:
-
GitHub connector 资源状态显示为 "Ready":
-
详细状态信息中的所有条件均为 "True":
-
如果 connector 配置了代理功能,你还会在状态中看到一个代理地址:
现在,你已经成功创建了一个 GitHub connector,并验证其可正常工作。
你的应用可以使用该 connector 安全地访问 GitHub 仓库,而无需将凭证直接嵌入应用代码中。
故障排查
如果你的 connector 未能达到 "Ready" 状态,请检查以下内容:
-
ConnectorClass 可用性:确保 Git ConnectorClass 存在:
如果不存在,则说明
ConnectorsConfig上的git组件已禁用或尚未完成安装。有关配置语法,请参见 安装指南。 -
认证配置:确保 Secret 中的凭证正确且具有适当权限。
-
仓库可访问性:验证 auth 参数中指定的仓库是否存在,并且使用所提供的凭证可以访问。
-
检查控制器日志:查看 connector controller 日志以获取详细错误信息:
下一步
现在你已经创建了第一个 connector,可以继续:
- 为其他 Git 服务(GitLab、Harbor 等)创建 connector
- 配置应用以使用该 connector 安全访问 Git 仓库