Skip to main content

A service that makes sure you have snapshots of all your EBS volumes

Project description

Build Status

A monkey that makes sure you have a backup of your EBS volumes in case something goes wrong.

It is designed specifically for Amazon Web Services (AWS), and uses Python and Boto.

This script is designed to be run on a schedule, probably by CRON.

Usage

usage: backup-monkey [-h] [--region REGION]
                     [--max-snapshots-per-volume SNAPSHOTS] [--snapshot-only]
                     [--remove-only] [--verbose] [--version]

Loops through all EBS volumes, and snapshots them, then loops through all
snapshots, and removes the oldest ones.

optional arguments:
  -h, --help            show this help message and exit
  --region REGION       the region to loop through and snapshot (default is
                        current region of EC2 instance this is running on).
                        E.g. us-east-1
  --max-snapshots-per-volume SNAPSHOTS
                        the maximum number of snapshots to keep per EBS
                        volume. The oldest snapshots will be deleted.
                        Default: 3
  --snapshot-only       Only snapshot EBS volumes, do not remove old snapshots
  --remove-only         Only remove old snapshots, do not create new snapshots
  --verbose, -v         enable verbose output (-vvv for more)
  --version             display version number and exit

Examples

Create snapshots of all EBS volumes in us-east-1:

backup-monkey --region us-east-1

Delete snapshots of EBS volumes in us-west-1 where a volume has more than 5 snapshots:

backup-monkey --region us-west-1 --max-snapshots-per-volume 5 --remove-only

Installation

You can install Backup Monkey using the usual PyPI channels. Example:

sudo pip install backup_monkey

You can find the package details here: https://pypi.python.org/pypi/backup_monkey

Alternatively, if you prefer to install from source:

git clone git@github.com:Answers4AWS/backup-monkey.git
cd backup-monkey
python setup.py install

Warning

Make no mistake. This script WILL delete snapshots. This script WILL create snapshots, which can cost you money. There really are no warranties or guarantees. For costs, refer to http://aws.amazon.com/ec2/pricing/

Source Code

The Python source code for Backup Monkey is available on GitHub:

https://github.com/Answers4AWS/backup-monkey

About Answers for AWS

This code was written by Peter Sankauskas, founder of Answers for AWS - a company focused on helping businesses learn how to use AWS, without doing it the hard way. If you are looking for help with AWS, please contact us.

License

Copyright 2013 Answers for AWS LLC

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backup_monkey-1.0.0.tar.gz (11.0 kB view details)

Uploaded Source

File details

Details for the file backup_monkey-1.0.0.tar.gz.

File metadata

File hashes

Hashes for backup_monkey-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f06800d223c519ea8d073d7c43c80a8111a095cd9646061d3d6f00510590b0ab
MD5 ca4c2768ae5f1a45c6ddc1ba30413f78
BLAKE2b-256 f76cd1cd8bcf636d3930c15596bd9b8b53ec43d7856604bb39a9cf941caf650e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page