apache/graphar-dev

Apache GraphAr (Incubating) 开发容器镜像

镜像概述和主要用途

Apache GraphAr（孵化中）开发容器镜像是专为GraphAr项目设计的预配置开发环境，集成了项目开发、测试及构建所需的依赖工具与环境配置。旨在简化开发者的环境搭建流程，确保跨团队开发环境的一致性，提升GraphAr项目的开发效率。

核心功能和特性

• 预配置开发环境：内置C++编译器（GCC/Clang）、CMake、Python、Git等基础开发工具，无需手动安装依赖。
• GraphAr依赖集成：预装GraphAr核心依赖库（如Apache Arrow、Boost等），满足项目编译与运行需求。
• 环境一致性：统一开发环境配置，避免因本地环境差异导致的"在我机器上能运行"问题。
• 多场景适配：支持本地开发、测试环境搭建及CI/CD流程集成，兼容主流Docker运行环境。
• 灵活可扩展：支持通过环境变量自定义配置，可按需扩展工具链或依赖版本。

使用场景和适用范围

• GraphAr项目开发者：用于本地开发环境快速搭建，专注代码编写而非环境配置。
• 社区贡献者：降低新手入门门槛，无需手动配置复杂依赖即可参与项目贡献。
• CI/CD自动化流程：作为自动化构建、测试的基础环境，确保流程一致性。
• 团队协作：统一团队开发环境，简化跨成员代码共享与测试流程。

详细使用方法和配置说明

基础使用（Docker Run）

通过以下命令启动容器，挂载本地GraphAr项目目录进行开发：

bash
docker run -it --rm -v /path/to/local/graphar:/workspace apache/graphar-dev:latest

• 参数说明：
  • -it：交互式终端模式，支持命令行操作
  • --rm：容器退出后自动清理，避免资源残留
  • -v /path/to/local/graphar:/workspace：将本地GraphAr项目目录挂载至容器内/workspace目录，实现代码实时同步

进入容器后即可执行项目构建操作：

bash
cd /workspace  # 进入挂载的项目目录
mkdir build && cd build  # 创建构建目录
cmake ..  # 生成Makefile
make -j4  # 并行构建项目

Docker Compose配置示例

创建docker-compose.yml文件简化容器管理：

yaml
version: '3.8'
services:
  graphar-dev:
    image: apache/graphar-dev:latest
    volumes:
      - ./local-graphar:/workspace  # 挂载本地项目目录
      - dev-cache:/home/graphar-dev/.cache  # 持久化缓存目录
    environment:
      - USER=graphar-dev  # 容器内用户名
      - DEBUG_MODE=1  # 启用调试模式（可选）
    tty: true  # 保持终端连接

volumes:
  dev-cache:  # 定义缓存卷，加速依赖下载

启动容器：

bash
docker-compose up -d  # 后台启动容器
docker-compose exec graphar-dev bash  # 进入容器终端

环境变量配置

通过环境变量自定义容器行为：

• USER：指定容器内操作用户名，默认值为graphar-dev
• GRAPHAR_VERSION：指定GraphAr版本分支，用于同步依赖配置，默认使用main分支
• DEBUG_MODE：是否启用调试工具链（如GDB、Valgrind），取值1（启用）或0（禁用），默认0
• CMAKE_BUILD_TYPE：设置CMake构建类型，可选Release/Debug/RelWithDebInfo，默认Debug

数据卷挂载建议

• 项目代码目录：/workspace，必须挂载本地项目目录以进行代码开发
• 缓存目录：/home/${USER}/.cache，建议持久化以加速依赖包（如Python pip、CMake缓存）下载
• 配置目录：/home/${USER}/.config，可挂载本地配置（如Git配置、IDE配置）实现个性化开发环境

注意事项

• 该镜像为开发环境专用，不适合生产环境部署
• 定期更新镜像以获取最新依赖和安全补丁：docker pull apache/graphar-dev:latest
• 如需添加自定义依赖，可在容器内通过apt-get或源码编译安装，或向GraphAr社区提交镜像优化建议

镜像维护与更新

• 镜像版本策略：latest标签对应最新开发分支，稳定版本使用vX.Y.Z标签（如v0.1.0）
• 更新频率：随GraphAr项目依赖变更定期更新，通常每月至少更新一次
• 问题反馈：通过GraphAr GitHub仓库（https://github.com/apache/incubator-graphar%EF%BC%89%E6%8F%90%E4%BA%A4issue%E5%8F%8D%E9%A6%88%E9%95%9C%E5%83%8F%E7%9B%B8%E5%85%B3%E9%97%AE%E9%A2%98