Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudnationhq/terraform-azure-costs

Terraform module which creates cost management resources used by workloads and accelerators.
https://github.com/cloudnationhq/terraform-azure-costs

azure terraform wam

Last synced: 20 days ago
JSON representation

Terraform module which creates cost management resources used by workloads and accelerators.

Awesome Lists containing this project

README 

        
# Costs Module



This terraform module streamlines the creation of multiple resources related to consumption and costs.



## Goals



The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.



The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.



A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.



A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.



## Non-Goals



These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.



They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.



Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.



End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.



## Features



- Create consumption alerts on Management groups

- Create consumption alerts on Subscriptions

- Create consumption alerts Resource Groups

- Create costs anomaly alerts



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.9.3 |

|  [azurerm](#requirement\_azurerm) | ~> 4.0 |



## Providers



| Name | Version |

|------|---------|

|  [azurerm](#provider\_azurerm) | ~> 4.0 |



## Resources



| Name | Type |

|------|------|

| [azurerm_consumption_budget_management_group.budget](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/consumption_budget_management_group) | resource |

| [azurerm_consumption_budget_resource_group.budget](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/consumption_budget_resource_group) | resource |

| [azurerm_consumption_budget_subscription.budget](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/consumption_budget_subscription) | resource |

| [azurerm_cost_anomaly_alert.caa](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cost_anomaly_alert) | resource |

| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [config](#input\_config) | alert related configuration | `any` | n/a | yes |



## Outputs



| Name | Description |

|------|-------------|

|  [consumption\_budget\_management\_group](#output\_consumption\_budget\_management\_group) | contains all consumption budget management group configuration |

|  [consumption\_budget\_resource\_group](#output\_consumption\_budget\_resource\_group) | contains all consumption budget resource group configuration |

|  [consumption\_budget\_subscription](#output\_consumption\_budget\_subscription) | contains all consumption budget subscription configuration |

|  [cost\_anomaly\_alert](#output\_cost\_anomaly\_alert) | contains all cost anomaly alert configuration |



## Testing



Ensure go and terraform are installed.



Run tests for different usage scenarios by specifying the EXAMPLE environment variable. Usage examples are in the examples directory.



To execute a test, run `make test EXAMPLE=default`



Replace default with the specific example you want to test. These tests ensure the module performs reliably across various configurations.



## Notes



Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes.



Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory.



To update the module's documentation run `make doc`



## Authors



Module is maintained by [these awesome contributors](https://github.com/cloudnationhq/terraform-azure-costs/graphs/contributors).



## Contributing



We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.



For more information, please see our contribution [guidelines](./CONTRIBUTING.md).



## License



MIT Licensed. See [LICENSE](https://github.com/cloudnationhq/terraform-azure-costs/blob/main/LICENSE) for full details.



## References



- [Documentation](https://learn.microsoft.com/en-us/azure/cost-management-billing/costs/)