开源项目 `backup-and-bcp-for-aws` 使用教程

开源项目 backup-and-bcp-for-aws 使用教程

backup-and-bcp-for-awsA collection of scripts & tooling that's executed from Lambda to backup your AWS Services such as Route53, EBS, RDS, EFS, etc into a S3 bucket allowing you to sync into Google Cloud for Business Continuity. 项目地址:https://gitcode.com/gh_mirrors/ba/backup-and-bcp-for-aws

1. 项目的目录结构及介绍

backup-and-bcp-for-aws/
├── README.md
├── package.json
├── serverless.yml
├── scripts/
│   ├── backup.js
│   ├── restore.js
│   └── utils.js
├── config/
│   ├── default.json
│   └── production.json
└── tests/
    ├── backup.test.js
    └── restore.test.js

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• serverless.yml: Serverless 框架配置文件。
• scripts/: 包含备份和恢复的脚本文件。
  • backup.js: 备份脚本。
  • restore.js: 恢复脚本。
  • utils.js: 工具函数。
• config/: 配置文件目录。
  • default.json: 默认配置。
  • production.json: 生产环境配置。
• tests/: 测试脚本目录。
  • backup.test.js: 备份脚本测试。
  • restore.test.js: 恢复脚本测试。

2. 项目的启动文件介绍

项目的启动文件主要是 serverless.yml 和 package.json 中的脚本。

serverless.yml

这是 Serverless 框架的配置文件，定义了 AWS Lambda 函数的部署配置、事件触发器和资源配置。

service: backup-and-bcp-for-aws

provider:
  name: aws
  runtime: nodejs14.x

functions:
  backup:
    handler: scripts/backup.handler
    events:
      - schedule: rate(1 day)
  restore:
    handler: scripts/restore.handler
    events:
      - http:
          path: restore
          method: post

package.json

定义了项目的依赖和脚本命令。

{
  "name": "backup-and-bcp-for-aws",
  "version": "1.0.0",
  "scripts": {
    "deploy": "serverless deploy",
    "test": "mocha tests/"
  },
  "dependencies": {
    "aws-sdk": "^2.814.0",
    "serverless": "^2.21.1"
  },
  "devDependencies": {
    "mocha": "^8.2.1"
  }
}

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包含默认配置和生产环境配置。

config/default.json

默认配置文件，包含通用配置。

{
  "aws": {
    "region": "us-east-1",
    "bucket": "backup-bucket"
  },
  "backup": {
    "schedule": "rate(1 day)"
  }
}

config/production.json

生产环境配置文件，可以覆盖默认配置。

{
  "aws": {
    "region": "us-west-2",
    "bucket": "production-backup-bucket"
  }
}

通过这些配置文件，可以灵活地调整项目的运行参数，以适应不同的环境和需求。

backup-and-bcp-for-awsA collection of scripts & tooling that's executed from Lambda to backup your AWS Services such as Route53, EBS, RDS, EFS, etc into a S3 bucket allowing you to sync into Google Cloud for Business Continuity. 项目地址:https://gitcode.com/gh_mirrors/ba/backup-and-bcp-for-aws