krobertson/concourse-rsync-resource

concourse-rsync-resource镜像说明

这是Concourse CI的资源镜像，用于通过rsync和SSH协议在共享存储位置持久化构建工件，支持多服务器配置与灵活的同步参数设置，满足CI流水线中工件存储需求。

核心功能

• 支持单服务器或多服务器列表配置（多服务器时第一个用于check和in操作）
• 可自定义SSH端口（默认22）
• 控制是否生成版本路径目录（disable_version_path参数）
• 允许传递自定义rsync选项（如权限设置、增量同步）
• 支持指定同步目录或同步所有内容

使用场景

适用于Concourse CI流水线中，将构建产物（如编译结果、打包文件）同步到远程共享存储服务器，实现工件的持久化存储与跨环境共享。

配置说明

必需配置项

• server|servers: 单服务器地址或多服务器列表（必填）
• base_dir: 存储工件的基础目录（必填）
• user: SSH登录用户名（必填）
• private_key: SSH私钥（必填）

可选配置项

• port: SSH端口，默认22
• disable_version_path: 是否禁用版本路径目录，默认false（启用时out操作会将内容放入以版本命名的目录）

部署示例

以下是在Concourse CI中使用该资源的配置示例：

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

resources:
- name: single-server-sync
  type: rsync-resource
  source:
    server: your-server-ip
    base_dir: /path/to/artifact/storage
    user: ssh-user
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      ...（替换为实际私钥）
      -----END RSA PRIVATE KEY-----

- name: multi-server-sync
  type: rsync-resource
  source:
    servers: [server1.example.com, server2.example.com]
    base_dir: /shared/artifact_dir
    user: sync-user
    disable_version_path: true
    private_key: |
      ...（替换为实际私钥）

jobs:
- name: sync-build-artifacts
  plan:
    - get: build-output  # 构建产物资源
    - put: single-server-sync
      params:
        sync_dir: build-output/dist  # 指定同步目录
        rsync_opts: ["-Pav", "--del", "--chmod=Du=rwx,Dgo=rx,Fu=rw,Fog=r"]  # 自定义rsync选项

行为说明

check：检查新工件版本

扫描base_dir中的新工件，识别版本更新。

in：从服务器获取工件

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

out：上传工件到服务器

生成新版本号，在服务器base_dir中创建对应目录（或禁用版本路径），将指定目录同步到服务器。