couchbase/sg-docker-bootstrap

Sync Gateway 构建工具容器镜像

镜像概述

该Docker镜像提供了构建Sync Gateway所需的完整工具链，旨在解决因开发环境差异导致的构建问题，为Sync Gateway的编译构建提供标准化、一致性的运行环境。

核心功能与特性

• 内置完整工具集：包含构建Sync Gateway所需的全部依赖工具，无需额外安装
• 环境一致性：确保不同开发/构建场景中使用相同版本的工具链，消除环境差异导致的构建问题
• 简化构建流程：通过容器化方式减少环境配置步骤，快速启动构建环境
• 跨平台兼容：支持在任何安装Docker的操作系统上运行，包括Linux、macOS和Windows

使用场景

• 本地开发环境：开发者无需在本地配置复杂依赖，直接使用容器进行Sync Gateway开发与构建
• CI/CD流水线：作为持续集成流程中的标准化构建环境，确保每次构建的一致性
• 多版本构建：可快速切换环境，测试不同版本Sync Gateway的构建兼容性
• 团队协作：为团队提供统一的构建标准，简化新人上手流程

使用方法与配置说明

基本使用命令

启动容器并挂载本地Sync Gateway源代码目录：

bash
docker run -it --rm -v /本地/sync-gateway源代码路径:/workspace sync-gateway-build-tools

参数说明：

• -v /本地路径:/workspace：将本地Sync Gateway源代码目录挂载到容器内的/workspace工作目录
• -it：交互式终端模式，允许在容器内执行命令
• --rm：容器退出后自动清理，避免残留临时文件

执行构建操作

进入容器后，在工作目录中执行构建命令：

bash
# 进入工作目录
cd /workspace

# 执行构建（具体命令根据Sync Gateway版本可能有所不同）
go build -o sync-gateway ./cmd/sync-gateway

自定义构建环境（可选）

如需指定特定版本的构建工具，可通过环境变量配置（具体支持的变量请参考镜像完整文档）：

bash
docker run -it --rm \
  -e GO_VERSION=1.21 \
  -e DEP_VERSION=0.5.4 \
  -v /本地源代码路径:/workspace \
  sync-gateway-build-tools

注意事项

• 确保本地Docker引擎版本不低于19.03
• 挂载目录需具有正确的文件权限，避免构建过程中出现权限错误
• 不同版本的Sync Gateway可能需要对应版本的构建工具镜像，请确认版本兼容性
• 构建产物默认生成在容器内的/workspace目录，可通过挂载目录同步到本地

常见问题

• 构建失败：检查挂载路径是否正确、源代码是否完整、工具版本是否兼容
• 性能问题：对于大型项目，建议为Docker分配足够的CPU和内存资源
• 网络问题：如需访问外部依赖库，确保容器网络连接正常

维护与更新

该镜像会定期更新以支持Sync Gateway的最新版本及安全补丁，建议定期拉取最新镜像：

bash
docker pull sync-gateway-build-tools:latest