concourse/pool-resource

Pool Resource Docker镜像文档

1. 镜像概述和主要用途

Pool Resource 是一个提供锁池（模拟信号量）机制的工具，用于锁定需要串行交互的实体（如环境、流水线流程等），确保其按顺序被访问。该资源基于 Git 仓库实现锁状态的存储与管理，其配置方式与 Concourse 的 git-resource 高度兼容，便于集成到现有 CI/CD 流程中。

2. 核心功能和特性

• 锁池机制：提供信号量模拟功能，支持创建和管理多个锁实例。
• 实体锁定：支持对环境、流水线任务、共享资源等实体进行锁定，防止并发冲突。
• Git 集成：基于 Git 仓库存储锁状态，支持版本控制和分布式协作。
• 配置兼容性：配置参数与 git-resource 基本一致，降低使用门槛。
• 串行控制：确保被锁定的实体按顺序被访问，避免并发操作导致的资源竞争或数据不一致。

3. 使用场景和适用范围

• 共享资源访问控制：多任务/流水线需串行访问共享资源（如数据库、测试环境）时，通过锁池机制避免冲突。
• CI/CD 流水线编排：在 CI/CD 流程中控制环境部署、版本发布等关键步骤的执行顺序。
• 并发操作防护：防止多实例并发操作同一实体（如配置文件修改、服务重启）导致的不一致问题。

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

4.1 前置条件

• 已部署 Concourse CI/CD 平台（通常作为 Concourse 资源类型使用）。
• 用于存储锁状态的 Git 仓库（公开或私有均可，需配置访问权限）。

4.2 配置参数

4.2.1 源配置（Source Configuration）

与 git-resource 配置兼容，主要包括 Git 仓库连接参数：

4.2.2 操作参数（Params）

4.3 使用示例（Concourse Pipeline 配置）

4.3.1 资源定义（Resource Definition）

在 Concourse Pipeline 中定义 Pool Resource 类型及实例：

yaml
resources:
- name: environment-locks
  type: pool
  source:
    repo: git@github.com:your-org/lock-repo.git  # 存储锁状态的 Git 仓库
    branch: main                                # 分支
    private_key: ((git-private-key))            # SSH 私钥（私有仓库必填）

4.3.2 锁定资源（获取锁）

在 Job 中通过 get 步骤获取锁：

yaml
jobs:
- name: deploy-to-staging
  plan:
  - get: environment-locks
    params: {lock_name: staging-env}  # 获取名为 "staging-env" 的锁
  - task: deploy
    config:
      # 部署任务配置（略）

4.3.3 释放资源（释放锁）

在 Job 完成后通过 put 步骤释放锁：

yaml
jobs:
- name: deploy-to-staging
  plan:
  # ... 部署任务步骤 ...
  - put: environment-locks
    params: {lock_name: staging-env, unlock: true}  # 释放 "staging-env" 锁

5. Docker 部署方案示例

Pool Resource 通常作为 Concourse 资源类型集成，无需单独部署 Docker 容器。以下是完整的 Concourse Pipeline 示例（pipeline.yml）：

yaml
---
resource_types:
- name: pool
  type: docker-image
  source:
    repository: concourse/pool-resource  # Pool Resource 官方镜像

resources:
- name: app-code
  type: git
  source:
    repo: git@github.com:your-org/app.git
    branch: main
    private_key: ((app-repo-key))

- name: env-locks
  type: pool
  source:
    repo: git@github.com:your-org/locks.git
    branch: main
    private_key: ((locks-repo-key))

jobs:
- name: test-and-deploy
  plan:
  - get: app-code
    trigger: true
  - get: env-locks
    params: {lock_name: test-env}  # 获取测试环境锁
  - task: run-tests
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: alpine}
      inputs: [{name: app-code}]
      run:
        path: sh
        args: ["-c", "cd app-code && ./run-tests.sh"]
  - put: env-locks
    params: {lock_name: test-env, unlock: true}  # 释放测试环境锁

6. 参考链接

• 源码及完整文档：https://github.com/concourse/pool-resource/
• Concourse git-resource 文档：https://github.com/concourse/git-resource