Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Signiant/aws-team-cost-reporter
Reports on AWS team costs using data from CloudCheckR
https://github.com/Signiant/aws-team-cost-reporter
Last synced: about 2 months ago
JSON representation
Reports on AWS team costs using data from CloudCheckR
- Host: GitHub
- URL: https://github.com/Signiant/aws-team-cost-reporter
- Owner: Signiant
- License: mit
- Archived: true
- Created: 2016-06-21T12:45:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-27T18:06:56.000Z (over 4 years ago)
- Last Synced: 2024-06-28T07:33:37.697Z (3 months ago)
- Language: Python
- Size: 289 KB
- Stars: 5
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aws-team-cost-reporter
Reports on AWS costs grouped by 'team' using data from [CloudCheckR](http://www.cloudcheckr.com)
# Purpose
We've got multiple agile development teams using AWS on various projects. We like to keep the dev AWS accounts as "open" as possible for the teams to encourage experimentation but tracking the costs is a bit tricky. AWS tagging is not available on every service (still!) and we have the concept of individual and shared team resources.
This tool allows you to create a configuration file defining a 'team' and what AWS resources they own at the shared level and the individual level. Currently it can track EC2, S3, DynamoDB and Elastic Beanstalk resources using data derived from CloudCheckR reports. However, the tool uses a plugin model and is extensible to other AWS services should the need arise. As long as CloudCheckR can report on it, the tool can aggregate the data.
# Sample Report Email
The email report that gets generated for each team looks something like this...
# Prerequisites
* You must have a [CloudCheckR](http://www.cloudcheckr.com) subscription. Go get one now, it's a fantastic tool
* You should have a tag defined on EC2 and S3 resources that you can report on. We use "signiant:email" as our tag name but it can be anything. Have a look at our [auto-tagger](https://github.com/Signiant/aws-auto-tagger) which can automatically add tags to EC2 resources as well
* You'll need to configure AWS billing to [dump stats](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/configurecostallocreport.html) for your tags.
* You'll need 4 custom grouping reports defined in cloudcheckr:
* 1 for EC2 resources with your tag
* 1 for S3 resources with your tag
* 1 for all resources with the *elasticbeanstalk:environment-name* tag
* 1 for all resources with the *aws:cloudformation:stack-name* tag (for obtaining ECS cluster stats. Your cluster must be launched by using cloudformation)
* Something like this:
* For DynamoDB, we use the standard cloudCheckR inventory report
* A config file defining your teams. A [sample](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/configurecostallocreport.html) is included in the project
* You'll probably want an email distribution list to send the report to the team (ie. [email protected])
# Usage
The easiest way to run the tool is from docker (because docker rocks). You just pass it a team name and a config file and it will do everything from there
```bash
docker pull signiant/aws-team-cost-reporter
```
```bash
docker run \
-v /config/myconfigfile.yaml:/config.yaml \
signiant/aws-team-cost-reporter \
-c /config.yaml \
-t team-one
```
In this example, we use a bindmount to mount in the config file from a local folder to the root directory of the container. We can then pass the -c argument to the container to have it read the config from / and use the team name of team-one.
There is an optional -d flag to the tool which will turn on more debug output. For example:
```bash
docker run -ti \
-v /config/myconfigfile.yaml:/config.yaml \
signiant/aws-team-cost-reporter \
-c /config.yaml \
-t team-one \
-d
```
# Accessing the raw team cost data
As the final step of running, the tool will write the team cost data to /output/TEAM_NAME.json. This can then be accessed by other tools by using a bind mount into the running container. For example:
```bash
docker run -ti \
-v /config/myconfigfile.yaml:/config.yaml \
-v /localoutput:/output \
signiant/aws-team-cost-reporter \
-c /config.yaml \
-t team-one \
-d
```
Each team data will be written to a seperate json file.
# Project organization
The project is structured as follows:
* [team-cost-reporter.py](https://github.com/Signiant/aws-team-cost-reporter/blob/master/team-cost-reporter/team-cost-reporter.py) - this really just invokes each plugin and calls the output formatter
* [plugins](https://github.com/Signiant/aws-team-cost-reporter/blob/master/team-cost-reporter/plugins) - one plugin per AWS service. The plugin should have a *getTeamCost* function which returns an array of shared or individual costs
* [templates](https://github.com/Signiant/aws-team-cost-reporter/blob/master/team-cost-reporter/templates) - contains a base html email template using [keyword] where values should be substituted
* [output.py](https://github.com/Signiant/aws-team-cost-reporter/blob/master/team-cost-reporter/output.py) - reads the email template and substitues in the values reported by all the plugins into the email
* [cloudcheckr.py](https://github.com/Signiant/aws-team-cost-reporter/blob/master/team-cost-reporter/cloudcheckr.py) - generically calls a cloudcheckr API endpoint and handles the fact that the data returned may be paged. Also adds on the date filters depending on how many days are specified in the config file to report data for
* [mail.py](https://github.com/Signiant/aws-team-cost-reporter/blob/master/team-cost-reporter/mail.py) - uses a [forked version](https://github.com/Signiant/pylib) of ludmal's [mail.py](https://github.com/ludmal/pylib) to send html emails