justonecommand/concourse-rsync-resource

concourse-rsync-resource

https://concourse.ci/ "concourse.ci主页" https://concourse.ci/implementing-resources.html "实现资源"，用于通过rsync和ssh在共享存储位置持久化构建制品。

镜像概述和主要用途

该镜像作为Concourse CI的资源类型，提供了通过rsync和ssh协议在Concourse与远程服务器之间同步构建制品的能力，实现构建产物的持久化存储和版本管理。

核心功能和特性

• 支持通过SSH协议安全连接远程服务器
• 使用rsync高效同步指定目录的构建制品
• 提供版本化管理机制，自动生成版本目录
• 支持自定义rsync同步参数，满足不同场景需求
• 当无初始版本时，自动创建00000000目录作为初始版本

配置参数说明

资源配置（Source）

初始状态

若远程服务器的base_dir中无任何版本目录，将自动创建00000000目录作为初始资源版本。

行为说明

Check

搜索base_dir中是否存在新的版本目录。若不需要版本控制，则使用latest目录的最新时间戳作为版本标识。

Out

根据指定的version检查对应版本目录是否存在，通过rsync将该版本的制品同步回本地；若不需要版本控制，则同步latest目录的制品。

• rsync_opts：可选，默认值为-Pavt，指定的选项将追加到默认参数中

In

生成新的版本号并在远程服务器的base_dir中创建关联目录，通过rsync将输入目录的制品同步到服务器存储位置，输出版本号；若不需要版本控制，则使用latest目录并输出最新文件的时间戳。

• rsync_opts：可选，默认值为-Pavt，指定的选项将追加到默认参数中

使用示例

Docker Compose/Concourse配置示例

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

resources:
- name: sync-resource
  type: rsync-resource
  source:
    server: example.com  # 远程服务器地址
    base_dir: /data/sync  # 远程服务器上的基础目录
    sync_dirs:
      - artifacts/build/  # 需要同步的目录1
      - logs/  # 需要同步的目录2
    user: concourse  # SSH登录用户名
    private_key: |  # SSH私钥
            -----BEGIN RSA PRIVATE KEY-----
            ...
            -----END RSA PRIVATE KEY-----

jobs:
- name: build-and-sync
  plan:
    - task: build
      config:
        # 构建任务配置...
    - put: sync-resource  # 同步制品到远程服务器
      params: 
        rsync_opts: 
        - "-z"  # 启用压缩
        - "--del"  # 删除远程不存在的文件
        - "--chmod=Du=rwx,Dgo=rx,Fu=rw,Fog=r"  # 设置文件权限
    - get: sync-resource  # 从远程服务器获取制品
      params: 
        rsync_opts: 
        - "-z"  # 启用压缩

使用场景和适用范围

• 持续集成/持续部署(CI/CD)流程中构建制品的持久化存储
• 需要在Concourse与远程服务器之间双向同步文件的场景
• 对文件同步效率和安全性有要求的构建环境
• 需要版本化管理构建产物的项目