Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aksarav/rdsbackups3
Backup RDS Snapshots to S3 - A tool to help you backup the RDS databases to S3
https://github.com/aksarav/rdsbackups3
Last synced: 28 days ago
JSON representation
Backup RDS Snapshots to S3 - A tool to help you backup the RDS databases to S3
- Host: GitHub
- URL: https://github.com/aksarav/rdsbackups3
- Owner: AKSarav
- License: apache-2.0
- Created: 2023-06-19T07:35:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-06-19T07:56:40.000Z (over 1 year ago)
- Last Synced: 2024-05-17T00:28:15.196Z (6 months ago)
- Language: Python
- Size: 7.81 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RDS BACKUP TO S3
This project is a simple script to backup RDS databases to S3. It uses the boto SDK to connect to AWS and create a snapshot of the database. The snapshot is then copied to S3 and the snapshot is deleted.
To Summarize the script does the following:
1. Connects to AWS using boto
2. Creates a snapshot of the database
3. Copies the snapshot to S3
4. Deletes the snapshot
## How to use this tool
1. Clone git repository
2. Create a virtual environment
```
python3 -m venv venv
```
3. Install the requirements using the following command
```
pip install -r requirements.txt
```
4. Run the script
```
python3 rds_backup_to_s3.py [--instance INSTANCE] [--region REGION][--bucket BUCKET] [--prefix PREFIX] [--role ROLE] [--kms KMS]
```
5. Check the S3 bucket for the snapshot
## prequisites
The script expects the following arguments.
`--instance` RDS instance name to backup*
`--region` AWS region of RDS instance
`--bucket` S3 bucket name to copy the snapshot to
`--prefix` S3 prefix ( folder ) to copy the snapshot to
`--role` IAM role to use to copy the snapshot to S3
`--kms` key to use to copy the snapshot to S3
### Further References
Please checkout my blog for further reference
> Feedbacks and Contributions are welcome
### Sample run and output
```bash
$ python3 backup-rds.py – instance mysqlproddb – region us-east-1 – bucket gritfy-backup-drive – prefix databases/mysql/2023/06/18 – kms arn:aws:kms:us-east-1:XXXXXXXXXXX:key/zzzzzzz-1313-4091-xxxx-z18c81001zz – role arn:aws:iam::XXXXXXXXXXX:role/rds-s3-export-support-role
--------------------------------------------------
RDSbackupS3 | Version: 0.0.1 | Github: https://github.com/AKSarav/RDSbackupS3
--------------------------------------------------
instance : 'mysqlproddb'
region : 'us-east-1'
bucket : 'gritfy-backup-drive'
prefix : 'databases/mysql/2023/06/18'
role : 'arn:aws:iam::XXXXXXXXXXX:role/rds-s3-export-support-role'
kms : 'arn:aws:kms:us-east-1:XXXXXXXXXXX:key/zzzzzzz-1313-4091-xxxx-z18c81001zz'
--------------------------------------------------
Creating snapshot: mysqlproddb-manual-2023-06-18-21-00
Snapshot Initiated successfully: mysqlproddb-manual-2023-06-18-21-00
Waiting for snapshot to complete
Snapshot status: available
Snapshot created with arn: arn:aws:rds:us-east-1:XXXXXXXXXXX:snapshot:mysqlproddb-manual-2023-06-18-21-00
Export status: STARTING
Export status: STARTING
Export status: STARTING
Export status: STARTING
Export status: STARTING
Export status: STARTING
Export status: INPROGRESS
Export status: COMPLETE
Export completed Successfully:
Deleting snapshot: mysqlproddb-manual-2023-06-18-21-00
Snapshot deleted successfully: mysqlproddb-prime-manual-2023-06-18-21-00
```
### To do
- [ ] Add support and test with Aurora - In Progress
- [ ] Creating an interface for backup management - In Progress
- [ ] Adding a scheduler to run periodically
- [ ] Integration with Terraform and Pulumi