{"id":20445205,"url":"https://github.com/addepar/backup-monkey","last_synced_at":"2025-07-23T23:41:57.495Z","repository":{"id":28261377,"uuid":"117766607","full_name":"Addepar/backup-monkey","owner":"Addepar","description":"A monkey that makes sure you have snapshots of all your EBS volumes","archived":false,"fork":false,"pushed_at":"2023-08-22T09:55:17.000Z","size":69,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":10,"default_branch":"addepar/master","last_synced_at":"2025-01-15T21:30:52.407Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Addepar.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-17T01:37:42.000Z","updated_at":"2022-03-08T22:26:33.000Z","dependencies_parsed_at":"2024-11-19T02:15:22.936Z","dependency_job_id":"466f5f85-6607-4ae8-a74b-c98f73929e57","html_url":"https://github.com/Addepar/backup-monkey","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Addepar%2Fbackup-monkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Addepar%2Fbackup-monkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Addepar%2Fbackup-monkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Addepar%2Fbackup-monkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Addepar","download_url":"https://codeload.github.com/Addepar/backup-monkey/tar.gz/refs/heads/addepar/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241993027,"owners_count":20054448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T10:11:23.693Z","updated_at":"2025-03-05T08:30:32.513Z","avatar_url":"https://github.com/Addepar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Backup Monkey\n=============\n\nThis is a fork of https://github.com/Answers4AWS/backup-monkey.\n\nA monkey that makes sure you have a backup of your EBS volumes in case something goes wrong. \n\nIt is designed specifically for Amazon Web Services (AWS), and uses Python and Boto.\n\nThis script is designed to be run on a schedule, probably by CRON. \n\nUsage\n-----\n\n::\n\n    usage: backup-monkey [-h] [--region REGION]\n                         [--max-snapshots-per-volume SNAPSHOTS] [--snapshot-only]\n                         [--remove-only] [--verbose] [--version]\n                         [--tags TAGS [TAGS ...]] [--reverse-tags]\n                         [--label LABEL]\n                         [--snapshot-prefix SNAPSHOT_PREFIX]\n                         [--cross-account-number CROSS_ACCOUNT_NUMBER]\n                         [--cross-account-role CROSS_ACCOUNT_ROLE]\n                         [--path-to-graffiti-config PATH_TO_GRAFFITI_CONFIG]\n\n    Loops through all EBS volumes, and snapshots them, then loops through all\n    snapshots, and removes the oldest ones.\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --region REGION       the region to loop through and snapshot (default is\n                            current region of EC2 instance this is running on).\n                            E.g. us-east-1\n      --max-snapshots-per-volume SNAPSHOTS\n                            the maximum number of snapshots to keep per EBS\n                            volume. The oldest snapshots will be deleted. Default:\n                            3\n      --snapshot-only       Only snapshot EBS volumes, do not remove old snapshots\n      --remove-only         Only remove old snapshots, do not create new snapshots\n      --verbose, -v         enable verbose output (-vvv for more)\n      --version             display version number and exit\n      --tags TAGS [TAGS ...]\n                            Only snapshot instances that match passed in tags.\n                            E.g. --tag Name:foo will snapshot all instances with a\n                            tag `Name` and value is `foo`\n      --reverse-tags        Do a reverse match on the passed in tags. E.g. --tag\n                            Name:foo --reverse-tags will snapshot all instances\n                            that do not have a `Name` tag with the value `foo`\n      --label           LABEL\n                            Only snapshot instances that match passed in label\n                            are created or deleted. Default: None.  Selected all\n                            snapshot. You have the posibility of create a different\n                            strategies for daily, weekly and monthly for example.\n                            Label daily won't deleted label weekly. E.g.\n                              backup-monkey --max-snapshots-per-volume 6 --label daily\n                              backup-monkey --max-snapshots-per-volume 4 --label weekly\n                            You save 6 + 4 snapshots max. instead 4 or 6\n      --snapshot-prefix SNAPSHOT_PREFIX\n                           Created snapshots will contain this prefix. Only\n                           considers snapshots for removal that start with this\n                           prefix. Default: BACKUP_MONKEY\n      --cross-account-number CROSS_ACCOUNT_NUMBER\n                            Do a cross-account snapshot (this is the account\n                            number to do snapshots on). NOTE: This requires that\n                            you pass in the --cross-account-role parameter. E.g.\n                            --cross-account-number 111111111111 --cross-account-\n                            role Snapshot\n      --cross-account-role CROSS_ACCOUNT_ROLE\n                            The name of the role that backup-monkey will assume\n                            when doing a cross-account snapshot. E.g. --cross-\n                            account-role Snapshot\n      --path-to-graffiti-config PATH_TO_GRAFFITI_CONFIG\n                            backup-monkey can tag all created snapshots by using\n                            graffiti-monkey, if this is desired provide the\n                            absolute path to the graffiti config\n      --ratelimit RATELIMIT\n                            Time to wait in seconds between subsequent requests to\n                            the AWS API. E.g. --ratelimit 5\n\nExamples\n--------\n\nCreate snapshots of all EBS volumes in us-east-1:\n\n::\n\n    backup-monkey --region us-east-1\n\nDelete snapshots of EBS volumes in us-west-1 where a volume has more than 5 snapshots:\n\n::\n\n    backup-monkey --region us-west-1 --max-snapshots-per-volume 5 --remove-only\n\n\nInstallation\n------------\n\nYou can install Backup Monkey using the usual PyPI channels. Example:\n\n::\n\n    sudo pip install backup_monkey\n    \nYou can find the package details here: https://pypi.python.org/pypi/backup_monkey\n\nAlternatively, if you prefer to install from source:\n\n::\n\n    git clone git@github.com:fsperling/backup-monkey.git\n    cd backup-monkey\n    python setup.py install\n\n\nConfiguration\n-------------\n\nThis project uses `Boto \u003chttp://boto.readthedocs.org/en/latest/index.html\u003e`__ to\ncall the AWS APIs. You can pass your AWS credentials to Boto can by using a\n:code:`.boto` file, IAM Roles or environment variables. Full information can be\nfound here:\n\nhttp://boto.readthedocs.org/en/latest/boto_config_tut.html\n\n\nRun test\n--------\n\n::\n\n    python -m unittest -v tests.unit.test_exceptions\n    python -m unittest -v tests.unit.test_tags\n\n\nWarning\n-------\n\nMake no mistake. This script WILL delete snapshots. This script WILL create\nsnapshots, which can cost you money. There really are no warranties or\nguarantees. For costs, refer to http://aws.amazon.com/ec2/pricing/\n\n\nSource Code\n-----------\n\nThe Python source code for Backup Monkey is available on GitHub:\n\nhttps://github.com/Answers4AWS/backup-monkey\n\n\nAbout Answers for AWS\n---------------------\n\nThis code was written by `Peter\nSankauskas \u003chttps://twitter.com/pas256\u003e`__, founder of `Answers for\nAWS \u003chttp://answersforaws.com/\u003e`__ - a company focused on helping businesses\nlearn how to use AWS, without doing it the hard way. If you are looking for help\nwith AWS, please `contact us \u003chttp://answersforaws.com/contact/\u003e`__.\n\n\nLicense\n-------\n\nCopyright 2013 Answers for AWS LLC\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may\nnot use this file except in compliance with the License. You may obtain\na copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable\nlaw or agreed to in writing, software distributed under the License is\ndistributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\nKIND, either express or implied. See the License for the specific\nlanguage governing permissions and limitations under the License.\n      \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faddepar%2Fbackup-monkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faddepar%2Fbackup-monkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faddepar%2Fbackup-monkey/lists"}