martenb/gitlab-vshosting-ci

rsync-openssh-client 镜像文档

镜像概述

本镜像集成了rsync和openssh-client工具，旨在提供一个轻量级、便捷的文件同步与远程传输解决方案。rsync作为高效的文件同步工具，支持增量传输、数据压缩及校验；openssh-client则提供安全的SSH协议客户端功能，支持SSH连接、SCP/SFTP文件传输及密钥认证，两者结合可实现通过SSH协议的安全文件同步与管理。

核心功能与特性

rsync 功能

• 增量同步：仅传输源文件与目标文件的差异部分，减少带宽占用
• 多协议支持：支持本地文件、SSH、rsync daemon等多种传输方式
• 数据校验：通过校验和确保文件传输完整性
• 压缩传输：支持传输过程中对文件进行压缩，提升传输效率
• 灵活的排除/包含规则：可通过参数指定需要同步或排除的文件/目录

openssh-client 功能

• SSH协议支持：提供SSHv2客户端，支持密码认证与密钥认证
• 文件传输工具：集成scp（安全复制）和sftp（SSH文件传输协议）命令
• 端口转发：支持本地/远程端口转发，实现安全网络访问
• 配置灵活性：兼容标准SSH配置文件（如~/.ssh/config），支持自定义连接参数

使用场景与适用范围

• 服务器间文件同步：跨服务器或跨数据中心的目录/文件增量同步
• 远程备份：将本地数据通过SSH协议备份至远程服务器
• 自动化部署：CI/CD流程中通过SSH将构建产物传输至目标服务器
• 日志聚合：从多台远程服务器同步日志文件至集中存储
• 开发环境配置同步：在多台开发机间同步配置文件（如.bashrc、.vimrc）

使用方法与配置说明

基本使用

通过docker run命令直接调用镜像中的工具，需注意挂载必要的配置文件（如SSH密钥）以实现无密码认证。

镜像拉取

bash
docker pull [镜像名称]  # 请替换为实际镜像名称，如用户自定义镜像或公共仓库镜像

基础命令格式

bash
docker run --rm -v [本地目录]:[容器内目录] [镜像名称] [命令] [参数]

核心参数说明

典型使用示例

1. 通过rsync同步本地目录至远程服务器（SSH协议）

bash
# 挂载本地SSH密钥目录（假设本地~/.ssh包含id_rsa私钥）
# 将本地./data目录同步至远程服务器user@remote-host的/backup/data目录
docker run --rm \
  -v ~/.ssh:/root/.ssh:ro \  # 只读挂载SSH密钥，避免容器内修改
  -v $(pwd)/data:/data:ro \   # 挂载本地数据目录（只读）
  [镜像名称] \
  rsync -avz --delete /data user@remote-host:/backup/data

rsync选项说明：

• -a：归档模式，保留文件权限、时间戳等元数据
• -v：详细输出，显示同步过程
• -z：传输时压缩数据
• --delete：删除目标目录中源目录不存在的文件（保持完全一致）

2. 通过SSH连接远程服务器

bash
# 挂载SSH密钥，连接远程服务器并执行命令
docker run --rm -v ~/.ssh:/root/.ssh:ro [镜像名称] ssh user@remote-host "ls -l /data"

3. 使用scp传输单个文件

bash
# 将本地file.txt传输至远程服务器的/tmp目录
docker run --rm -v ~/.ssh:/root/.ssh:ro -v $(pwd):/local [镜像名称] scp /local/file.txt user@remote-host:/tmp/

持久化配置与数据

为避免每次运行容器时重复挂载密钥或配置文件，可通过挂载/root/.ssh目录持久化SSH配置：

bash
# 创建本地持久化目录
mkdir -p ~/ssh-config

# 首次运行时复制密钥至持久化目录（或直接挂载已有.ssh目录）
cp ~/.ssh/id_rsa ~/ssh-config/
cp ~/.ssh/config ~/ssh-config/  # 若有自定义SSH配置文件

# 后续使用时挂载持久化目录
docker run --rm -v ~/ssh-config:/root/.ssh [镜像名称] rsync ...

安全注意事项

• 密钥权限：容器内/root/.ssh目录及密钥文件权限需严格控制（建议chmod 700 /root/.ssh，chmod 600 /root/.ssh/id_rsa），避免权限过松导致安全风险
• 临时容器：推荐使用--rm参数确保容器退出后自动清理，避免敏感信息残留
• 最小权限原则：远程服务器的SSH密钥建议仅授予必要权限（如仅允许rsync命令，通过authorized_keys中的command字段限制）

总结

本镜像通过集成rsync和openssh-client，提供了一套完整的远程文件同步与传输工具链，适用于各类需要通过SSH协议进行安全文件操作的场景。通过灵活的挂载配置和丰富的命令选项，可满足从简单文件复制到复杂增量同步的多样化需求。