dyrnq/git-sync

git-sync 镜像文档

概述

git-sync 是一个轻量级工具，用于将Git仓库同步到容器文件系统中。它能够定期从指定的Git仓库拉取最新代码，并保持本地文件与远程仓库同步。该工具特别适用于Kubernetes环境，可用于配置文件管理、静态资源部署或作为持续集成/持续部署流程的一部分。

核心功能

• 支持从Git仓库（HTTP/HTTPS或SSH协议）拉取代码
• 可配置同步间隔，实现定期自动更新
• 支持指定分支、标签或提交哈希
• 提供多种认证方式，包括用户名/密码和SSH密钥
• 轻量级设计，资源占用低
• 支持自定义同步后的命令执行

使用场景

• Kubernetes环境中的配置文件动态更新
• 静态网站或前端资源的部署与更新
• 作为初始化容器(init container)为应用提供最新配置
• 定期同步代码到运行中的容器
• 开发环境中的代码热更新

使用方法

基本用法 (Docker Run)

bash
docker run -d k8s.gcr.io/git-sync \
  --repo=https://github.com/example/repo.git \
  --branch=main \
  --period=30 \
  --root=/git

Docker Compose 示例

yaml
version: '3'
services:
  git-sync:
    image: k8s.gcr.io/git-sync
    command:
      - --repo=https://github.com/example/repo.git
      - --branch=main
      - --period=60
      - --root=/git/data
    volumes:
      - ./data:/git/data

Kubernetes 部署示例

yaml
apiVersion: v1
kind: Pod
metadata:
  name: git-sync-example
spec:
  containers:
  - name: git-sync
    image: k8s.gcr.io/git-sync
    args:
    - --repo=https://github.com/example/repo.git
    - --branch=main
    - --period=30
    - --root=/git
    volumeMounts:
    - name: git-volume
      mountPath: /git
  volumes:
  - name: git-volume
    emptyDir: {}

配置参数

主要参数

认证参数

高级参数

环境变量配置

除了命令行参数外，git-sync还支持通过环境变量进行配置：

• GIT_SYNC_REPO: Git仓库URL
• GIT_SYNC_BRANCH: 分支名称
• GIT_SYNC_TAG: 标签
• GIT_SYNC_REV: 提交哈希
• GIT_SYNC_ROOT: 同步目录
• GIT_SYNC_PERIOD: 同步间隔(秒)
• GIT_SYNC_USERNAME: 用户名
• GIT_SYNC_PASSWORD: 密码
• GIT_SYNC_SSH: 是否使用SSH (true/false)

注意事项

1. 确保容器具有足够的权限访问Git仓库
2. 使用SSH认证时，需要正确配置密钥和权限
3. 对于大型仓库，考虑使用--depth参数限制克隆深度
4. 在生产环境中，建议设置适当的--max-sync-failures值以处理持续失败情况
5. 敏感信息（如密码或SSH密钥）应使用Kubernetes Secrets管理

故障排除

• 同步失败: 检查网络连接、仓库URL和认证凭据
• 权限问题: 确保容器对目标目录有写入权限
• SSH认证问题: 验证SSH密钥是否正确挂载且权限设置正确（通常为600）
• 频繁同步: 调整--period参数以减少同步频率，减轻仓库负担