generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
068bce8
commit 20e0720
Showing
1 changed file
with
213 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,213 @@ | ||
| # terraform-module-template | ||
| <!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> | ||
|
|
||
| <p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62349836-882fef80-b51e-11e9-99e3-7b974309c7e3.png" width="100" height="100"></p> | ||
|
|
||
|
|
||
| <h1 align="center"> | ||
| Terraform AWS cost billing alarm | ||
| </h1> | ||
|
|
||
| <p align="center" style="font-size: 1.2rem;"> | ||
| Terraform module to create aws cost billing alarm resource on AWS with sns topic. | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
|
|
||
| <a href="https://www.terraform.io"> | ||
| <img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform"> | ||
| </a> | ||
| <a href="LICENSE.md"> | ||
| <img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence"> | ||
| </a> | ||
| <a href="https://github.com/clouddrove/terraform-aws-cost-billing-alarm/actions/workflows/tfsec.yml"> | ||
| <img src="https://github.com/clouddrove/terraform-aws-cost-billing-alarm/actions/workflows/tfsec.yml/badge.svg" alt="tfsec"> | ||
| </a> | ||
| <a href="https://github.com/clouddrove/terraform-aws-cost-billing-alarm/actions/workflows/terraform.yml"> | ||
| <img src="https://github.com/clouddrove/terraform-aws-cost-billing-alarm/actions/workflows/terraform.yml/badge.svg" alt="static-checks"> | ||
| </a> | ||
|
|
||
|
|
||
| </p> | ||
| <p align="center"> | ||
|
|
||
| <a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-cost-billing-alarm'> | ||
| <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" /> | ||
| </a> | ||
| <a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+cost+billing+alarm&url=https://github.com/clouddrove/terraform-aws-cost-billing-alarm'> | ||
| <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" /> | ||
| </a> | ||
| <a href='https://twitter.com/intent/tweet/?text=Terraform+AWS+cost+billing+alarm&url=https://github.com/clouddrove/terraform-aws-cost-billing-alarm'> | ||
| <img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" /> | ||
| </a> | ||
|
|
||
| </p> | ||
| <hr> | ||
|
|
||
|
|
||
| We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure. | ||
|
|
||
| This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself. | ||
|
|
||
| We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| This module has a few dependencies: | ||
|
|
||
| - [Terraform 1.x.x](https://learn.hashicorp.com/terraform/getting-started/install.html) | ||
| - [Go](https://golang.org/doc/install) | ||
| - [github.com/stretchr/testify/assert](https://github.com/stretchr/testify) | ||
| - [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
|
|
||
| **IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-cost-billing-alarm/releases). | ||
|
|
||
|
|
||
| Here is examples of how you can use this module in your inventory structure: | ||
| ### cloudwatch-billing-alert-to-new-sns-consolidated-acct | ||
| ```hcl | ||
| module "billing_cloudwatch_alert" { | ||
| source = "clouddrove/terraform-aws-cost-billing-alarm/aws" | ||
| name = "billing/aws" | ||
| environment = "test" | ||
| label_order = ["name", "environment"] | ||
| monthly_billing_threshold = 10 | ||
| currency = "USD" | ||
| } | ||
| ``` | ||
|
|
||
| ### cloudwatch-billing-alert-to-new-sns-with-acct-id | ||
| ```hcl | ||
| module "billing_cloudwatch_alert" { | ||
| source = "clouddrove/terraform-aws-cost-billing-alarm/aws" | ||
| name = "billing/aws" | ||
| environment = "test" | ||
| label_order = ["name", "environment"] | ||
| aws_env = var.aws_profile | ||
| aws_account_id = 111111111111 | ||
| monthly_billing_threshold = 500 | ||
| currency = "USD" | ||
| } | ||
| ``` | ||
|
|
||
| ### cloudwatch-billing-alert-to-pre-existing-sns-consolidated-acct | ||
| ```hcl | ||
| module "billing_cloudwatch_alert" { | ||
| source = "clouddrove/terraform-aws-cost-billing-alarm/aws" | ||
| name = "billing/aws" | ||
| environment = "test" | ||
| label_order = ["name", "environment"] | ||
| aws_env = var.aws_profile | ||
| monthly_billing_threshold = 500 | ||
| currency = "USD" | ||
| aws_sns_topic_arn = ["arn:aws:lambda:us-east-1:111111111111:function:bb-root-org-notify_slack"] | ||
| } | ||
| ``` | ||
|
|
||
| ### cloudwatch-billing-alert-to-pre-existing-sns-with-acct-id | ||
| ```hcl | ||
| module "billing_cloudwatch_alert" { | ||
| source = "clouddrove/terraform-aws-cost-billing-alarm/aws" | ||
| name = "billing/aws" | ||
| environment = "test" | ||
| label_order = ["name", "environment"] | ||
| aws_account_id = 111111111111 | ||
| monthly_billing_threshold = 500 | ||
| currency = "USD" | ||
| aws_sns_topic_arn = ["arn:aws:lambda:us-east-1:111111111111:function:bb-root-org-notify_slack"] | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | application\_failure\_feedback\_role\_arn | IAM role for failure feedback. | `string` | `""` | no | | ||
| | application\_success\_feedback\_role\_arn | The IAM role permitted to receive success feedback for this topic. | `string` | `""` | no | | ||
| | application\_success\_feedback\_sample\_rate | Percentage of success to sample. | `number` | `100` | no | | ||
| | attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no | | ||
| | aws\_account\_id | AWS account id | `string` | `null` | no | | ||
| | currency | Short notation for currency type (e.g. USD, CAD, EUR) | `string` | `"USD"` | no | | ||
| | delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no | | ||
| | delivery\_policy | The SNS delivery policy. | `string` | `null` | no | | ||
| | display\_name | The display name for the SNS topic. | `string` | `""` | no | | ||
| | enable | Boolean indicating whether or not to create sns module. | `bool` | `"true"` | no | | ||
| | enable\_sns | Boolean indicating whether or not to create sns. | `bool` | `false` | no | | ||
| | enable\_topic | Boolean indicating whether or not to create topic. | `bool` | `false` | no | | ||
| | enabled | Set to false to prevent the module from creating any resources. | `bool` | `true` | no | | ||
| | environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | n/a | yes | | ||
| | http\_failure\_feedback\_role\_arn | IAM role for failure feedback. | `string` | `""` | no | | ||
| | http\_success\_feedback\_role\_arn | The IAM role permitted to receive success feedback for this topic. | `string` | `""` | no | | ||
| | http\_success\_feedback\_sample\_rate | Percentage of success to sample. | `number` | `100` | no | | ||
| | kms\_master\_key\_id | The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information. | `string` | `""` | no | | ||
| | label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no | | ||
| | lambda\_failure\_feedback\_role\_arn | IAM role for failure feedback. | `string` | `""` | no | | ||
| | lambda\_success\_feedback\_role\_arn | The IAM role permitted to receive success feedback for this topic. | `string` | `""` | no | | ||
| | lambda\_success\_feedback\_sample\_rate | Percentage of success to sample. | `number` | `100` | no | | ||
| | managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no | | ||
| | monthly\_billing\_threshold | The threshold for which estimated monthly charges will trigger the metric alarm. | `string` | n/a | yes | | ||
| | name | Name (e.g. `app` or `cluster`). | `string` | `"aws/billing"` | no | | ||
| | name\_prefix | Name (e.g. `app` or `cluster`). | `string` | `""` | no | | ||
| | policy | The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform. | `string` | `""` | no | | ||
| | repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-cost-billing-alarm/tree/aws-cost-billing-alarm"` | no | | ||
| | sns\_topic\_arns | List of SNS topic ARNs to be used. If `create_sns_topic` is `true`, it merges the created SNS Topic by this module with this list of ARNs | `list(string)` | `[]` | no | | ||
| | sqs\_failure\_feedback\_role\_arn | IAM role for failure feedback. | `string` | `""` | no | | ||
| | sqs\_success\_feedback\_role\_arn | The IAM role permitted to receive success feedback for this topic. | `string` | `""` | no | | ||
| | sqs\_success\_feedback\_sample\_rate | Percentage of success to sample. | `number` | `100` | no | | ||
| | tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no | | ||
| | topic\_name | The friendly name for the SNS topic. By default generated by Terraform. | `string` | `""` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | sns\_topic\_arns | List of SNS Topic ARNs to be subscribed to in order to delivery the clodwatch billing alarms | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Testing | ||
| In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. | ||
|
|
||
| You need to run the following command in the testing folder: | ||
| ```hcl | ||
| go test -run Test | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ## Feedback | ||
| If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-cost-billing-alarm/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com). | ||
|
|
||
| If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-cost-billing-alarm)! | ||
|
|
||
| ## About us | ||
|
|
||
| At [CloudDrove][website], we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering. | ||
|
|
||
| <p align="center">We are <b> The Cloud Experts!</b></p> | ||
| <hr /> | ||
| <p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://github.com/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p> | ||
|
|
||
| [website]: https://clouddrove.com | ||
| [github]: https://github.com/clouddrove | ||
| [linkedin]: https://cpco.io/linkedin | ||
| [twitter]: https://twitter.com/clouddrove/ | ||
| [email]: https://clouddrove.com/contact-us.html | ||
| [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language= |