concourse/bosh-io-release-resource

Bosh.io Release Resource 镜像文档

1. 镜像概述和主要用途

Bosh.io Release Resource 是一个用于跟踪 bosh.io 平台上发行版（release）版本变化的 Concourse CI 资源类型。其核心用途是在 CI/CD 流水线中自动检测指定 BOSH 发行版的新版本发布，并触发后续构建、测试或部署流程，实现对 BOSH 发行版版本变更的自动化响应。

2. 核心功能和特性

• 版本跟踪：实时监控指定 BOSH 发行版在 bosh.io 上的版本更新，支持按发行版名称或 URL 定位目标。
• 元数据获取：获取版本相关元数据，包括版本号、发布日期、下载 URL、SHA 校验和等关键信息。
• Concourse 集成：完全兼容 Concourse 资源模型，支持 check（检测版本更新）、in（获取版本信息）、out（无实际操作）标准操作。
• 灵活配置：支持过滤预发布版本，可按需选择是否包含测试版或候选版本。
• 轻量高效：基于容器化构建，资源占用低，适用于各类 CI/CD 环境。

3. 使用场景和适用范围

适用场景

• 自动版本检测：在 CI/CD 流水线中自动发现 BOSH 发行版（如 stemcell、服务组件 release）的新版本，触发测试或部署流程。
• 环境一致性管理：确保多环境（开发、测试、生产）使用的 BOSH 发行版版本同步，避免版本差异导致的兼容性问题。
• 版本变更记录：集成到版本管理流程，自动记录 BOSH 发行版的版本变更历史，辅助审计和追溯。

适用范围

• 使用 BOSH 作为部署管理工具的开发团队。
• 基于 Concourse 构建 CI/CD 流水线的环境。
• 需要对 BOSH 发行版进行自动化版本管理的场景。

4. 详细使用方法和配置说明

4.1 资源类型定义

需在 Concourse Pipeline 中声明资源类型，指定镜像地址：

yaml
resource_types:
- name: bosh-io-release-resource
  type: registry-image
  source:
    repository: concourse/bosh-io-release-resource
    tag: latest  # 建议指定具体版本，如 `v1.2.0`

4.2 资源配置（Source）

在 Concourse Pipeline 中定义资源时，通过 source 配置目标 BOSH 发行版及过滤规则：

yaml
resources:
- name: my-bosh-release
  type: bosh-io-release-resource
  source:
    # 以下参数二选一：通过名称或 URL 指定发行版
    release: bosh-vsphere-cpi  # 发行版名称（对应 bosh.io 上的名称）
    # url: https://bosh.io/d/github.com/cloudfoundry/bosh  # 发行版在 bosh.io 的 URL
    include_prereleases: false  # 可选，是否包含预发布版本，默认 false

4.3 操作说明

4.3.1 Check（检测版本更新）

自动定期（默认 1 分钟）查询 bosh.io，检测目标发行版的最新版本。若发现新版本（版本号递增或发布日期更新），则标记为新版本。

触发条件：Concourse 定时调度或手动触发。

4.3.2 In（获取版本信息）

将检测到的版本元数据输出到工作目录，支持下载发行版文件（默认启用）。

配置示例：

yaml
jobs:
- name: process-release
  plan:
  - get: my-bosh-release
    params:
      skip_download: false  # 可选，是否跳过发行版文件下载，默认 false

输出文件（位于 my-bosh-release/ 目录下）：

• version：版本号（如 1.2.3）
• url：发行版下载 URL
• sha1：文件 SHA1 校验和
• release_notes_url：发行说明页面 URL

4.3.3 Out（无实际操作）

当前版本无实际功能，调用时不执行任何操作。

4.4 Concourse Pipeline 配置示例

完整流水线配置示例（自动检测并获取 BOSH 发行版新版本）：

yaml
resource_types:
- name: bosh-io-release-resource
  type: registry-image
  source:
    repository: concourse/bosh-io-release-resource
    tag: v1.2.0  # 建议使用具体版本

resources:
- name: bosh-release
  type: bosh-io-release-resource
  source:
    release: bosh  # 跟踪 "bosh" 发行版
    include_prereleases: false

jobs:
- name: detect-and-fetch-release
  plan:
  - get: bosh-release
    trigger: true  # 新版本自动触发任务
  - task: print-release-info
    config:
      platform: linux
      image_resource:
        type: registry-image
        source: {repository: alpine, tag: latest}
      inputs:
      - name: bosh-release
      run:
        path: sh
        args:
        - -c
        - |
          echo "Detected new BOSH release version:"
          cat bosh-release/version
          echo "Download URL: $(cat bosh-release/url)"

5. 配置参数说明

5.1 Source 配置参数

5.2 In 操作参数

6. 镜像信息

• 官方镜像地址：concourse/bosh-io-release-resource
• 源码仓库：https://github.com/concourse/bosh-io-release-resource
• 支持架构：amd64、arm64（取决于镜像标签）