track0x1/concourse-rsync-resource

concourse-rsync-resource

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

镜像概述

该镜像提供Concourse CI的rsync资源实现，支持在CI/CD流水线中同步构建产物到指定服务器的共享存储，无需目标服务器的shell访问权限即可工作。

核心功能

• 多服务器支持：可配置单个或多个服务器，首个服务器用于in和check操作的源。
• 自定义选项：支持设置SSH端口、基础目录、用户凭证、SSH及rsync选项。
• 版本路径控制：可选择是否禁用版本路径，灵活管理工件存储结构。
• 标准资源行为：实现Concourse资源的check（检查新版本）、in（获取工件）、out（上传工件）行为。

使用场景

适用于Concourse CI/CD流水线中需要同步构建产物到共享存储的场景，例如：

• 持续集成过程中保存构建输出到指定服务器。
• 多环境部署前同步工件到目标服务器。

配置说明

配置参数

• server|servers：必填，单个或多个服务器地址列表。若用servers，首个服务器作为in和check的源。
• port：可选，SSH端口，默认22。
• base_dir：必填，工件存储的基础目录。
• user：必填，SSH登录用户。
• private_key：必填，用户对应的私钥。
• ssh_opts：可选，SSH命令行选项。
• rsync_opts：可选，rsync命令行选项。
• disable_version_path：可选，默认false。若为true，out不创建版本目录，check和in将base_dir下所有文件视为版本。

示例配置

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

resources:
- name: sync-resource
  type: rsync-resource
  source:
    server: your-server-address
    base_dir: /path/to/sync/directory
    user: your-ssh-user
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      ...你的私钥内容...
      -----END RSA PRIVATE KEY-----

- name: sync-resource-multiple
  type: rsync-resource
  source:
    servers:
      - server1.example.com
      - server2.example.com
    base_dir: /path/to/sync/directory
    user: your-ssh-user
    disable_version_path: false
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      ...你的私钥内容...
      -----END RSA PRIVATE KEY-----

jobs:
- name: my-great-job
  plan:
    # ...其他步骤...
    - put: sync-resource
      params: {"sync_dir": "my-output-dir"}

行为说明

check：检查工件新版本

搜索base_dir查找新存储的工件。

in：从服务器获取指定版本工件

根据version检查存在性，通过rsync拉取对应版本工件。

out：上传新工件到服务器

生成新version及目录（若未禁用版本路径），同步输入目录工件到服务器base_dir并输出version。

上传参数

• sync_dir：可选，指定同步目录。未指定则同步put操作的所有内容。