sagan/argocd-render-manifests-action

ArgoCD Helmfile Renderer Docker镜像文档

镜像概述和主要用途

本镜像旨在GitHub Actions环境中提供Helmfile工具支持，用于为ArgoCD渲染Kubernetes清单文件。通过集成Helmfile及其依赖组件，实现自动化生成符合ArgoCD要求的应用配置清单，简化GitOps工作流中清单管理与部署流程。

核心功能和特性

• 集成Helmfile工具，支持多环境、多资源的清单渲染
• 内置Helm、kubectl等必要依赖，满足ArgoCD清单生成需求
• 适配GitHub Actions运行环境，支持容器化执行工作流步骤
• 支持自定义Helm仓库配置与Chart版本管理
• 提供灵活的参数配置，可适配不同项目的清单渲染需求

使用场景和适用范围

使用场景

• GitHub Actions工作流中自动化渲染ArgoCD应用清单
• GitOps流程中通过Helmfile管理ArgoCD应用配置并自动生成部署清单
• CI/CD pipeline中集成清单渲染步骤，用于部署前验证或直接同步至ArgoCD

适用范围

• 采用ArgoCD进行Kubernetes资源管理的团队
• 使用Helmfile组织多环境、多应用配置的项目
• 需要在GitHub Actions中实现清单自动化生成的GitOps工作流

使用方法和配置说明

基本使用流程

1. 在GitHub Actions工作流文件中引用本镜像
2. 配置必要的环境变量或输入参数（如Helmfile配置路径、Helm仓库等）
3. 执行清单渲染命令
4. 获取渲染后的清单文件用于后续部署或同步步骤

环境准备

• 运行环境：GitHub Actions runner（支持Linux容器环境）
• 前置条件：需提供Helmfile配置文件（通常为helmfile.yaml）及相关Chart依赖

部署示例

GitHub Actions工作流示例

yaml
name: Render ArgoCD Manifests
on: [push]

jobs:
  render-manifests:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Render manifests with Helmfile
        uses: docker://<image-name>:<tag>  # 替换为实际镜像名称和标签
        env:
          HELMFILE_PATH: ./argocd/helmfile.yaml  # Helmfile配置文件路径
          HELM_REPOS: |
            stable=https://charts.helm.sh/stable
            argo=https://argoproj.github.io/argo-helm
          ARGOCD_APP_NAME: my-app  # 可选：指定ArgoCD应用名称
        with:
          entrypoint: /bin/sh
          args: -c "helmfile template > argocd-manifests.yaml"  # 渲染命令

      - name: Upload rendered manifests
        uses: actions/upload-artifact@v3
        with:
          name: argo-manifests
          path: argocd-manifests.yaml

配置参数说明

参数使用说明

• HELM_REPOS: 如需添加多个Helm仓库，使用换行分隔，例如：stable=https://charts.helm.sh/stable\nargo=https://argoproj.github.io/argo-helm
• HELMFILE_PATH: 支持相对路径（相对于工作目录）或绝对路径
• 工具版本参数（HELM_VERSION等）如未指定，将使用镜像内置的默认版本

输出说明

渲染后的ArgoCD清单文件默认通过helmfile template命令生成，可通过重定向输出到指定文件（如示例中的argocd-manifests.yaml），该文件可用于后续的ArgoCD同步或部署验证步骤。