安装指南
本指南将在 Kubernetes 集群上安装 Connectors 系统。单个 ConnectorsConfig 资源驱动整个安装过程——Connectors Operator 会将其协调为每个组件对应的一个受管子 CR(ConnectorsCore、ConnectorsGit、ConnectorsOCI,等等)。
目录
简介前提条件安装所需的 Pod 安全要求ConnectorsConfig 的工作原理集群单例Operator 启动时自动创建删除级联安装标志步骤 1:安装 Connectors Operator步骤 2:安装 Connectors 组件默认安装(推荐)手动安装验证安装步骤 3:自定义安装(高级)禁用组件在core 上设置 Feature Flags覆盖镜像仓库(集群范围)调整工作负载副本数和资源对外暴露 OCI Proxy状态与阶段条件每个组件的阶段卸载故障排查connectors-csi 未就绪某个组件卡在 Failed 状态相关文档简介
Connectors 系统采用模块化架构,由以下部分组成:
- Connectors Operator — 管理组件,负责协调
ConnectorsConfig并安装其他所有组件。 - ConnectorsConfig — 集群范围内的单一资源,用于声明已安装的组件。
- Connectors 组件 —
ConnectorsCore以及可选的按工具组件。
管理员只需管理 ConnectorsConfig。operator 会基于它创建、更新和删除每个组件的子资源。
前提条件
- 一个 Kubernetes 集群。
- 已配置好可与集群通信的
kubectlCLI。 cluster-admin权限。- 平台的 OperatorHub 中可用的
Alauda DevOps Connectorsoperator 包。
安装所需的 Pod 安全要求
Kubernetes 会在命名空间级别强制执行 Pod Security Standards(PSS)。 Connectors 系统使用两个命名空间,并且它们的权限要求不同:
如果组件命名空间配置为 restricted 或 baseline,CSI 驱动将无法启动。请参见 故障排查 获取恢复步骤。
ConnectorsConfig 的工作原理
ConnectorsConfig 是整个 Connectors 安装的集群范围控制资源。平台管理员编辑 ConnectorsConfig;operator 会将其协调为每个组件对应的子 CR。不要直接编辑受管子 CR(ConnectorsCore、ConnectorsGit,等等)——operator 会在下一次协调时覆盖它们。
集群单例
尽管 ConnectorsConfig 是 namespaced 的,但 admission webhook 会在每次创建时跨所有命名空间进行检查;如果已存在任何其他 ConnectorsConfig,请求就会被拒绝——包括正在删除中的资源(其 finalizer 可能仍在清理子 CR)。这确保了集群范围内只有一个实例:每个受管子 CR 都只属于一个父资源,并且集群对于已安装的组件有单一事实来源。
Operator 启动时自动创建
当 operator 启动且不存在 ConnectorsConfig 时,它会创建一个默认资源,并启用所有受支持的组件且使用默认值。目标命名空间按以下优先级解析:
- 现有
ConnectorsCore所在的命名空间 — 在升级路径中保留该命名空间,以便受管子资源落在原先独立安装所在的位置。请参见升级指南中的 迁移到 ConnectorsConfig。 - operator 自身的安装命名空间(通过 Downward API 注入的
SYSTEM_NAMESPACE)— 用于全新安装。
该引导过程作为 leader-elected runnable 执行,因此每次 leader 选举时都会重新运行(首次部署、滚动重启、leader pod 替换)。该操作是幂等的——如果已经存在 ConnectorsConfig,bootstrap 会退出,不会触碰集群状态。
可通过查看 BootstrapStarted 和 BootstrapCompleted 事件确认 bootstrap 已运行:
删除级联
删除 ConnectorsConfig 会通过 owner reference(Controller=true、BlockOwnerDeletion=true)级联删除所有受管子 CR。父资源的 finalizer 会阻止 ConnectorsConfig 本身被移除,直到所有子 CR 完成各自的 finalizer,因此即使某个组件需要一段时间来清理,删除过程也是安全的。
安装标志
spec.installFlags 允许管理员关闭一小部分安装时行为。每个条目都使用稳定的 flag 名称作为键;其值的结构按 flag 分别说明。
可用标志:
示例——将集群范围内的 Pipeline Integration 限制为 schema-version 2 及以下:
对于 pipeline-integration,值是一个字符串。支持的基本形式:
也支持组合形式,例如 "<2 || >=4"、"!=2"、">=1, <=3",以及通配符 / 波浪号 / 脱字符范围("1.x"、"~1.2"、"^1.2")——该值会按完整的 semver constraint expression 解析。上面的基本形式覆盖了常见场景。
同一个标志也可以在 ConnectorsConfig 的每个组件上单独设置(例如 spec.components.harbor.spec.installFlags),以覆盖该组件的集群范围默认值。
步骤 1:安装 Connectors Operator
请从平台的 OperatorHub 安装 Alauda DevOps Connectors operator——不要手动创建 operator 的 Subscription。
- 以管理员身份登录平台。
- 导航到 Administrator → Marketplace → OperatorHub。
- 搜索
Alauda DevOps Connectors并打开该 operator 的详情页。 - 单击 Install,然后选择:
- Channel — 选择要跟踪的发布通道。
- Install namespace — operator 自身的命名空间(推荐默认值
connectors-operator;任何命名空间都可以)。 - Approval strategy — 根据你的升级策略选择 Automatic 或 Manual。
- 如果选择了 Manual,请批准 install plan。
- 等待 operator 的 subscription 在详情页中显示
Succeeded。
当 operator 显示为 Ready 后,请从命令行验证 controller pod 和预期的 CRD:
你应该能看到包括 connectorsconfigs.operator.connectors.alauda.io、connectorscores.operator.connectors.alauda.io 在内的 CRD,以及每个受支持组件对应的一个 CRD。
步骤 2:安装 Connectors 组件
组件通过单个 ConnectorsConfig 资源进行安装。关于每个集群仅一个实例的约束,请参见 集群单例。
默认安装(推荐)
当 operator 启动且不存在 ConnectorsConfig 时,它会自动创建一个默认资源,启用所有受支持的组件并使用默认值:
目标命名空间不总是 operator 的安装命名空间。在升级路径中,如果已经存在 ConnectorsCore,bootstrap 会复用该命名空间,以便新的受管子资源与现有的独立安装并列放置。完整的解析规则请参见 自动创建时的命名空间优先级。
验证安装是否已收敛(如果 bootstrap 选择了不同的命名空间,请替换这里的命名空间):
如果你想选择不同的安装命名空间,或者想在组件创建前自定义 spec,请在 operator 启动之前,按照下面的 手动安装 步骤预先创建 ConnectorsConfig。bootstrap 检测到已有的 ConnectorsConfig 后,会跳过默认创建。
手动安装
如果禁用了自动创建,请在应当承载组件的命名空间中自行创建 ConnectorsConfig。命名空间名称由你决定——下面以 connectors-system 作为示例。无论你将 ConnectorsConfig 创建在哪个命名空间,所有组件的子 CR 都会创建在那里。
验证安装
下面的命令使用 connectors-operator —— 默认安装命名空间。如果你是自己在其他命名空间中创建了 ConnectorsConfig(上面的手动安装路径),请将这里的命名空间替换为对应值。
检查汇总状态:
status.conditions[Ready]=True 表示所有已启用组件都已完成安装。关于每个组件的阶段以及各条件的含义,请参见 状态与阶段。
列出每个组件注册的 ConnectorClass 资源——这些是 Connectors 系统暴露的按工具集成类型(参见 ConnectorClass):
步骤 3:自定义安装(高级)
spec: {} 会使用默认值启用所有组件。大多数安装无需额外配置。只有在你需要关闭某些组件、调整 feature flag 或覆盖工作负载设置时,才使用本节。
ConnectorsConfig.spec 包含两类设置:
spec.components— 以短组件名为键的映射(core、git、github、gitlab、oci、harbor、k8s、maven、npm、pypi、sonarqube、nexus、jfrog)。每个值都是一个ComponentConfig,其中包含enabled(默认true;core.enabled: false会被拒绝)和spec(组件特定配置,schema 与对应的独立组件 CR 相同)。映射中未列出的组件会使用默认设置启用。- spec 根级别的集群默认值 —
registry、labels、annotations和installFlags直接位于spec下,并作为默认值应用到每个组件。合并优先级为组件值优先——如果同一个键同时在 spec 根级别和组件级别设置,则仅当组件未提供该键时,才回退到 spec 根级别的值。
下面的五个示例覆盖了最常见的自定义场景。关于每个组件的完整 schema,请参考
ConnectorsConfig CRD reference。
禁用组件
在 core 上设置 Feature Flags
featureFlags 用于切换 ConnectorsCore 上的可选行为。有关支持的所有 flag 及其作用,请参见 Feature Flags。
覆盖镜像仓库(集群范围)
除非某个组件通过其自身的 spec.components.<name>.spec.registry 在本地覆盖,否则该 registry 前缀会应用到每个组件的工作负载镜像。
调整工作负载副本数和资源
每个组件都嵌入了相同的 workloads schema。Deployment 名称因组件而异;可使用以下命令查找:
下面的模式对 core、git、gitlab、github、oci、harbor、k8s、maven、npm、pypi、sonarqube、nexus 和 jfrog 都适用:
对外暴露 OCI Proxy
ConnectorsOCI 支持三种暴露模式。请选择一种:
状态与阶段
ConnectorsConfig.status 会同时报告一个汇总的集群状态和每个组件的状态。
条件
每个组件的阶段
status.components 会将组件名称映射到某个阶段:
卸载
删除 ConnectorsConfig 会级联删除所有受管组件(将命名空间替换为你安装时使用的命名空间):
ConnectorsConfig 上的 finalizer 会阻止父资源被移除,直到所有子 CR 完成清理,因此即使某个组件需要一段时间进行清理,删除过程也是安全的。
如果还要删除 operator 本身,请先查找实际的 Subscription 名称——OperatorHub 会以 operator 包名来命名它,而这在不同平台上可能不同:
如果你将组件安装在了单独的命名空间中(手动安装),也请一并删除该命名空间。
故障排查
connectors-csi 未就绪
如果 daemonset/connectors-csi 未就绪,请检查 pod 事件:
组件命名空间的 Pod Security 级别对 CSI 驱动来说过于严格。请将其设置为 privileged,更新命名空间标签,并重启 connectors-csi DaemonSet。参见 安装所需的 Pod 安全要求。
某个组件卡在 Failed 状态
status.components.<name>.message 是首先要查看的位置。每当某个组件进入该状态时,controller 都会在父资源上发出一个 ComponentConflict Warning 事件。两个常见原因都来自升级后遗留的旧独立 CR:
- 集群范围冲突 — 另一个命名空间中存在同类 CR(或者同一命名空间中存在不同名称的同类 CR)。消息会列出所有冲突的
namespace/name。删除有问题的 CR 后,controller 会在下一次 reconcile 时恢复。 - 位于确定性名称下的未受管 CR — 预期名称和命名空间下已经存在一个 CR,但它没有携带
ManagedBy=connectorsconfig标签。controller 拒绝接管它(message: child CR ... already exists but is not managed by ConnectorsConfig — delete it manually to allow adoption)。删除未受管的 CR 后,controller 会在下一次 reconcile 时创建一个新的受管子资源。
如果你正处于从 ConnectorsConfig 之前版本升级的过程中,请参见 迁移到 ConnectorsConfig 获取背景说明。
相关文档
- 升级 Connectors Operator — 包含从
ConnectorsConfig之前安装方式到新安装方式的单向迁移。 - Feature Flags — 可通过
spec.components.core.spec.featureFlags配置的完整标志列表。 - 快速开始 — 安装后创建你的第一个
Connector。 - 架构概览 — 各组件如何协同工作。
ConnectorsConfigCRD reference。