Planetfm/cost reporting

terraform/environments/planetfm/ec2-common.tf

@@ -67,7 +67,7 @@ resource "aws_ssm_document" "remove_local_users_windows" {
     },
   )
 }
-  
+
 resource "aws_ssm_document" "network-testing-tools" {
   name            = "network-testing-tools"
   document_type   = "Command"

terraform/environments/planetfm/locals_development.tf

@@ -4,5 +4,10 @@ locals {
   # baseline config
   development_config = {
 
+    # example code for creating a cost usage report in the development environment
+    # 
+    # baseline_cost_usage_report = {
+    #   create = true
+    # }
   }
 }

terraform/environments/planetfm/main.tf

@@ -132,4 +132,8 @@ module "baseline" {
     local.baseline_ssm_parameters,
     lookup(local.baseline_environment_config, "baseline_ssm_parameters", {}),
   )
+
+  # example code for creating a cost usage report - locals_development.tf
+  cost_usage_report = lookup(local.baseline_environment_config, "baseline_cost_usage_report", { create = false })
+
 }

terraform/modules/baseline/cost_usage_report.tf

@@ -0,0 +1,17 @@
+module "cost_usage_report" {
+
+    count = lookup(var.cost_usage_report, "create", false) ? 1 : 0
+
+    source = "../../modules/cost_usage_report"
+
+    providers = {
+        aws.us-east-1             = aws.us-east-1
+        aws.bucket-replication    = aws
+    }
+
+    application_name = var.environment.application_name
+    account_number   = var.environment.account_id
+    environment      = var.environment.environment
+    tags = local.tags
+
+}

terraform/modules/baseline/outputs.tf

@@ -127,4 +127,4 @@ output "ssm_parameters" {
     aws_ssm_parameter.fixed,
     aws_ssm_parameter.placeholder
   )
-}
+}

terraform/modules/baseline/variables.tf

@@ -1021,3 +1021,13 @@ variable "resource_explorer" {
   type        = bool
   default     = false
 }
+
+variable "cost_usage_report" {
+  description = "Enables AWS Cost Usage Report"
+  type        = object({
+    create = bool
+  })  
+  default     = {
+    create = false
+  }
+}

terraform/modules/cost_usage_report/README.md

@@ -0,0 +1,45 @@
+Enable Cost Usage Reports on a 'per-environment' basis.
+
+## Usage
+
+For example:
+
+```
+module "cost_usage_report" {
+
+    count = lookup(var.cost_usage_report, "create", false) ? 1 : 0
+
+    source = "../../modules/cost_usage_report"
+
+    providers = {
+        aws.us-east-1             = aws.us-east-1
+        aws.bucket-replication    = aws
+    }
+
+    application_name = var.environment.application_name
+    account_number   = var.environment.account_id
+    environment      = var.environment.environment
+    tags = merge(local.tags)
+
+}
+```
+
+triggered by the following in the environment configuration file:
+
+```
+  cost_usage_report = {
+    create = true
+  }
+```
+
+This needs to be in each environment configuration file that you want a cost usage report for.
+
+Since each environment is in a different account there's no way to create a single cost usage report for all environments.
+
+## Maintenance
+
+The main challenge with this module is whether/when AWS decide to change their report schema and/or the report format.
+
+The module translates the planetfm-cost-usage-report-create-table.sql file into a terraform 'aws_glue_catalog_table' resource. This has been done manually and is not automated so if the schema changes then the terraform resource will need to be updated. This sql table file is created in the S3 bucket when the `aws_cur_report_definition` resource is created.
+
+This also performs a check to make sure that the s3 bucket is writable by the report definition. Any permission failures will be reported in the terraform plan.