weaveworks/flux

Flux 镜像文档

概述

Flux 是 Weaveworks 开发的开源 GitOps 工具，旨在通过 Git 仓库实现 Kubernetes 集群配置与应用的声明式管理。它将集群期望状态（如部署配置、资源清单、应用版本等）存储在 Git 仓库中，通过持续监控 Git 仓库变更，自动同步配置至 Kubernetes 集群，实现"Git 即事实来源"的运维模式，简化集群管理并提升部署可靠性。

核心功能与特性

• Git 同步机制：持续监控指定 Git 仓库分支或标签的变更，自动拉取最新配置并应用到集群。
• 声明式部署：支持通过 Kustomize、Helm、Kubernetes YAML 等方式定义应用部署，实现声明式配置管理。
• 自动部署触发：当 Git 仓库中配置更新或镜像仓库推送新镜像时，自动触发集群资源更新。
• 多环境管理：支持通过 Git 分支或目录结构区分开发、测试、生产等多环境，实现环境隔离与一致性。
• 依赖管理：支持定义资源间依赖关系，确保部署顺序正确（如先部署基础设施，再部署应用）。
• 自愈能力：当集群实际状态与 Git 仓库中声明的期望状态不一致时，自动修复偏差。
• 安全控制：支持 Git 仓库认证（SSH/HTTPS）、镜像仓库密钥管理，集成 Kubernetes RBAC 权限控制。

使用场景

• Kubernetes 集群配置管理：将集群基础资源（如 Namespace、ConfigMap、Secret）、网络策略、权限配置等存储在 Git 仓库，实现版本化和自动化管理。
• 应用持续交付：在 Git 仓库中定义应用部署配置（如 Deployment、Service），通过 Git 提交触发自动部署，替代传统 CI/CD 流水线中的手动部署步骤。
• 多集群管理：通过一个或多个 Git 仓库集中管理多个 Kubernetes 集群的配置，确保跨集群配置一致性。
• 合规与审计：借助 Git 仓库的版本历史，追溯集群配置变更记录，满足合规审计需求。
• 开发/测试环境自动化：开发团队通过提交代码或配置至 Git 仓库，自动更新测试环境，加速迭代流程。

使用方法

安装 Flux

Flux 通常通过其 CLI 工具或 Kubernetes 资源清单在集群中部署。以下是基本安装步骤：

1. 安装 Flux CLI

bash
# macOS (Homebrew)
brew install fluxcd/tap/flux

# Linux (手动下载)
curl -s https://fluxcd.io/install.sh | sudo bash

# 验证安装
flux --version

2. 初始化 Flux（单集群场景）

在目标 Kubernetes 集群中初始化 Flux，指定 Git 仓库作为配置源：

bash
flux bootstrap git \
  --url=ssh://git@github.com/<用户名>/<仓库名>.git \
  --branch=main \
  --private-key-file=<本地SSH私钥路径> \
  --path=clusters/my-cluster

• --url：Git 仓库地址（支持 SSH/HTTPS）
• --branch：目标分支
• --private-key-file：SSH 私钥路径（用于访问私有仓库，HTTPS 仓库可替换为 --token-auth 和 --username/--password）
• --path：仓库中存储集群配置的目录路径

核心配置示例

Flux 通过自定义资源（CRD）定义 Git 仓库、部署策略等，以下是常用资源示例：

1. 定义 Git 仓库（GitRepository）

创建 git-repo.yaml，声明要同步的 Git 仓库：

yaml
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
  name: my-app-config
  namespace: flux-system
spec:
  interval: 1m0s  # 同步间隔
  url: ssh://git@github.com/<用户名>/<仓库名>.git
  ref:
    branch: main
  secretRef:
    name: git-credentials  # 存储 Git 认证信息的 Secret 名称

2. 定义部署配置（Kustomization）

创建 kustomization.yaml，指定从 Git 仓库中同步的资源路径及部署策略：

yaml
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
  name: my-app
  namespace: flux-system
spec:
  interval: 5m0s
  path: ./kustomize/prod  # Git 仓库中相对于 GitRepository 根目录的配置路径
  prune: true  # 自动删除 Git 仓库中已移除的资源
  sourceRef:
    kind: GitRepository
    name: my-app-config  # 关联上述 GitRepository 资源
  healthChecks:
    - apiVersion: apps/v1
      kind: Deployment
      name: my-app
      namespace: prod  # 健康检查：等待 Deployment 就绪

验证部署

bash
# 检查 Flux 组件状态
flux get sources git  # 查看 GitRepository 同步状态
flux get kustomizations  # 查看 Kustomization 部署状态

# 查看资源事件
kubectl describe gitrepository/my-app-config -n flux-system
kubectl describe kustomization/my-app -n flux-system

配置参数

核心自定义资源（CRD）

Flux 主要通过以下自定义资源定义集群状态：

• GitRepository：声明 Git 仓库源及同步配置（URL、分支、认证、同步间隔等）。
• Kustomization：声明基于 Kustomize 的资源部署（配置路径、依赖、健康检查、prune 策略等）。
• HelmRepository：声明 Helm Chart 仓库源。
• HelmRelease：声明 Helm Chart 的部署（版本、 values 配置、升级策略等）。
• ImageRepository：声明容器镜像仓库，用于监控镜像标签变更。
• ImagePolicy：定义镜像标签选择策略（如语义化版本、最新标签等）。
• ImageUpdateAutomation：自动更新 Git 仓库中的镜像版本引用（如 Deployment 中的 image 字段）。

环境变量（Flux 控制器）

Flux 控制器（如 source-controller、kustomize-controller）支持通过环境变量调整行为，常见配置：

• LOG_LEVEL：日志级别（默认 info，可选 debug）。
• HTTP_PROXY/HTTPS_PROXY/NO_PROXY：代理配置。
• HEALTH_PROBE_ADDR：健康检查地址（默认 :9440）。
• METRICS_ADDR：指标暴露地址（默认 :8080）。

自定义资源配置示例（HelmRelease）

如需通过 Helm 部署应用，可定义 HelmRelease 资源：

yaml
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: my-helm-app
  namespace: prod
spec:
  interval: 1h
  chart:
    spec:
      chart: my-chart
      version: "1.2.3"
      sourceRef:
        kind: HelmRepository
        name: my-helm-repo  # 关联 HelmRepository 资源
        namespace: flux-system
  values:
    replicaCount: 3
    image:
      repository: my-registry/my-app
      tag: "1.0.0"
  upgrade:
    remediation:
      retries: 3  # 升级失败时重试次数

注意事项

• Flux 依赖 Kubernetes 集群版本 ≥ v1.21（推荐 v1.24+）。
• Git 仓库需确保 Flux 控制器有读写权限（用于同步配置及自动提交镜像更新）。
• 生产环境中建议启用 Flux 控制器的高可用部署（多副本）。
• 通过 flux suspend/flux resume 命令可临时暂停/恢复资源同步。