如何实现Git仓库与Argo实例间Workflow-Templates的自动同步？

针对Git仓库与Argo Workflow-Template手动同步易遗漏的问题，以下是三种可靠的自动同步方案，按需选择：

方案一：使用GitHub Actions（最直接适配GitHub仓库） #

利用GitHub的CI/CD能力，在Workflow-Template文件变更时自动触发同步操作：

1. 准备访问凭证

   • 生成拥有Argo WorkflowTemplate编辑权限的K8s服务账号，导出其kubeconfig内容，或者获取Argo API的认证Token。
   • 将凭证存入GitHub仓库的Secrets（仓库Settings → Secrets and variables → Actions），比如命名为KUBECONFIG（存kubeconfig内容）或ARGO_TOKEN+ARGO_SERVER。

2. 编写GitHub Action工作流
   在仓库的.github/workflows/目录下创建argo-sync.yaml文件，示例内容如下：

   name: Sync Argo Workflow-Templates
   on:
     push:
       paths:
         - 'workflow-templates/**/*.yaml'  # 仅监听模板目录的文件变更
       branches: [ main ]  # 指定需要同步的分支
   
   jobs:
     sync-to-argo:
       runs-on: ubuntu-latest
       steps:
         - name: Checkout code
           uses: actions/checkout@v4
   
         - name: Set up kubectl
           uses: azure/setup-kubectl@v3
           with:
             version: 'latest'
   
         - name: Configure K8s context
           run: |
             echo "${{ secrets.KUBECONFIG }}" > $HOME/.kube/config
             chmod 600 $HOME/.kube/config
   
         - name: Apply Workflow-Templates to cluster
           run: kubectl apply -f workflow-templates/ --recursive
   

   • 如果偏好使用Argo CLI替换kubectl，可添加安装Argo CLI的步骤，再执行argo login和argo template apply命令。

方案二：使用Argo CD（适合已有Argo生态的场景） #

将Workflow-Templates作为Argo CD的一个管理应用，实现自动同步：

• 在Argo CD控制台创建新应用，配置如下：
  • 源仓库：指向你的GitHub仓库，指定workflow-templates目录为同步路径。
  • 目标集群：选择Argo Workflows所在的K8s集群，命名空间为Argo的部署命名空间（如argo）。
  • 同步策略：开启自动同步（Automatic Sync），并勾选Prune Resources（删除仓库中已移除的模板）和Self Heal（自动修复集群中与仓库不一致的资源）。
• 配置完成后，GitHub仓库中模板的任何变更都会被Argo CD自动同步到集群。

方案三：使用Argo Events（适合复杂触发逻辑场景） #

如果需要自定义触发规则（如特定标签、PR合并后同步），可借助Argo Events实现：

1. 配置GitHub事件源，监听仓库的push事件，并设置路径过滤规则，仅当workflow-templates目录下的文件变更时触发。
2. 创建Sensor资源，绑定上述事件源，触发一个Argo Workflow：该Workflow的步骤包括拉取最新代码、执行kubectl apply同步模板到集群。

注意事项 #

• 最小权限原则：用于同步的服务账号仅需授予WorkflowTemplate的create/update/delete权限，避免过度授权。
• 变更验证：可在同步步骤前添加kubectl diff命令，预览变更内容，确保无误后再执行同步。
• 版本回滚：借助Git版本历史或K8s资源的历史版本，可快速回滚错误的模板变更。

内容的提问来源于stack exchange，提问作者Aman Tandon