fluxcd/source-controller

source-controller 镜像文档

概述

source-controller是Flux CNCF项目的核心组件，专门用于管理和同步Kubernetes集群配置的各种来源（如Git仓库、Helm仓库、OCI制品等）。它通过持续监控这些源的变更，确保集群配置始终与定义的源保持一致，是实现GitOps工作流的关键组件。

核心功能与特性

• 多源类型支持：兼容Git仓库（GitHub、GitLab、Bitbucket等）、Helm仓库、OCI制品仓库等多种配置源。
• 自动同步机制：可配置定时同步或基于事件触发同步，确保配置变更实时反映到集群。
• 版本控制与追踪：支持指定分支、标签、提交哈希等版本选择，记录配置源的版本历史。
• 与Flux生态集成：无缝对接Flux的其他组件（如kustomize-controller、helm-controller），提供端到端的GitOps流程支持。
• 健康检查与状态报告：监控源同步状态，提供详细的健康状态和错误信息，便于问题排查。

使用场景与适用范围

• GitOps工作流：在基于Git的配置管理中，作为配置源的统一入口，持续获取并同步应用配置到Kubernetes集群。
• 多环境配置管理：通过管理不同分支或目录的Git仓库，支持开发、测试、生产等多环境的配置隔离与同步。
• 大规模集群配置：适用于需要集中管理多个应用或团队配置的大型Kubernetes集群。
• 合规与审计：通过版本追踪和同步记录，满足配置变更的审计与合规要求。

核心功能与特性详情

多源类型支持

• Git仓库：支持GitHub、GitLab、Bitbucket等主流Git服务，支持HTTPS和SSH协议访问。
• Helm仓库：兼容Helm Chart仓库，可同步Chart元数据及制品。
• OCI制品：支持从OCI兼容仓库（如Docker Hub、GitHub Container Registry）拉取配置制品。
• 本地文件系统：支持本地目录作为配置源（主要用于开发测试场景）。

同步与版本管理

• 灵活的同步策略：支持定时同步（通过interval参数配置）、手动触发同步（通过flux reconcile source命令）及事件驱动同步（如Git仓库webhook触发）。
• 精确版本控制：可指定Git仓库的分支、标签、提交哈希，Helm Chart的版本范围，确保配置源版本可预期。

使用方法与配置说明

部署方式

source-controller通常作为Flux的一部分部署，推荐通过官方安装命令部署：

bash
# 安装Flux（包含source-controller及其他核心组件）
flux install

部署后，source-controller运行在flux-system命名空间，通过Kubernetes自定义资源（CRD）进行配置管理。

配置示例：管理Git仓库源

创建GitRepository自定义资源，定义Git配置源：

yaml
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
  name: app-config
  namespace: flux-system
spec:
  interval: 10m  # 每10分钟同步一次
  url: https://github.com/example/k8s-config.git  # Git仓库URL
  ref:
    branch: main  # 同步main分支
  secretRef:
    name: git-creds  # 访问私有仓库的凭证（可选，包含username/password或SSH密钥）
  timeout: 30s  # 同步超时时间

创建后，source-controller将自动同步仓库内容，并通过kubectl get gitrepository app-config -o yaml查看同步状态。

配置示例：管理Helm仓库源

创建HelmRepository自定义资源，定义Helm仓库源：

yaml
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: HelmRepository
metadata:
  name: stable-charts
  namespace: flux-system
spec:
  interval: 1h  # 每小时同步一次仓库索引
  url: https://charts.helm.sh/stable  # Helm仓库URL
  timeout: 60s

核心配置参数

source-controller的行为主要通过自定义资源的spec字段配置，关键参数说明：

注意事项

• 确保集群网络可访问配置源地址，私有源需正确配置secretRef凭证。
• 对于频繁变更的源，可缩短interval以提高同步实时性；对于稳定源，可延长interval减少资源消耗。
• 同步状态可通过资源的status字段查看，常见状态包括Ready（同步成功）、FetchFailed（拉取失败）等。