drillster/drone-rsync

drone-rsync

镜像概述与主要用途

drone-rsync是一个基于纯Bash编写的Drone CI/CD平台插件，适用于Drone 0.5及以上版本。其核心功能是将Drone工作目录中的文件和目录同步到一个或多个远程主机，支持通过SSH协议进行安全传输，满足CI/CD流程中的远程文件部署需求。

核心功能与特性

• 多主机同步：支持通过环境变量指定多个远程主机IP/域名，实现批量文件同步
• 自定义SSH端口：可针对每个主机配置独立SSH端口，适应非标准端口场景
• 预/后执行脚本：提供同步前（PRESCRIPT）和同步后（SCRIPT）的自定义命令执行能力，支持复杂部署流程
• 灵活的rsync参数：允许通过ARGS传递额外rsync选项，满足个性化同步需求（如--blocking-io）
• SSH密钥认证：通过私钥（PLUGIN_KEY）实现远程主机的安全认证，保障传输安全性

使用场景

适用于Drone CI/CD流程中需将构建产物、静态资源、配置文件等同步到远程服务器的场景，例如：

• Web应用构建完成后，将静态文件同步到多台Web服务器
• 配置文件更新后，批量同步到集群中的多个节点
• 自动化测试环境中，将测试数据同步到远程测试主机

使用方法

Docker镜像构建

若需自行构建镜像，可在项目根目录执行以下命令：

bash
docker build --rm=true -t drillster/drone-rsync .

执行命令示例

在本地工作目录中执行（假设本地127.0.0.1:22已运行SSH服务）：

bash
docker run --rm \
  -e PLUGIN_KEY=$(cat some-private-key) \  # SSH私钥内容（用于远程主机认证）
  -e PLUGIN_HOSTS="127.0.0.1, 127.0.0.2, 127.0.0.3" \  # 远程主机列表（逗号分隔）
  -e PLUGIN_PORTS="22, 23, 24" \  # 对应主机的SSH端口（数量需与主机列表一致）
  -e PLUGIN_TARGET="./" \  # 远程主机上的目标同步目录
  -e PLUGIN_PRESCRIPT="echo \"同步前执行脚本完成！\"" \  # 同步前执行的命令
  -e PLUGIN_SCRIPT="echo \"同步后执行脚本完成！\"" \  # 同步后执行的命令
  -e PLUGIN_ARGS="--blocking-io" \  # 传递给rsync的额外参数
  -v $(pwd):$(pwd) \  # 挂载本地工作目录到容器
  -w $(pwd) \  # 设置容器工作目录为本地工作目录
  drillster/drone-rsync

环境变量说明