totycro/s3fs

Docker化的s3fs客户端

该Docker镜像通过fuse的https://github.com/s3fs-fuse/s3fs-fuse实现，将远程S3存储桶资源挂载到容器中。它本质上是一种低成本的Docker[卷]实现：使用适当的创建选项（见下文），可将远程存储桶绑定挂载回主机目录，使存储桶内容对主机进程及其他容器可用。容器终止时会自动卸载远程存储桶。

镜像[标签]遵循https://github.com/s3fs-fuse/s3fs-fuse实现的版本。当[重新构建]时，会自动获取https://github.com/s3fs-fuse/s3fs-fuse的新版本。https://github.com/s3fs-fuse/s3fs-fuse从主仓库的标记git版本编译而来。

示例

假设主机上存在/mnt/tmp目录，以下命令会挂载远程S3存储桶，并将远程资源绑定挂载到主机的/mnt/tmp，使远程文件对同一主机上的进程和/或其他容器可访问。

Shell
docker run -it --rm \
    --device /dev/fuse \
    --cap-add SYS_ADMIN \
    --security-opt "apparmor=unconfined" \
    --env "AWS_S3_BUCKET=<bucketName>" \
    --env "AWS_S3_ACCESS_KEY_ID=<accessKey>" \
    --env "AWS_S3_SECRET_ACCESS_KEY=<secretKey>" \
    --env UID=$(id -u) \
    --env GID=$(id -g) \
    -v /mnt/tmp:/opt/s3fs/bucket:rshared \
    efrecon/s3fs

--device、--cap-add和--security-opt选项及其值确保容器能够使用FUSE提供S3存储桶。rshared确保绑定挂载使文件和目录对主机及其他容器递归可用。

容器选项

可通过一系列环境变量（大多以AWS_S3_开头）配置容器：

• AWS_S3_BUCKET：存储桶名称，必填项。
• AWS_S3_AUTHFILE：符合https://github.com/s3fs-fuse/s3fs-fuse指定格式的授权文件路径。若为空，则从其他授权相关环境变量获取数据。
• AWS_S3_ACCESS_KEY_ID：S3存储桶的访问密钥，仅在AWS_S3_AUTHFILE为空时使用。
• AWS_S3_SECRET_ACCESS_KEY：S3存储桶的密钥，仅在AWS_S3_AUTHFILE为空时使用。但AWS_S3_SECRET_ACCESS_KEY_FILE优先级高于此变量。
• AWS_S3_SECRET_ACCESS_KEY_FILE：指向包含S3存储桶密钥的文件路径。存在时，从文件获取密码，忽略AWS_S3_SECRET_ACCESS_KEY变量。便于通过Dockersecrets传递密码，仅在AWS_S3_AUTHFILE为空时使用。
• AWS_S3_URL：Amazon服务的URL，可用于挂载实现兼容API的外部服务。
• AWS_S3_MOUNT：容器内挂载WebDAV资源的位置，默认为/opt/s3fs/bucket，通常无需修改。
• UID：容器内共享目录所有者的用户ID。
• GID：容器内共享目录所有者的组ID。
• S3FS_DEBUG：设为1可获取https://github.com/s3fs-fuse/s3fs-fuse的调试信息。
• S3FS_ARGS：可包含传递给https://github.com/s3fs-fuse/s3fs-fuse的其他选项。

命令

默认情况下，容器会定期列出挂载目录内容，这通过挂载远程存储桶后执行的命令实现。若不希望此行为，可传递empty.sh作为命令。

注意这两个命令均确保容器终止时从挂载点卸载远程存储桶，因此应选择其中一个以保证正常运行。若未卸载，挂载系统会因存在未知条目而不稳定。

自动卸载通过执行命令中的trap和https://github.com/krallin/tini结合实现。https://github.com/krallin/tini直接包含在镜像中，以支持在Swarm环境中运行。

版本和标签

Docker[镜像]的[标签]自动匹配https://github.com/s3fs-fuse/s3fs-fuse的官方[版本]列表。通过GitHub API发现以v开头的标签列表，并为每个标签构建单独镜像。镜像基于https://hub.docker.com/_/alpine构建。