架构

架构

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 是一个核心组件,为 Kubernetes 集群中的已集成工具提供安全、无密钥访问。它充当代理服务器,负责将认证信息注入请求并将请求路由到目标工具。

ConnectorsProxy 使客户端无需直接处理凭证即可访问工具资源。这种方式带来了显著的安全优势:

  • 无密钥访问:通过使用由 ServiceAccount 签发的短期令牌,避免将工具凭证直接分发给客户端。这可以防止凭证泄露到客户端中的日志或环境变量等位置。
  • 集中式凭证管理:所有工具凭证都由连接器集中管理,无需向每个客户端分发凭证。

该平台同时支持内置和自定义代理实现,以适配不同工具的认证需求。

内置 Connectors Proxy

内置实现提供了完整的 HTTP/HTTPS 协议支持,并支持 Basic Auth 和 Bearer Token 认证方式。它同时提供正向代理和反向代理能力,以实现最大的灵活性。

由 ConnectorClass 使用:K8s ConnectorClass、Git ConnectorClass

自定义 Connectors Proxy

对于需要特殊认证机制的工具,可以开发自定义代理实现。

示例:OCI ConnectorClass 使用自定义的 OCI Plugin Proxy,支持 OCI 协议,并为 Harbor 和 Docker Registry 等仓库提供 Bearer Token 授权。

更多信息: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