架构

架构

Connector

Connector 是一种资源,表示某个特定工具的集成实例。通过配置工具的访问 URL 和认证信息,我们可以为该工具创建一个集成实例。

例如,使用 GitHub Private Access Token 集成 https://github.com 是通过 Connector 实现的。

在 Kubernetes 中,Connector 是一种命名空间级别的自定义资源。用户可以在同一命名空间内创建多个 Connector,以集成不同的工具。

例如,在 default 命名空间中,可以同时创建一个用于集成 https://github.com 的 Connector,以及一个用于集成 https://hub.docker.com/ 的 Connector。

平台管理员可以通过管理 Connector 资源来统一管理整个集群中的工具集成。

ConnectorClass

ConnectorClass 定义了特定类型工具的访问方式和行为规范。它规定了与某一类工具集成时所需的参数,例如工具地址和认证信息。

例如,Git ConnectorClass 定义了与 Git 工具集成时需要提供的配置项,包括 Git 服务的地址和 Basic-Auth 认证信息。

在 Kubernetes 中,ConnectorClass 是一种集群级别的自定义资源。开发者可以通过定义新的 ConnectorClass 来扩展平台所支持的工具类型。

例如,可以定义一个 Harbor ConnectorClass 以支持与 Harbor 镜像仓库集成,定义一个 MySQL ConnectorClass 以支持与 MySQL 数据库集成,或者定义一个 Jira ConnectorClass 以支持与 Jira 项目管理工具集成。

Connectors Proxy

ConnectorsProxy 是 Connectors 系统的核心组件,它为在 Kubernetes 集群内访问已集成工具提供了一种安全、无密钥的方式。它充当代理服务器,负责处理认证并将请求路由到实际的工具端点。

ConnectorsProxy 使客户端能够访问工具资源,而无需直接处理认证凭证。这通过以下方式显著提升了安全性:

  • 使用由 ServiceAccount 签发的短期令牌,避免将工具凭证直接分发给客户端
  • 防止凭证在日志或环境变量中泄露
  • 集中管理凭证

它支持多种协议,并且可以处理不同类型的工具集成:

  • 用于 REST API 的 HTTP/HTTPS 协议
  • 用于代码仓库服务器(例如 GitHub、GitLab)的带 HTTP Basic Auth 的 Git 协议
  • 用于 OCI 仓库(例如 Harbor、Docker Registry)的带 Bearer Token Authorization 的 OCI 协议

更多信息:Connectors Proxy

Connectors API

Connectors API 提供了基于 Connector 实例访问内部工具资源的能力。例如,对于 Git Connector,Connectors API 可以获取 Git 仓库中的分支列表(References)。

开发者可以通过 Connectors API 方便地访问工具中的资源,而无需关注具体的工具地址和认证细节。

该 API 在实际应用中非常有用,例如:

  • 在创建应用时获取容器镜像的标签列表
  • 在执行 Git Clone 操作期间获取代码仓库的分支列表(References)

Connectors API 的实现基于 ConnectorClass API 提供的底层能力。

ConnectorClass API

ConnectorClass API 定义了特定类型工具所提供的 API。

不同类型的工具可以提供不同的 API 能力,例如:

  • Git ConnectorClass API 可以提供获取代码仓库分支列表的能力
  • OCI ConnectorClass API 可以提供获取制品仓库标签列表的能力

开发者可以为每个 ConnectorClass 定义独特的 API 能力,最终这些能力会通过 Connectors API 暴露给客户端。

Connectors CSI Driver

为了便于 K8S 工作负载更容易地使用 Connectors-Proxy 的能力,可以使用 Connectors CSI Driver。

Connectors CSI Driver 可以将保存在 ConnectorClass 中的配置文件模板渲染后的内容挂载到工作负载中。该配置文件可以包含访问 Connectors Proxy 的信息,使用户只需对原始脚本进行最小修改,即可使用 Connectors Proxy 的能力。

更多信息,请参阅 connectors csi driver