configseeder/git-connector

ConfigSeeder® Git Connector

镜像概述和主要用途

ConfigSeeder® Git Connector是ConfigSeeder®的官方扩展组件，旨在从ConfigSeeder®检索配置数据并将其同步到一个或多个Git仓库中。该镜像支持以任务（Job）或定时任务（Cron Job）模式运行，使配置数据能够集中存储于Git仓库，便于后续通过各类DevOps工具（如CI/CD流水线、配置管理平台等）进行版本控制、审计和自动化处理。

核心功能和特性

• 配置数据检索与同步：从ConfigSeeder®安全获取配置数据，并自动同步至指定的一个或多个Git仓库。
• 灵活运行模式：支持一次性任务（即时同步配置）或定时任务（周期性更新配置）两种运行模式，适配不同场景需求。
• 多仓库支持：可同时向多个独立的Git仓库提供配置数据，满足多环境、多团队的配置分发需求。
• DevOps工具集成：同步至Git仓库的配置数据可无缝对接主流DevOps工具链，便于配置的后续处理和自动化部署。

使用场景和适用范围

• 集中式配置分发：适用于需要从ConfigSeeder®集中管理配置，并通过Git实现配置版本化和跨团队/环境分发的场景。
• 自动化配置更新：在CI/CD流程中，需定期或触发式同步配置数据至Git仓库，供应用部署流程调用。
• 多环境配置隔离：通过向不同Git仓库同步配置数据，实现开发、测试、生产等环境的配置隔离与统一管理。

使用方法和配置说明

前提条件

• 已部署ConfigSeeder®实例，且可通过网络访问。
• 目标Git仓库已配置访问权限（如SSH密钥、HTTPS访问令牌等）。

基本运行方式

作为一次性任务运行（即时同步）

通过Docker命令启动容器，执行单次配置同步：

bash
docker run --rm \
  -e CONFIGSEEDER_URL="https://your-configseeder-instance.example.com" \
  -e CONFIGSEEDER_API_KEY="your-api-key-with-read-permission" \
  -e GIT_REPOSITORIES="prod-repo=https://github.com/your-org/prod-configs.git,test-repo=https://github.com/your-org/test-configs.git" \
  docker.xuanyuan.run/configseeder/git-connector:latest

作为定时任务运行（周期性同步）

结合容器编排工具（如Kubernetes）配置定时任务，示例Kubernetes CronJob配置片段：

yaml
apiVersion: batch/v1
kind: CronJob
metadata:
  name: configseeder-git-sync
spec:
  schedule: "0 3 * * *"  # 每日3点执行
  jobTemplate:
    spec:
      template:
        spec:
          containers:
          - name: git-connector
            image: docker.xuanyuan.run/configseeder/git-connector:latest
            env:
            - name: CONFIGSEEDER_URL
              value: "https://your-configseeder-instance.example.com"
            - name: CONFIGSEEDER_API_KEY
              valueFrom:
                secretKeyRef:
                  name: configseeder-secrets
                  key: api-key
            - name: GIT_REPOSITORIES
              value: "prod-repo=https://github.com/your-org/prod-configs.git"
          restartPolicy: OnFailure

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

更多信息

有关详细配置参数、高级功能及最佳实践，请参考ConfigSeeder官方文档：
ConfigSeeder官方网站