{"id":13837187,"url":"https://github.com/Answers4AWS/graffiti-monkey","last_synced_at":"2025-07-10T16:32:27.308Z","repository":{"id":10186006,"uuid":"12274215","full_name":"Answers4AWS/graffiti-monkey","owner":"Answers4AWS","description":"Goes around tagging things","archived":false,"fork":false,"pushed_at":"2023-06-18T08:02:18.000Z","size":98,"stargazers_count":255,"open_issues_count":25,"forks_count":88,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-11-09T07:14:47.234Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/Answers4AWS.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}},"created_at":"2013-08-21T15:48:24.000Z","updated_at":"2024-08-22T18:39:00.000Z","dependencies_parsed_at":"2024-01-19T10:14:24.493Z","dependency_job_id":"140f5904-f097-4322-b593-b485bd265f3c","html_url":"https://github.com/Answers4AWS/graffiti-monkey","commit_stats":{"total_commits":68,"total_committers":12,"mean_commits":5.666666666666667,"dds":0.6764705882352942,"last_synced_commit":"2411924190c2a909b886dc374573c0f79093fed0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Answers4AWS%2Fgraffiti-monkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Answers4AWS%2Fgraffiti-monkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Answers4AWS%2Fgraffiti-monkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Answers4AWS%2Fgraffiti-monkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Answers4AWS","download_url":"https://codeload.github.com/Answers4AWS/graffiti-monkey/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225648363,"owners_count":17502176,"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-08-04T15:01:02.900Z","updated_at":"2024-11-20T23:32:28.488Z","avatar_url":"https://github.com/Answers4AWS.png","language":"Python","funding_links":[],"categories":["Python","AWS"],"sub_categories":[],"readme":"Graffiti Monkey\n===============\n\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n   :alt: Join the chat at https://gitter.im/Answers4AWS/graffiti-monkey\n   :target: https://gitter.im/Answers4AWS/graffiti-monkey?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\n\n.. image:: https://travis-ci.org/Answers4AWS/graffiti-monkey.png?branch=master\n   :target: https://travis-ci.org/Answers4AWS/graffiti-monkey\n   :alt: Build Status\n\nThe Graffiti Monkey goes around tagging things. By looking at the tags an EC2\ninstance has, it copies those tags to the EBS Volumes that are attached to it,\nand then copies those tags to the EBS Snapshots.\n\nUsage\n-----\n\n::\n\n\tusage: graffiti-monkey [-h] [--region REGION] [--profile PROFILE] [--verbose] [--version] [--config CONFIG.YML] [--dryrun]\n\n\tPropagates tags from AWS EC2 instances to EBS volumes, and then to EBS\n\tsnapshots. This makes it much easier to find things down the road.\n\n\toptional arguments:\n\t  -h, --help           show this help message and exit\n\t  --region REGION      the region to tag things in (default is current region of\n\t                       EC2 instance this is running on). E.g. us-east-1\n\t  --profile PROFILE    the profile to use to connect to EC2 (default is 'default',\n\t                       see Boto docs for profile credential options)\n\t  --verbose, -v        enable verbose output (-vvv for more)\n\t  --version            display version number and exit\n\t  --config CONFIG.YML  read a yaml configuration file.  specify tags to propagate without changing code.\n\t  --dryrun             dryrun only, display tagging actions but do not perform them\n\t  --append             append propagated tags to existing tags (up to a total of ten tags). When not set,\n\t                       graffiti-monkey will overwrite existing tags.\n\t  --volumes            volume(s) to tag\n\t  --snapshots          snapshot(s) to tag\n\t  --novolumes          do not perform volume tagging\n\t  --nosnapshots        do not perform snapshot tagging\n\nExamples\n--------\n\nSuppose you have the following in `us-east-1`:\n\n::\n\n\ti-abcd1234\n\t  - Tags:\n\t    - Name: \"Instance 1\"\n\n\tvol-bcde3456\n\t  - Attached to i-abcd1234 on /dev/sda1\n\n\tsnap-cdef4567\n\t  - Snapshot of vol-bcde3456\n\n\nWhen you run:\n\n::\n\n    graffiti-monkey --region us-east-1\n\n\nFirst, Graffiti Monkey will set the EBS volume tags\n\n::\n\n\tvol-bcde3456\n\t  - Tags:\n\t    - Name: \"Instance 1\"\n\t    - instance_id: i-abcd1234\n\t    - device: /dev/sda1\n\nand then it will set the tags on the EBS Snapshot\n\n::\n\n\tsnap-cdef4567\n\t  - Tags:\n\t    - Name: \"Instance 1\"\n\t    - instance_id: i-abcd1234\n\t    - device: /dev/sda1\n\n\n\nInstallation\n------------\n\nYou can install Graffiti Monkey using the usual PyPI channels. Example:\n\n::\n\n    sudo pip install graffiti_monkey\n\nYou can find the package details here: https://pypi.python.org/pypi/graffiti_monkey\n\nAlternatively, if you prefer to install from source:\n\n::\n\n    git clone git@github.com:Answers4AWS/graffiti-monkey.git\n    cd graffiti-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\nGraffiti-monkey itself can be configured using a yaml file\n\n::\n\n  ---\n  #region: us-west-1\n  _instance_tags_to_propagate:\n    - 'Name'\n    - 'Owner'\n\n  _volume_tags_to_propagate:\n    - 'Name'\n    - 'instance_id'\n    - 'device'\n    - 'Owner'\n\n  _volume_tags_to_be_set:\n    -  key:   'NU_ROLE'\n       value: 'ebs'\n  \n  _snapshot_tags_to_be_set:\n    -  key:   'NU_ROLE'\n       value: 'ebs_snapshot'\n\n  _volumes_to_tag:\n  # An empty list means tag all volumes\n  # Example entries:\n  #  - 'vol-1ab2c345'\n  #  - 'vol-6de7f890'\n\n  _snapshots_to_tag:\n  # An empty list means tag all snapshots\n  # Example entries:\n  #  - 'snap-12ab3c45'\n  #  - 'snap-6de7f890'\n\n:code:`_instance_tags_to_propagate` is used to define the tags that are propagated\nfrom an instance to its volumes. :code:`_volume_tags_to_propagate` defines the tags\nthat are propagated from a volume to its snapshots.\n\n:code:`_volume_tags_to_be_set` is used to define the tags that are set on volumes\nby default. :code:`_snapshot_tags_to_be_set` defines the tags that are on snapshots\nby default.\n\n:code:`_volumes_to_tag` is used to define the volumes that are tagged. Leave empty\nto tag all volumes. :code:`_snapshots_to_tag` is used to define the snapshots to\nbe tagged. Leave empty to tag all snapshots.\n\nIf the configuration file is used, the _ entry headers must exist (those entries\nhaving no values or commented out values [as shown] is acceptable).\n\nWhen using yaml configuration files you need to have pyYAML. This can be easily setup\n using pip :code:`pip install PyYAML`.  If you don't use config files you don't have\n this limitation.\n\nIf options are specified in both the config file and on the command line, the config\nfile options are used.\n\n\nWiki\n----\n\nCan be found here: https://github.com/Answers4AWS/graffiti-monkey/wiki\n\n\nSource Code\n-----------\n\nThe Python source code for Graffiti Monkey is available on GitHub:\n\nhttps://github.com/Answers4AWS/graffiti-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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAnswers4AWS%2Fgraffiti-monkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAnswers4AWS%2Fgraffiti-monkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAnswers4AWS%2Fgraffiti-monkey/lists"}