Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cycloidio/terracost
Cloud cost estimation for Terraform in your CLI
https://github.com/cycloidio/terracost
aws azure cloud cost-estimation cost-management cost-optimization gcp infrastructure-as-code terraform terraform-cost-estimation
Last synced: 5 days ago
JSON representation
Cloud cost estimation for Terraform in your CLI
- Host: GitHub
- URL: https://github.com/cycloidio/terracost
- Owner: cycloidio
- License: mit
- Created: 2020-10-06T13:22:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T09:36:15.000Z (about 2 months ago)
- Last Synced: 2024-10-25T05:29:57.030Z (about 2 months ago)
- Topics: aws, azure, cloud, cost-estimation, cost-management, cost-optimization, gcp, infrastructure-as-code, terraform, terraform-cost-estimation
- Language: Go
- Homepage:
- Size: 14.8 MB
- Stars: 293
- Watchers: 7
- Forks: 31
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - cycloidio/terracost - Cloud cost estimation for Terraform in your CLI (Go)
- awesome-tf - terracost - Cloud cost estimation for Terraform in your CLI. (Tools / Community providers)
README
# TerraCost
[](https://pkg.go.dev/github.com/cycloidio/terracost)
Go library for estimating Terraform costs using ingested cloud vendor prices. It is meant to be imported and used by programs (API's or standalone) with access to a MySQL-compatible database and the Internet.
## Installation
```shell
go mod edit -replace github.com/hashicorp/terraform=github.com/cycloidio/[email protected] && go get github.com/cycloidio/terracost
```
We need to do a `-replace` because of https://github.com/golang/go/issues/30354#issuecomment-466557015. We have a custom fork of Terraform and in order
to use TerraCost it needs to be replaced when importing also.
## Requirements
- Go 1.22 or newer
- MySQL database
## Provider support
Currently Terracost supports the following providers and with an specific subset of resources from them:
* [AWS](./docs/aws.md#list-of-supported-resources-and-attributes)
* [Google](./docs/google.md#list-of-supported-resources-and-attributes)
* [AzureRM](./docs/azurerm.md#list-of-supported-resources-and-attributes)
### Google Credentials
To be able to ingest the pricing data from Google the credentials needed have to have access to [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com) and have also billing enabled. This is needed to be able to fetch the Machine Types, for the SKUs we would only need an normal set of credentials (or even API Key) but as we need both we have to use the more complex one. If you do not know how to activate those permissions, just use the credentials and the import will fail and on the logs will inform of what is missing and how to activate it.
## Usage
### Migrating the database
```go
db, err := sql.Open("mysql", "root:password@tcp(IP:3306)/databasename?multiStatements=true")
// Can be called on every start of your program, it does nothing if the migrations
// have been executed already.
err = mysql.Migrate(context.Background(), db, "pricing_migrations")
```
### Ingesting pricing data
```go
db, err := sql.Open("mysql", "root:password@tcp(IP:3306)/databasename?multiStatements=true")
backend := mysql.NewBackend(db)
// service can be "AmazonEC2" or "AmazonRDS"
// region is any AWS region, e.g. "us-east-1" or "eu-west-3"
ingester, err := aws.NewIngester(service, region)
err = terracost.IngestPricing(context.Background(), backend, ingester)
```
### Tracking ingestion progress
We're using the `github.com/machinebox/progress` library for tracking ingestion progress.
1. Create a channel that will receive progress updates and set up a goroutine (it will print the bytes ingested out of bytes total and remaining time each time progress update is sent on the channel):
```go
progressCh := make(chan progress.Progress, 0)
go func() {
for p := range progressCh {
// Check the docs for all available methods: https://pkg.go.dev/github.com/machinebox/progress#Progress
fmt.Printf("%d / %d (%s remaining)\n", p.N(), p.Size(), p.Remaining().String())
}
}()
```
2. Initialize an ingester capable of tracking progress (in this example the channel will receive an update every 5 seconds):
```go
ingester, err := aws.NewIngester(service, region, aws.WithProgress(progressCh, 5*time.Second))
```
3. Use the ingester as in the previous section.
### Estimating a Terraform plan
Plan estimation is possible after all the relevant pricing data have been ingested and stored in the
database.
1. Generate a plan using `terraform` and convert it to JSON:
```shell
terraform plan -out update.tfplan
terraform show -json update.tfplan > tfplan.json
```
2. Read the plan file, estimate it and show the resource differences:
```go
db, err := db.Open("mysql", "...")
backend := mysql.NewBackend(db)
file, err := os.Open("path/to/tfplan.json")
plan, err := terracost.EstimateTerraformPlan(context.Background(), backend, file)
for _, res := range plan.ResourceDifferences() {
priorCost, err := res.PriorCost()
plannedCost, err := res.PlannedCost()
fmt.Printf("%s: %s -> %s\n", res.Address, priorCost, plannedCost)
}
```
Check the documentation for all available fields.
### Usage estimation
Some resources do cannot be estimated just by the configuration and need some extra usage information, for that we have some default on `usage/usage.go` which are also all the resources and options we support currently and can be overwritten when estimating if passing a custom one instead of the custom Default one.
## Examples
For more examples, please check [examples](examples/README.md).
## Contributing
For Contributing Guide, please read [CONTIBUTING.md](CONTRIBUTING.md).
## License
This project is licensed under the MIT license. Please see [LICENSE](LICENSE) for more details.
## Meet Cycloid
[Cycloid](https://www.cycloid.io/) is a hybrid cloud DevOps collaboration platform providing end-to-end frameworks to accelerate and industrialize software delivery.
As of now, we have three open-source tools:
* [TerraCognita](https://github.com/cycloidio/terracognita): Read from your existing cloud providers and generate IaC in Terraform
* [InfraMap](https://github.com/cycloidio/inframap): Reads .tfstate or HCL to generate a graph specific for each provider
* [TerraCost](https://github.com/cycloidio/terracost): Cloud cost estimation for Terraform in the CLI
...and the functionality of each is also embedded in our DevOps solution, which you can find out more about [here](https://www.cycloid.io/hybrid-cloud-devops-platform).