replicated/gitops-builder

GitOps工件管理CI脚本镜像

镜像概述和主要用途

本镜像提供了一套专为CI（持续集成）流水线设计的便捷脚本工具，用于高效管理GitOps工件。通过集成自动化脚本，简化GitOps工件（如Kubernetes清单文件、配置文件等）的版本控制、内容更新、Git提交/推送等全流程管理，帮助开发团队在CI环境中更高效地实施GitOps工作流，提升部署自动化水平和开发效率。

核心功能和特性

• 一站式脚本工具集：内置覆盖GitOps工件管理全流程的实用脚本，支持版本检查、内容更新、Git操作等核心功能
• CI平台兼容性：无缝适配主流CI/CD平台（GitLab CI、GitHub Actions、Jenkins、CircleCI等），支持CI环境变量直接调用
• GitOps流程优化：遵循GitOps最佳实践，支持基于Git仓库的工件版本追踪和审计
• 自动化配置支持：通过参数化配置实现全自动化的工件更新与推送，减少人工干预
• 轻量级设计：镜像体积精简，启动快速，适合CI流水线中临时任务执行场景

使用场景和适用范围

适用团队

• 采用GitOps工作流的开发团队
• 需要在CI/CD流程中自动化管理配置文件的DevOps团队
• 追求部署流程标准化的SRE团队

典型应用场景

• CI流水线中自动更新Kubernetes manifests的镜像版本
• 基于代码提交自动生成配置文件并推送至GitOps仓库
• 多环境（开发/测试/生产）的GitOps工件版本同步与管理
• 自动化检测并修复GitOps工件中的配置偏差

使用方法和配置说明

基本使用流程

1. 拉取镜像

从Docker仓库拉取最新版本：

bash
docker pull [镜像仓库地址]/gitops-artifact-manager:latest

（注：请将[镜像仓库地址]替换为实际仓库地址，如Docker Hub或私有仓库）

2. 基本命令格式

bash
docker run --rm \
  -e GIT_REPO_URL=<Git仓库URL> \
  -e GIT_USERNAME=<Git用户名> \
  -e GIT_TOKEN=<Git访问令牌> \
  [镜像仓库地址]/gitops-artifact-manager \
  <脚本名称> [脚本参数]

核心配置参数（环境变量）

CI流水线集成示例（GitLab CI）

在.gitlab-ci.yml中配置自动更新Kubernetes镜像版本：

yaml
update-gitops-manifest:
  stage: deploy
  image: [镜像仓库地址]/gitops-artifact-manager:latest
  variables:
    GIT_REPO_URL: "https://git.example.com/gitops-repo.git"
    GIT_USERNAME: "ci-bot"
    GIT_TOKEN: "$GITOPS_REPO_TOKEN"  # 从GitLab CI/CD安全变量获取
    GIT_BRANCH: "main"
  script:
    - /scripts/update-manifest.sh 
      --file k8s/deployment.yaml 
      --image my-app:$CI_COMMIT_SHA 
      --container app-container

常用脚本说明

注意事项

• Git访问令牌需具备目标仓库的写入权限，建议使用最小权限原则配置
• 敏感信息（如GIT_TOKEN）必须通过CI平台的安全变量功能注入，禁止明文存储
• 执行脚本前建议在CI环境中配置Git用户信息（user.name和user.email），确保提交记录可追溯
• 大规模工件操作建议添加--dry-run参数进行预检查，避免意外修改