cycloidio / terracost

Cloud cost estimation for Terraform in your CLI
MIT License
286 stars 30 forks source link

Docs: Added docs for all supported providers #65

Closed xescugc closed 2 years ago

xescugc commented 2 years ago

On how to add new resources and what do they it need.

xescugc commented 2 years ago

Pushed with more docs, now on more general terms.

ChamMach commented 2 years ago

Good documentation to get started ! 🔥

However, I find that the most "variable" phase (for the moment) is the search for "cost factors" fields for the resources you want to add.

So, I think I have a more "safe" solution (for AWS) by combining :

  1. This file (or service-related metadata and their appearance as columns in AWS Cost and Usage Reports)
  2. The pricing data of the resource in CSV
  3. The AWS Pricing Calculator

For example with #67 :

image

I put in red in the first document (and by filtering on the targeted resource : here SNS) the fields that I also found in the second document (the pricing data of the SNS resource).

And, with a good reading of what is requested by the pricing calculator for this resource, I could more or less easily find the "cost factors" fields to add. As you can see on the PR I didn't add all the fields in red, some were already presents, others were less "relevant" in my opinion (like the description field)

Finally, this page can help too. So, maybe add a mention of these links to the documentation? 🤔

After interacting with @talset, I think it would also be relevant to say that what we're interested in (for now) is the upfront costs of setting up and running resources created by Terraform for 30 days. And that, for resources like SNS where the cost is totally calculated in relation to the use of the resource, it's difficult for us to indicate an estimate.

Except maybe by including some default values. For example for SNS: 1 million notifications outside the Free Tier. But for this service, 1 million HTTPs and mobile notifications have a different price. So I'll have to filter by "endpoint type" I guess

Finally, indicating that the estimate is a "minimum" and will not be 100% representative of the reality at the end of the month would also be a good thing IMO

xescugc commented 2 years ago

Added the recommended links and fixes.

xescugc commented 2 years ago

Done