cloudbees/casc-scm-bundle-retriever

CBCI Casc bundle retriever Docker镜像文档

镜像概述和主要用途

CBCI Casc bundle retriever是一款轻量级Docker镜像，专为检索、管理CBCI（特定项目/组织）相关的Cascading bundle文件设计。其核心目标是简化CBCI生态系统中Cascading bundle资源的获取流程，支持通过配置化方式自动检索、下载和存储指定的bundle文件，降低手动管理bundle的复杂度，提升开发、部署环境中资源集成的效率。

主要用途包括：

• 在CBCI项目开发环境中自动获取依赖的Cascading bundle
• 集成至CI/CD流水线，实现构建/部署阶段的bundle资源动态加载
• 生产环境中按需检索特定版本的Cascading bundle配置或资源文件

核心功能和特性

核心功能

• 配置化检索：通过环境变量或配置文件指定bundle名称、版本、类型等参数，灵活控制检索目标
• 版本管理：支持指定bundle版本号，适配多版本并存场景
• 自动存储：将检索到的bundle文件自动保存至容器内指定路径，支持通过卷挂载同步至宿主机
• 轻量级设计：基于Alpine或精简基础镜像构建，镜像体积小，资源占用低

关键特性

• 无状态运行：容器生命周期内仅执行检索任务，完成后自动退出（默认行为）
• 参数校验：内置基础参数校验机制，避免无效检索请求
• 日志输出：提供详细检索过程日志，便于问题排查
• 跨平台兼容：支持Linux/amd64架构，适配主流容器运行时环境

使用场景和适用范围

典型使用场景

1. 开发环境初始化：开发人员本地启动容器，快速获取项目依赖的Cascading bundle，无需手动下载配置
2. CI/CD流水线集成：在构建阶段通过容器检索指定版本的bundle，确保构建环境依赖一致性
3. 生产环境动态配置：部署前通过容器检索最新/指定版本的bundle配置文件，注入应用运行环境
4. 多版本测试：通过切换版本参数，快速检索不同版本bundle进行兼容性测试

适用范围

• 目标用户：CBCI项目开发/运维人员、依赖Cascading bundle的应用维护团队
• 环境要求：支持Docker 19.03+的Linux服务器、CI/CD平台（如Jenkins、GitLab CI）或本地开发环境
• 前置条件：需具备访问CBCI bundle资源库的网络权限（如内部私有仓库、特定API接口访问权限）

使用方法和配置说明

基础使用流程

1. 配置检索参数（通过环境变量或外部配置文件）
2. 运行容器，执行bundle检索任务
3. 通过卷挂载获取检索结果（若需持久化）

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

详细使用示例

1. 基础检索（默认参数）

通过环境变量指定bundle名称，检索最新版本并保存至默认路径：

bash
docker run -e BUNDLE_NAME=core-config cbci/casc-bundle-retriever

检索完成后，bundle文件将保存至容器内/app/bundles/core-config-latest.zip。

2. 指定版本与存储路径

检索指定版本的bundle，并通过卷挂载同步至宿主机本地目录：

bash
docker run -e BUNDLE_NAME=plugin-sdk \
  -e BUNDLE_VERSION=1.3.2 \
  -e TARGET_PATH=/data/output \
  -v /local/bundles:/data/output \
  cbci/casc-bundle-retriever

执行后，宿主机/local/bundles目录下将生成plugin-sdk-1.3.2.zip文件。

3. 自定义资源库地址

从非默认资源库检索bundle：

bash
docker run -e BUNDLE_NAME=test-bundle \
  -e REPO_URL=https://internal-repo.example.com/cbci-bundles \
  cbci/casc-bundle-retriever

注意事项

• 容器默认以非root用户（bundle-user，UID 1000）运行，挂载宿主机目录时需确保权限匹配
• 若检索失败（如网络错误、bundle不存在），容器将以非0状态码退出，可通过docker logs <容器ID>查看详细日志
• 对于大型bundle（>100MB），建议通过--memory参数限制容器内存使用，避免资源溢出