fluxcd/fluxctl

Flux CLI 镜像文档

镜像概述

Flux CLI是GitOps工具Flux的命令行界面，基于GitOps理念设计，用于Kubernetes应用的持续交付。它作为连接Git仓库与Kubernetes集群的桥梁，支持用户通过命令行管理Flux资源、配置同步策略、部署应用，并监控交付状态，实现Git仓库配置自动同步到Kubernetes集群，简化持续交付流程。

核心功能与特性

• 资源管理：创建、更新、删除Flux核心资源（如GitRepository、Kustomization、HelmRelease），定义Git源和部署规则。
• 部署控制：手动触发资源同步（flux reconcile）、暂停/恢复同步（flux suspend/resume），查看同步状态与历史（flux get、flux logs）。
• 配置验证：检查Flux资源配置文件语法（flux validate），验证Git仓库与集群配置兼容性。
• 版本管理：安装/升级Flux组件到Kubernetes集群（flux install、flux upgrade），支持指定版本和组件配置。
• 多集群支持：通过Kubernetes上下文管理多集群Flux部署，支持跨集群资源同步和状态查看。
• 安全集成：支持SSH/HTTPS认证Git仓库，集成Kubernetes RBAC控制访问权限。

使用场景

• GitOps持续交付：适用于采用GitOps理念的团队，通过Git仓库管理应用配置，自动同步到Kubernetes集群。
• 多环境部署：支持开发、测试、生产等多环境配置隔离，通过Git分支或目录管理环境差异，确保环境一致性。
• 集群配置管理：用于管理Kubernetes集群基础设施配置（如命名空间、网络策略、RBAC规则），确保配置与Git仓库一致。
• CI/CD流水线集成：可嵌入CI流水线（如GitHub Actions、GitLab CI），在代码合并后自动触发Flux同步，完成应用部署。

使用方法与配置说明

基本使用流程

1. 安装Flux到集群：通过Flux CLI部署Flux组件（如source-controller、kustomize-controller）到Kubernetes集群。
2. 配置Git源：定义GitRepository资源，指定应用配置的Git仓库地址、分支、认证方式。
3. 定义部署规则：创建Kustomization资源，指定Git仓库中的配置路径、同步策略（如间隔时间、依赖关系）。
4. 监控与维护：查看同步状态、触发手动同步、处理部署异常。

Docker部署示例

通过Docker容器运行Flux CLI，需挂载Kubernetes配置文件（kubeconfig）和工作目录（存放Flux资源配置）。

示例1：检查集群兼容性

bash
docker run --rm \
  -v ~/.kube/config:/root/.kube/config \  # 挂载kubeconfig以访问集群
  -v $(pwd):/workdir \                    # 挂载当前目录作为工作目录
  -w /workdir \                           # 设置工作目录
  fluxcd/flux-cli:latest \                # Flux CLI镜像
  check --pre                             # 检查集群是否满足Flux安装条件

示例2：安装Flux到集群

bash
docker run --rm \
  -v ~/.kube/config:/root/.kube/config \
  fluxcd/flux-cli:latest \
  install \
  --version=v2.2.3 \                      # 指定Flux版本
  --namespace=flux-system \               # 指定Flux组件命名空间
  --network-policy                        # 启用网络策略隔离

示例3：创建Git源并部署应用

bash
# 创建GitRepository资源（指向应用配置仓库）
docker run --rm \
  -v ~/.kube/config:/root/.kube/config \
  fluxcd/flux-cli:latest \
  create source git my-app \
  --url=https://github.com/example/my-app-config \  # Git仓库URL
  --branch=main \                                   # 分支
  --interval=5m \                                   # 同步间隔
  --secret-ref=git-creds                            # 引用Git认证Secret

# 创建Kustomization资源（部署应用配置）
docker run --rm \
  -v ~/.kube/config:/root/.kube/config \
  fluxcd/flux-cli:latest \
  create kustomization my-app \
  --source=my-app \                                # 关联GitRepository资源
  --path="./overlays/production" \                 # Git仓库中配置路径
  --prune=true \                                   # 启用资源清理
  --interval=10m \                                 # 同步间隔
  --health-check-timeout=3m                        # 健康检查超时时间

常用命令示例

• 查看Flux版本：docker run --rm fluxcd/flux-cli:latest version
• 列出Kustomization资源：docker run --rm -v ~/.kube/config:/root/.kube/config fluxcd/flux-cli:latest get kustomizations
• 手动触发同步：docker run --rm -v ~/.kube/config:/root/.kube/config fluxcd/flux-cli:latest reconcile kustomization my-app
• 查看同步日志：docker run --rm -v ~/.kube/config:/root/.kube/config fluxcd/flux-cli:latest logs kustomization/my-app

环境变量与配置参数

环境变量

• KUBECONFIG：指定kubeconfig文件路径，容器内默认/root/.kube/config。
• FLUX_LOG_LEVEL：日志级别，可选debug、info、warn、error，默认info。
• FLUX_NAMESPACE：默认命名空间，未指定--namespace时使用，默认flux-system。

常用命令参数

• --context：指定Kubernetes上下文（集群），用于多集群管理。
• --namespace：指定资源所在命名空间。
• --dry-run：模拟操作，不实际修改资源，用于验证配置。

注意事项

• 确保Kubernetes集群版本符合Flux要求（通常支持当前版本及前两个次要版本）。
• Git仓库认证需提前配置（如SSH密钥、用户名密码），并通过Secret挂载到集群或传递给Flux CLI。
• 同步间隔和依赖关系需根据应用需求合理配置，避免频繁同步或依赖死锁。