chatwork/argocd-helmfile

ArgoCD with helmfile 镜像文档

镜像概述和主要用途

ArgoCD with helmfile 是一个集成了 helmfile 工具的镜像，专为 ArgoCD（声明式 GitOps 持续交付工具）的配置管理插件设计。其核心用途是使 ArgoCD 能够通过 helmfile 管理 Helm 图表、依赖关系及部署配置，简化 GitOps 工作流中多环境、多集群的配置管理流程。

核心功能和特性

• helmfile 集成：内置 helmfile 工具，支持直接执行 helmfile 命令（如 template）生成 Kubernetes 资源清单。
• 配置管理插件支持：可作为 ArgoCD 配置管理插件，无缝集成到 ArgoCD 的资源生成流程中。
• 灵活配置选项：支持 helmfile 命令行参数（如 --include-crds、--skip-tests），适配不同场景的资源生成需求。
• Sidecar 模式兼容：支持以 Sidecar 容器形式与 ArgoCD Repo Server 协同工作，适配 ArgoCD 2.6+ 版本的插件配置规范。
• 轻量级选项：提供配套的 https://github.com/chatwork/dockerfiles/tree/master/argocd-helmfile-plugin%EF%BC%8C%E5%87%8F%E5%B0%91%E8%B5%84%E6%BA%90%E5%8D%A0%E7%94%A8%E3%80%82

使用场景和适用范围

适用场景

• GitOps 工作流中需通过 helmfile 管理多环境、多集群 Helm 部署配置。
• ArgoCD 需集成 helmfile 处理 Helm 图表依赖、版本控制及条件部署逻辑。
• 需在 ArgoCD 中自动化生成包含 CRD 的 Kubernetes 资源清单。

适用范围

• ArgoCD 2.6 版本之前：通过 argocd-cm 配置管理插件使用。
• ArgoCD 2.6 及以上版本：推荐通过 Sidecar 模式集成（原 argocd-cm 插件配置方式已弃用）。

使用方法和配置说明

1. ArgoCD 2.6 之前版本（基于 argocd-cm 配置）

步骤

1. 替换 ArgoCD Repo Server 镜像：将 ArgoCD Repo Server 的运行镜像替换为当前 ArgoCD with helmfile 镜像。
2. 配置 argocd-cm：在 ArgoCD 的 ConfigMap argocd-cm 中添加 helmfile 插件配置。

配置示例

yaml
# argocd-cm ConfigMap 配置
apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-cm
  namespace: argocd
data:
  configManagementPlugins: |
    - name: helmfile  # 插件名称，需唯一
      generate:       # 资源生成阶段配置
        command: ["/bin/sh", "-c"]
        args: ["helmfile -q template --include-crds --skip-tests"]  # helmfile 命令，可按需调整参数

参数说明：

• helmfile -q template：静默模式生成 Kubernetes 资源清单。
• --include-crds：生成清单时包含 CRD（自定义资源定义）。
• --skip-tests：跳过测试图表（test charts）的生成。

2. ArgoCD 2.6 及以上版本（Sidecar 模式）

说明

ArgoCD 2.6 版本起，argocd-cm 中的插件配置方式已弃用，推荐通过 Sidecar 容器与 Repo Server 协同运行。

配置示例（Kubernetes Deployment）

在 ArgoCD Repo Server 的 Deployment 中添加 Sidecar 容器：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: argocd-repo-server
  namespace: argocd
spec:
  template:
    spec:
      containers:
        # 原 ArgoCD Repo Server 容器
        - name: argocd-repo-server
          image: quay.io/argoproj/argocd:v2.6.0  # ArgoCD 基础镜像
          # ... 其他原有配置 ...

        # 添加 helmfile Sidecar 容器
        - name: argocd-helmfile-sidecar
          image: <argocd-helmfile-image>  # 当前 ArgoCD with helmfile 镜像
          volumeMounts:
            - name: repo-server-config
              mountPath: /etc/argocd/  # 共享 Repo Server 配置
            - name: helmfile-data
              mountPath: /helmfile  # 挂载 helmfile 配置文件目录（按需调整）
      volumes:
        - name: repo-server-config
          configMap:
            name: argocd-repo-server-config
        - name: helmfile-data
          persistentVolumeClaim:
            claimName: helmfile-pvc  # 存储 helmfile 配置的 PVC（按需创建）

Sidecar 核心作用：提供 helmfile 运行环境，通过共享卷与 Repo Server 交互，执行资源生成命令。

3. 轻量级 Sidecar 镜像

如需进一步减少资源占用，可使用官方提供的 https://github.com/chatwork/dockerfiles/tree/master/argocd-helmfile-plugin%EF%BC%8C%E9%85%8D%E7%BD%AE%E6%96%B9%E5%BC%8F%E4%B8%8E%E4%B8%8A%E8%BF%B0 Sidecar 模式一致，仅需替换镜像地址。

注意事项

• 版本兼容性：确保镜像版本与 ArgoCD 版本匹配，避免因 API 变更导致不兼容。
• helmfile 配置文件：需将 helmfile.yaml 及相关依赖文件（如 values.yaml）存储在 ArgoCD 可访问的 Git 仓库或卷中。
• 命令参数调整：根据实际需求修改 helmfile 命令参数（如添加 --environment 指定环境，--values 覆盖配置等）。