cloudinn/concourse-digitalocean-resource

Concourse DigitalOcean Worker Provision Resource

这是一个Concourse资源，通过在DigitalOcean动态创建Droplet并配置为worker运行流水线任务，任务完成后销毁Droplet，从而降低CI基础设施成本（DigitalOcean按小时计费）。

注意：该资源已在Concourse v3.13.0测试，支持大多数3.xx版本，但尚未测试或支持4.00及以上版本。

核心功能

1. 动态创建DigitalOcean Droplet作为Concourse worker
2. 任务结束后自动销毁Droplet，减少资源浪费
3. 支持指定Droplet的区域、规格
4. 通过SSH密钥实现worker与Concourse TSA的安全通信
5. 确保任务失败时也能销毁Droplet（通过ensure步骤）

使用场景

• 弹性扩展CI构建资源，应对临时高负载任务
• 避免长期占用固定资源，降低运营成本
• 需要临时专用worker的流水线场景

配置说明

准备工作

1. 从DigitalOcean账户生成API密钥（作为api_key参数）
2. 生成SSH私钥（作为droplet_key参数，用于配置Droplet）
3. 获取Concourse TSA公钥（作为ci_tsa_pub_key参数）
4. 获取Concourse worker私钥（作为ci_worker_key参数，其公钥需提前添加到Concourse Web的TSA授权密钥中）
5. 可选：通过DigitalOcean API获取可用区域和Droplet规格列表

资源类型配置

yaml
resource_types:
  - name: worker-resource
    type: docker-image
    source:
      repository: cloudinn/concourse-digitalocean-resource
      tag: latest

源配置参数

• api_key：必填，DigitalOcean API密钥
• region：可选，Droplet区域（默认ams3）
• droplet_size：可选，Droplet规格（默认s-2vcpu-2gb）
• droplet_key：必填，用于访问Droplet的SSH私钥
• ci_worker_key：必填，worker访问TSA服务器的SSH私钥
• ci_tsa_pub_key：必填，Concourse Web的TSA公钥
• ci_tsa_port：可选，TSA端口（默认2222）
• fly_username：必填，Concourse基础认证用户名
• fly_password：必填，Concourse基础认证密码

资源配置示例：

yaml
resources:
- name: worker
  type: worker-resource
  source:
    api_key: ((DO_API_KEY))
    region: "ams3"
    droplet_size: "s-2vcpu-2gb"
    droplet_key: ((DO_DROPLET_KEY))
    ci_worker_key: ((CONCOURSE_WORKER_KEY))
    ci_tsa_pub_key: ((CONCOURSE_TSA_PUBKEY))
    ci_tsa_port: 2222
    fly_username: ((CONCOURSE_BASIC_AUTH_USER))
    fly_password: ((CONCOURSE_BASIC_AUTH_PASS))

行为说明

• check：无功能
• in（get）：创建Droplet并注册为worker，需指定worker_name参数（唯一主机名）
• out（put）：销毁Droplet并从Concourse注册表中移除worker，需指定worker参数和dont_get: true

部署示例

yaml
resource_types:
- name: worker-resource
  type: docker-image
  source:
    repository: cloudinn/concourse-digitalocean-resource
    tag: latest

resources:
- name: my-worker
  type: worker-resource
  source:
    api_key: ((DO_API_KEY))
    region: "ams3"
    droplet_size: "s-2vcpu-2gb"
    ci_worker_key: ((CONCOURSE_WORKER_KEY))
    ci_tsa_pub_key: ((CONCOURSE_TSA_PUB_KEY))
    fly_username: ((FLY_USERNAME))
    fly_password: ((FLY_PASSWORD))
    droplet_key: ((DO_VM_KEY))

jobs:
  - name: build
    serial: true
    plan:
      - get: my-worker
        timeout: 3.5m
        params:
          worker_name: job-x-build-worker

      - task: some-task
        tags: [job-x-build-worker]
        config:
          platform: linux
          image_resource:
            type: docker-image
            source:
              repository: alpine
          run:
            path: sh
            args:
              - -exc
              - |
                echo "任务运行在worker: job-x-build-worker"

    ensure:
      put: my-worker
      params:
        worker: my-worker
      get_params:
        dont_get: true

许可证

Apache License 2.0