S3 PIT Restore 使用与配置指南

S3 PIT Restore 使用与配置指南

s3-pit-restore The new home for the s3-pit-restore tool! s3-pit-restore 项目地址: https://gitcode.com/gh_mirrors/s3/s3-pit-restore

1. 项目目录结构及介绍

s3-pit-restore 项目是一个用于恢复 Amazon S3 存储桶中文件的点到时间状态的工具。项目的目录结构如下:

  • .github/: 存放与 GitHub 相关的配置文件。
  • .dockerignore: 用于 Docker 构建时排除不需要的文件和目录。
  • .gitignore: 用于 Git 忽略不需要提交到版本控制的文件和目录。
  • Dockerfile: 用于构建 Docker 镜像的配置文件。
  • LICENSE: 项目的许可协议文件。
  • MANIFEST: 项目清单文件。
  • README.md: 项目说明文件。
  • build.sh: 项目构建脚本。
  • s3-pit-restore: 项目的主执行文件。
  • setup.cfg: Python 打包配置文件。
  • setup.py: Python 打包脚本。

2. 项目的启动文件介绍

项目的启动文件是 s3-pit-restore。这是一个 Python 脚本,用户可以通过命令行调用它来执行恢复操作。以下是一些基本的命令行用法示例:

  • 恢复到本地文件系统:

    s3-pit-restore -b my-bucket -d restored-bucket-local -t "06-17-2016 23:59:50 +2"
    
  • 恢复到 S3 存储桶:

    s3-pit-restore -b my-bucket -B restored-bucket-s3 -t "06-17-2016 23:59:50 +2"
    

更多用法和选项可以通过 -h 参数查看帮助信息。

3. 项目的配置文件介绍

项目的配置主要通过命令行参数进行,但也有几个配置文件可以使用:

  • .aws/ 文件夹:如果使用 AWS 命令行工具,可以通过这个文件夹下的配置文件来设置 AWS 凭据。
  • Dockerfile: 如果需要通过 Docker 运行 s3-pit-restore,可以通过修改这个文件来定制 Docker 镜像。

主执行脚本 s3-pit-restore 支持以下命令行选项:

  • -b BUCKET: 指定要恢复的 S3 存储桶。
  • -B DEST_BUCKET: 指定恢复到的目标 S3 存储桶。
  • -d DEST: 指定本地文件系统上的恢复路径。
  • -p PREFIX: 指定要恢复的 S3 存储桶中的前缀路径。
  • -P DEST_PREFIX: 指定目标 S3 存储桶中的前缀路径。
  • -t TIMESTAMP: 指定恢复到的时间点。
  • -f FROM_TIMESTAMP: 指定恢复起始时间点。
  • 其他选项包括启用冰川恢复、打印详细信息、使用自定义终端点 URL、执行干运行、启用调试输出、运行测试等。

通过这些选项,用户可以灵活地配置和运行 s3-pit-restore 工具。

s3-pit-restore The new home for the s3-pit-restore tool! s3-pit-restore 项目地址: https://gitcode.com/gh_mirrors/s3/s3-pit-restore