wrenchproject/wrench-build

WRENCH Docker镜像文档

镜像概述和主要用途

WRENCH Docker镜像包含两类容器镜像，旨在支持WRENCH（一个高性能计算工作流管理系统）的构建、测试与部署。镜像托管于Docker Hub，提供预配置环境以简化WRENCH的开发与使用流程。

• WRENCH Releases镜像
  用途：提供预编译的WRENCH运行环境，用于快速部署和运行WRENCH应用。
  Docker Hub地址：https://hub.docker.com/r/wrenchproject/wrench/

• WRENCH Builds镜像
  用途：提供多平台构建与测试环境，用于WRENCH源码的编译、测试及版本验证。
  Docker Hub地址：https://hub.docker.com/r/wrenchproject/wrench-build/

核心功能和特性

通用特性

• 多平台支持：适配多种操作系统及架构，满足不同开发与部署需求。
• 环境一致性：预配置所有依赖组件（如编译器、库文件、测试工具），避免环境差异导致的问题。
• 版本化管理：镜像版本与WRENCH源码版本对应，确保构建与运行环境的可追溯性。

WRENCH Releases镜像特性

• 包含预编译的WRENCH可执行文件及运行时依赖。
• 最小化镜像体积，优化部署效率。

WRENCH Builds镜像特性

• 集成完整构建链（编译器、CMake、测试框架等）。
• 支持自定义构建参数，适配不同测试场景（如单元测试、集成测试）。

使用场景和适用范围

适用用户

• WRENCH开发人员：本地编译、测试源码或验证新功能。
• 系统管理员：快速部署WRENCH运行环境用于生产或演示。
• CI/CD工程师：集成到自动化流程中实现持续构建与测试。

典型场景

1. 本地开发与测试：使用Builds镜像在隔离环境中编译源码，避免污染本地系统。
2. 自动化构建流程：在CI/CD管道（如GitHub Actions、GitLab CI）中使用Builds镜像执行自动化测试。
3. 快速部署验证：通过Releases镜像一键启动WRENCH环境，验证功能或进行性能测试。

详细使用方法和配置说明

前置条件

• 已安装Docker Engine（20.10+版本推荐）。
• 网络环境可访问Docker Hub拉取镜像。

WRENCH Releases镜像 (wrenchproject/wrench)

基本用法

用于运行WRENCH应用，默认启动交互式终端以执行WRENCH命令。

bash
# 拉取最新版本镜像
docker pull wrenchproject/wrench:latest

# 启动容器（交互式终端）
docker run -it --rm wrenchproject/wrench:latest /bin/bash

# 在容器内执行WRENCH命令示例
wrench --version  # 查看WRENCH版本

高级配置

• 挂载本地数据卷：如需访问本地文件，可通过-v参数挂载目录：

  bash
  docker run -it --rm -v /本地路径:/容器内路径 wrenchproject/wrench:latest
  

• 环境变量：目前无特殊环境变量，如需自定义配置可通过挂载配置文件实现。

WRENCH Builds镜像 (wrenchproject/wrench-build)

基本用法

用于构建WRENCH源码，需挂载本地源码目录至容器内进行编译。

bash
# 拉取最新版本镜像
docker pull wrenchproject/wrench-build:latest

# 挂载本地WRENCH源码目录并启动构建环境
docker run -it --rm -v /本地/wrench源码路径:/wrench-src wrenchproject/wrench-build:latest /bin/bash

# 在容器内执行构建流程示例
cd /wrench-src
mkdir build && cd build
cmake ..
make -j4
make test  # 运行测试套件

常用构建参数

• 指定CMake选项：可通过cmake命令添加自定义参数（如-DCMAKE_BUILD_TYPE=Debug启用调试模式）。
• 多版本测试：通过拉取特定标签镜像测试不同版本的构建环境（如wrenchproject/wrench-build:v2.0）。

镜像标签说明

两类镜像均采用标签化管理，推荐通过标签指定版本以确保环境一致性：

• latest：指向最新稳定版本。
• vX.Y.Z：对应WRENCH源码的版本号（如v3.1.0），用于版本化构建/部署。
• dev：开发分支镜像，包含最新未发布特性（不稳定，仅供开发测试）。