peterdavehello / infracost Goto Github PK

Infracost shows cloud cost estimates for infrastructure-as-code projects such as Terraform. It helps DevOps, SRE and developers to quickly see a cost breakdown and compare different options upfront.

Show full breakdown of costs

Show diff of monthly costs between current and planned state

Installation

1. Assuming Terraform is already installed, get the latest Infracost release:

   macOS Homebrew:

   brew install infracost

   Linux/macOS manual download:

   # Downloads the CLI based on your OS/arch and puts it in /usr/local/bin
   curl -fsSL https://raw.githubusercontent.com/infracost/infracost/master/scripts/install.sh | sh

   Docker and Windows users see here.

2. Register for a free API key:

   infracost register

   The key is saved in ~/.config/infracost/credentials.yml.

3. Run Infracost using our example Terraform project to see how it works:

   git clone https://github.com/infracost/example-terraform.git
   cd example-terraform/sample1
   
   # Play with main.tf and re-run to compare costs
   infracost breakdown --path .
   
   # Show diff of monthly costs, edit the yml file and re-run to compare costs
   infracost diff --path . --sync-usage-file --usage-file infracost-usage.yml

Please watch/star this repo as we add new cloud resources every week or so.

Usage

The infracost CLI has the following main commands, their usage is described in our short getting started page:

• breakdown: show full breakdown of costs
• diff: show diff of monthly costs between current and planned state

As mentioned in our FAQ, no cloud credentials, secrets, tags or resource identifiers are sent to the Cloud Pricing API. That API does not become aware of your cloud spend; it simply returns cloud prices to the CLI so calculations can be done on your machine. Infracost does not make any changes to your Terraform state or cloud resources.

CI/CD integrations

The following CI/CD integrations can be used to automatically add a pull request comment showing the diff of monthly costs between the current and planned state:

• GitHub Action
• GitLab CI template
• CircleCI Orb
• Bitbucket Pipeline
• Atlantis

If you run into any issues with CI/CD integrations, please join our community Slack channel, we'd be happy to guide you through it.

Supported clouds and resources

Infracost supports over 100 AWS and Google resources; Microsoft Azure is coming soon. Other IaC tools (Pulumi, CloudFormation) are on our roadmap too.

We regularly add support for new resources so we recommend watching this repo for releases: click on the Watch button > selecting Custom > Releases and click on Apply.

See this page for details on cost estimation of usage-based resources such as AWS Lambda or Google Cloud Storage.

Contributing

Issues and pull requests are welcome! For development details, see the contributing guide. For major changes, please open an issue first to discuss what you would like to change.

Join our community Slack channel, we are a friendly bunch and happy to help you get started :)

License

Apache License 2.0