vladgh/s3sync Docker 镜像 - 轩辕镜像

S3Sync Docker镜像

此容器用于保持本地目录与AWS S3桶同步。当本地目录为空时，会先从指定S3桶同步到本地目录，之后保持该目录与S3桶同步；若本地目录非空，则不进行初始同步。这是一种在S3中备份最新数据副本，并让新节点启动时获取数据的简单方式。

本脚本适用于单个节点将文件同步到S3，不应作为永久备份解决方案。

容器内的默认同步目录为/sync，可通过SYNCDIR环境变量修改。

AWS凭证

您可以通过以下3种方式声明AWS凭证：

作为环境变量

sh
docker run ...
-e AWS_ACCESS_KEY_ID=1234 \
-e AWS_SECRET_ACCESS_KEY=5678 \
-e AWS_DEFAULT_REGION=us-east-1 \
...

挂载配置目录

sh
docker run ...
-v ~/.aws:/root/.aws:ro
...

Docker Swarm密钥

若使用Docker Swarm密钥，AWS凭证会自动从aws_credentials密钥（若存在）加载，该密钥将链接到~/.aws/credentials。有关Docker Swarm密钥的更多信息，请阅读：<[]>。有关AWS CLI凭证文件的信息，请阅读：<[]>。

命令

• download：（默认）下载文件并退出
• upload：上传文件并退出
• sync：使用inotify监控目录，当文件变化时上传到S3（见SYNCDIR）
• periodic_upload：设置cron任务定期上传文件到S3（见CRON_TIME和INITIAL_DOWNLOAD）
• periodic_download：设置cron任务定期从S3下载文件（见CRON_TIME和INITIAL_DOWNLOAD）

必填环境变量

• AWS_ACCESS_KEY_ID（或有效的IAM角色）
• AWS_SECRET_ACCESS_KEY（或有效的IAM角色）
• AWS_DEFAULT_REGION（或有效的IAM角色）
• S3PATH：S3同步位置（例如：s3://mybucket/myprefix）

可选环境变量

• SYNCDIR：本地同步位置（默认为/sync）
• AWS_S3_SSE：使用S3服务器端加密；可选值：false（不加密）、aes256或true（使用Amazon S3托管密钥的服务器端加密，SSE-S3）、kms（使用AWS KMS托管密钥的服务器端加密，SSE-KMS）（默认为false）。更多信息请参考<[***]>（注意：目前不支持使用客户提供的密钥进行服务器端加密（SSE-C））
• AWS_S3_SSE_KMS_KEY_ID：用于S3对象服务器端加密的AWS KMS密钥ID（仅当与AWS_S3_SSE一起使用时可用）
• CRON_TIME：有效的cron表达式（例如：CRON_TIME='0 */6 * * *'表示每6小时运行一次；默认为每小时）
• INITIAL_DOWNLOAD：是否初始下载文件（默认为true）；仅当目录为空时才下载。设置为force可跳过此检查

使用示例

下载文件并退出

sh
docker run \
  -e S3PATH='s3://mybucket/myprefix' \
  vladgh/s3sync

上传文件并退出

sh
docker run \
  -e S3PATH='s3://mybucket/myprefix' \
  vladgh/s3sync \
  upload

定期上传文件（每6小时）

sh
docker run -d \
  -e S3PATH='s3://mybucket/myprefix' \
  -e CRON_TIME='0 */6 * * *' \
  vladgh/s3sync \
  periodic_upload

监控本地目录

sh
docker run -d \
  -e S3PATH='s3://mybucket/myprefix' \
  vladgh/s3sync \
  sync

监控指定本地目录（主机挂载）

sh
docker run -d \
  -e S3PATH='s3://mybucket/myprefix' \
  -e SYNCDIR='/mydir' \
  -v $(pwd):/mydir \
  vladgh/s3sync \
  sync

使用外部AWS凭证

sh
docker run -d \
  -e S3PATH='s3://mybucket/myprefix' \
  -v ~/.aws:/root/.aws:ro \
  vladgh/s3sync

感谢<[***]>