README
¶
TrackIt is a tool to optimize your AWS cloud usage and spending.
Features
- Easy account setup
- AWS Cost Breakdown
- AWS Tags overview
- Events alerts
How to use
With Docker Compose
You can start using TrackIt by using the docker-compose.yml template available in this repository. It will pull Docker images from Docker Registry.
$> docker-compose up -d
You can also build locally the needed Docker images by using the docker-compose.yml file available in docker/ folder.
$> docker-compose up -d -f docker/docker-compose.yml
Manually
0. Be sure all requirements below are met
1. Clone this repository
$> mkdir -p $HOME/go/src/github.com/trackit
$> cd $HOME/go/src/github.com/trackit
$> git clone https://github.com/trackit/trackit-server
$> cd trackit-server
2. Check out dependencies
$> govendor sync -v
3. Start TrackIt
$> ./start.sh
Note: On most operating systems, you will need to increase the mmap limit to allow elasticsearch to run properly:
$> sudo sysctl -w vm.max_map_count=262144
4. Now you can use TrackIt
TrackIt API is now listening on localhost:8580
Web UI
A Web UI made with React is available here: TrackIt Client
API documentation
The API exposes its own documentation on the GET /docs route, in JSON format.
Also, the documentation for each route can be retrieved by an OPTIONS
request. We are working on an actual viewer for this.
Recommendation plugins
Trackit uses a plugin system to easily implement new recommendation checks.
Informations on how to write plugins are available in a README in the plugins directory.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package costs gets billing information from an ElasticSearch.
|
Package costs gets billing information from an ElasticSearch. |
|
Package models contains the types for schema 'trackit'.
|
Package models contains the types for schema 'trackit'. |
|
onDemandToRI
|
|
|
periodic runs periodic tasks.
|
periodic runs periodic tasks. |
|
s3
|
|
|
costs
Package s3/costs gets billing information from an ElasticSearch.
|
Package s3/costs gets billing information from an ElasticSearch. |
|
usageReports
|
|
|
es
Package costs gets billing information from an ElasticSearch.
|
Package costs gets billing information from an ElasticSearch. |
|
req
package req provides request body validation facilities.
|
package req provides request body validation facilities. |