mandeepbhutani/concourse-rsync-resource

concourse-rsync-resource

Concourse CI的资源镜像，用于通过rsync和SSH在共享存储位置持久化构建工件。

镜像概述

该镜像作为Concourse CI的扩展资源类型，实现了与远程服务器间的文件同步功能，支持单服务器或多服务器配置，可灵活管理构建工件的存储与检索流程。

核心功能

• 通过rsync+SSH协议同步构建工件到远程共享存储
• 支持单服务器或多服务器列表配置（多服务器时首个用于in/check操作）
• 可配置版本路径是否禁用，灵活控制工件存储结构
• 允许自定义rsync选项，满足不同场景的同步需求

使用场景

• Concourse CI流水线中持久化保存构建产物
• 多环境部署时将工件分发到多个目标服务器
• 持续集成流程中传递跨阶段的构建结果

配置说明

必选配置项

• server|servers: 目标服务器地址（单服务器用server，多服务器用servers列表）
• base_dir: 远程存储工件的基础目录
• user: SSH登录用户名
• private_key: 用于SSH认证的私钥

可选配置项

• port: SSH端口，默认值22
• disable_version_path: 是否禁用版本路径（默认false，启用时工件不按版本名创建目录）

部署示例

资源类型定义

yaml
resource_types:
- name: rsync-resource
  type: docker-image
  source:
    repository: mandeepbhutani/concourse-rsync-resource
    tag: latest

单服务器资源配置

yaml
resources:
- name: sync-single-server
  type: rsync-resource
  source:
    server: 192.168.1.100
    base_dir: /data/artifacts
    user: ci-user
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      ...（私钥内容）...
      -----END RSA PRIVATE KEY-----

多服务器资源配置

yaml
resources:
- name: sync-multi-servers
  type: rsync-resource
  source:
    servers:
      - server1.example.com
      - server2.example.com
    base_dir: /shared/artifacts
    user: ci-user
    disable_version_path: false
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      ...（私钥内容）...
      -----END RSA PRIVATE KEY-----

流水线任务示例

yaml
jobs:
- name: upload-artifacts
  plan:
    - task: build-app
      config:
        platform: linux
        image_resource:
          type: docker-image
          source: {repository: golang, tag: 1.21}
        outputs:
          - name: build-output
        run:
          path: go
          args: ["build", "-o", "build-output/app"]
    - put: sync-single-server
      params:
        sync_dir: build-output
        rsync_opts: ["-Pav", "--del", "--chmod=Du=rwx,Dgo=rx,Fu=rw,Fog=r"]

行为说明

check：检查工件新版本

扫描远程base_dir，发现新存储的工件版本。

in：检索工件

根据指定版本，从远程服务器同步对应工件到本地。

out：上传工件

生成新版本号并在远程base_dir创建对应目录（若未禁用版本路径），同步指定目录的工件到服务器，并输出版本信息。

out参数说明

• sync_dir: 可选，指定要同步的目录（未指定则同步所有put内容）
• rsync_opts: 可选，自定义rsync命令选项列表