diff --git a/infrastructure/modules/cloudwatch/README.md b/infrastructure/modules/cloudwatch/README.md new file mode 100644 index 00000000..eb529fd5 --- /dev/null +++ b/infrastructure/modules/cloudwatch/README.md @@ -0,0 +1,78 @@ +# CloudWatch + +NHS Screening wrapper around selected submodules from +[terraform-aws-modules/cloudwatch/aws](https://registry.terraform.io/modules/terraform-aws-modules/cloudwatch/aws/latest) +that provides a single module entry point for common CloudWatch log and alarm building blocks. + +## Included submodules + +- `log-group` +- `log-stream` +- `log-metric-filter` +- `metric-alarm` +- `metric-alarms-by-multiple-dimensions` + +## What this module enforces + +| Control | How it is enforced | +| ------- | ------------------ | +| Single entry point | One shared wrapper exposes the requested CloudWatch submodules together | +| Creation gate | Each submodule is gated by `module.this.enabled` and a non-null config object | +| Naming | Names are derived from `module.this.id` | +| Tagging | Log groups and alarms that support tags receive `module.this.tags` | +| Minimal interface | Only the minimal required or functionally necessary configuration is exposed | + +## Usage + +### Complete example + +```hcl +module "cloudwatch" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/cloudwatch?ref=main" + + service = "bcss" + project = "shared-resources" + environment = "prod" + stack = "monitoring" + name = "application" + + log_group = {} + + log_stream = {} + + log_metric_filter = { + pattern = "ERROR" + metric_transformation_name = "ErrorCount" + metric_transformation_namespace = "BCSS/Application" + } + + metric_alarm = { + comparison_operator = "GreaterThanOrEqualToThreshold" + evaluation_periods = 1 + threshold = 10 + } + + metric_alarms_by_multiple_dimensions = { + comparison_operator = "GreaterThanOrEqualToThreshold" + evaluation_periods = 1 + threshold = 10 + dimensions = { + lambda1 = { + FunctionName = "function-one" + } + lambda2 = { + FunctionName = "function-two" + } + } + } +} +``` + +## Conventions + +- Set a submodule object to `null` to skip creating that submodule. +- `log_stream` and `log_metric_filter` depend on `log_group` being configured in the same module call. +- `metric_alarm` and `metric_alarms_by_multiple_dimensions` derive their metric name and namespace from `log_metric_filter`. +- `metric_alarm` uses fixed defaults of `period = "60"` and `statistic = "Sum"`. +- `metric_alarms_by_multiple_dimensions` uses fixed defaults of `period = "60"` and `statistic = "Sum"`. +- CloudWatch log streams and log metric filters do not support tags directly, so only the submodules that accept tags receive `module.this.tags`. \ No newline at end of file diff --git a/infrastructure/modules/cloudwatch/context.tf b/infrastructure/modules/cloudwatch/context.tf new file mode 100644 index 00000000..62befcb0 --- /dev/null +++ b/infrastructure/modules/cloudwatch/context.tf @@ -0,0 +1,376 @@ +# tflint-ignore-file: terraform_standard_module_structure, terraform_unused_declarations +# +# ONLY EDIT THIS FILE IN github.com/NHSDigital/screening-terraform-modules-aws/infrastructure/modules/tags +# All other instances of this file should be a copy of that one +# +# +# Copy this file from https://github.com/NHSDigital/screening-terraform-modules-aws/blob/master/infrastructure/modules/tags/exports/context.tf +# and then place it in your Terraform module to automatically get +# tag module standard configuration inputs suitable for passing +# to other modules. +# +# curl -sL https://raw.githubusercontent.com/NHSDigital/screening-terraform-modules-aws/master/infrastructure/modules/tags/exports/context.tf -o context.tf +# +# Modules should access the whole context as `module.this.context` +# to get the input variables with nulls for defaults, +# for example `context = module.this.context`, +# and access individual variables as `module.this.`, +# with final values filled in. +# +# For example, when using defaults, `module.this.context.delimiter` +# will be null, and `module.this.delimiter` will be `-` (hyphen). +# + +module "this" { + source = "../tags" + + enabled = var.enabled + service = var.service + project = var.project + region = var.region + environment = var.environment + stack = var.stack + workspace = var.workspace + name = var.name + delimiter = var.delimiter + attributes = var.attributes + tags = var.tags + additional_tag_map = var.additional_tag_map + label_order = var.label_order + regex_replace_chars = var.regex_replace_chars + id_length_limit = var.id_length_limit + label_key_case = var.label_key_case + label_value_case = var.label_value_case + terraform_source = coalesce(var.terraform_source, path.module) + descriptor_formats = var.descriptor_formats + labels_as_tags = var.labels_as_tags + + context = var.context +} + +# Copy contents of screening-terraform-modules-aws/tags/variables.tf here +# tflint-ignore: terraform_unused_declarations +variable "aws_region" { + type = string + description = "The AWS region" + default = "eu-west-2" + validation { + condition = contains(["eu-west-1", "eu-west-2", "us-east-1"], var.aws_region) + error_message = "AWS Region must be one of eu-west-1, eu-west-2, us-east-1" + } +} + +variable "context" { + type = any + default = { + enabled = true + service = null + project = null + region = null + environment = null + stack = null + workspace = null + name = null + delimiter = null + attributes = [] + tags = {} + additional_tag_map = {} + regex_replace_chars = null + label_order = [] + id_length_limit = null + label_key_case = null + label_value_case = null + terraform_source = null + descriptor_formats = {} + # Note: we have to use [] instead of null for unset lists due to + # https://github.com/hashicorp/terraform/issues/28137 + # which was not fixed until Terraform 1.0.0, + # but we want the default to be all the labels in `label_order` + # and we want users to be able to prevent all tag generation + # by setting `labels_as_tags` to `[]`, so we need + # a different sentinel to indicate "default" + labels_as_tags = ["unset"] + } + description = <<-EOT + Single object for setting entire context at once. + See description of individual variables for details. + Leave string and numeric variables as `null` to use default value. + Individual variable settings (non-null) override settings in context object, + except for attributes, tags, and additional_tag_map, which are merged. + EOT + + validation { + condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`." + } + + validation { + condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "terraform_source" { + type = string + default = null + description = "Source location to record in the Terraform_source tag. Defaults to this module path." +} + +variable "enabled" { + type = bool + default = null + description = "Set to false to prevent the module from creating any resources" +} + +variable "service" { + type = string + default = null + description = "ID element. Usually an abbreviation of your service directorate name, e.g. 'bcss' or 'csms', to help ensure generated IDs are globally unique" +} + +variable "region" { + type = string + default = null + description = "ID element _(Rarely used, not included by default)_. Usually an abbreviation of the selected AWS region e.g. 'uw2', 'ew2' or 'gbl' for resources like IAM roles that have no region" +} + +variable "project" { + type = string + default = null + description = "ID element. A project identifier, indicating the name or role of the project the resource is for, such as `website` or `api`" +} +variable "stack" { + type = string + default = null + description = "ID element. The name of the stack/component, e.g. `database`, `web`, `waf`, `eks`" +} +variable "workspace" { + type = string + default = null + description = "ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces" +} +variable "environment" { + type = string + default = null + description = "ID element. Usually used to indicate role, e.g. 'prd', 'dev', 'test', 'preprod', 'prod', 'uat'" +} + +variable "name" { + type = string + default = null + description = <<-EOT + ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. + This is the only ID element not also included as a `tag`. + The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. + EOT +} + +variable "delimiter" { + type = string + default = null + description = <<-EOT + Delimiter to be used between ID elements. + Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. + EOT +} + +variable "attributes" { + type = list(string) + default = [] + description = <<-EOT + ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, + in the order they appear in the list. New attributes are appended to the + end of the list. The elements of the list are joined by the `delimiter` + and treated as a single ID element. + EOT +} + +variable "labels_as_tags" { + type = set(string) + default = ["default"] + description = <<-EOT + Set of labels (ID elements) to include as tags in the `tags` output. + Default is to include all labels. + Tags with empty values will not be included in the `tags` output. + Set to `[]` to suppress all generated tags. + **Notes:** + The value of the `name` tag, if included, will be the `id`, not the `name`. + Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be + changed in later chained modules. Attempts to change it will be silently ignored. + EOT +} + +variable "tags" { + type = map(string) + default = {} + description = <<-EOT + Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). + Neither the tag keys nor the tag values will be modified by this module. + EOT +} + +variable "additional_tag_map" { + type = map(string) + default = {} + description = <<-EOT + Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. + This is for some rare cases where resources want additional configuration of tags + and therefore take a list of maps with tag key, value, and additional configuration. + EOT +} + +variable "label_order" { + type = list(string) + default = null + description = <<-EOT + The order in which the labels (ID elements) appear in the `id`. + Defaults to ["namespace", "environment", "stage", "name", "attributes"]. + You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. + EOT +} + +variable "regex_replace_chars" { + type = string + default = null + description = <<-EOT + Terraform regular expression (regex) string. + Characters matching the regex will be removed from the ID elements. + If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. + EOT +} + +variable "id_length_limit" { + type = number + default = null + description = <<-EOT + Limit `id` to this many characters (minimum 6). + Set to `0` for unlimited length. + Set to `null` for keep the existing setting, which defaults to `0`. + Does not affect `id_full`. + EOT + validation { + condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0 + error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length." + } +} + +variable "label_key_case" { + type = string + default = null + description = <<-EOT + Controls the letter case of the `tags` keys (label names) for tags generated by this module. + Does not affect keys of tags passed in via the `tags` input. + Possible values: `lower`, `title`, `upper`. + Default value: `title`. + EOT + + validation { + condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case) + error_message = "Allowed values: `lower`, `title`, `upper`." + } +} + +variable "label_value_case" { + type = string + default = null + description = <<-EOT + Controls the letter case of ID elements (labels) as included in `id`, + set as tag values, and output by this module individually. + Does not affect values of tags passed in via the `tags` input. + Possible values: `lower`, `title`, `upper` and `none` (no transformation). + Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. + Default value: `lower`. + EOT + + validation { + condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "descriptor_formats" { + type = any + default = {} + description = <<-EOT + Describe additional descriptors to be output in the `descriptors` output map. + Map of maps. Keys are names of descriptors. Values are maps of the form + `{ + format = string + labels = list(string) + }` + (Type is `any` so the map values can later be enhanced to provide additional options.) + `format` is a Terraform format string to be passed to the `format()` function. + `labels` is a list of labels, in order, to pass to `format()` function. + Label values will be normalized before being passed to `format()` so they will be + identical to how they appear in `id`. + Default is `{}` (`descriptors` output will be empty). + EOT +} + +variable "owner" { + type = string + description = "The name and or NHS.net email address of the service owner" + default = "None" +} + +variable "tag_version" { + type = string + description = "Used to identify the tagging version in use" + default = "1.0" +} + +variable "data_classification" { + type = string + description = "Used to identify the data classification of the resource, e.g 1-5" + default = "n/a" + validation { + condition = contains(["n/a", "1", "2", "3", "4", "5"], var.data_classification) + error_message = "Data Classification must be \"n/a\" or between 1-5" + } +} + +variable "data_type" { + type = string + description = "The tag data_type" + default = "None" + validation { + condition = contains(["None", "PCD", "PID", "Anonymised", "UserAccount", "Audit"], var.data_type) + error_message = "Data Type must be one of None, PCD, PID, Anonymised, UserAccount, Audit" + } +} + + +variable "public_facing" { + type = bool + description = "Whether this resource is public facing" + default = false +} + +variable "service_category" { + type = string + description = "The tag service_category" + default = "n/a" + validation { + condition = contains(["n/a", "Bronze", "Silver", "Gold", "Platinum"], var.service_category) + error_message = "The Service Category must be one of n/a, Bronze, Silver, Gold, Platinum" + } +} +variable "on_off_pattern" { + type = string + description = "Used to turn resources on and off based on a time pattern" + default = "n/a" +} + +variable "application_role" { + type = string + description = "The role the application is performing" + default = "General" +} + +variable "tool" { + type = string + description = "The tool used to deploy the resource" + default = "Terraform" +} + +#### End of copy of screening-terraform-modules-aws/tags/variables.tf diff --git a/infrastructure/modules/cloudwatch/locals.tf b/infrastructure/modules/cloudwatch/locals.tf new file mode 100644 index 00000000..f84124ef --- /dev/null +++ b/infrastructure/modules/cloudwatch/locals.tf @@ -0,0 +1,27 @@ +locals { + log_group_name = module.this.id + + log_stream_name = format("%s-stream", module.this.id) + + log_metric_filter_name = format("%s-metric-filter", module.this.id) + + metric_alarm_name = format("%s-alarm", module.this.id) + + metric_alarms_by_multiple_dimensions_name = format("%s-dimension-alarm", module.this.id) +} + +locals { + created_log_group_name = length(trimspace(try(module.log_group.cloudwatch_log_group_name, ""))) > 0 ? module.log_group.cloudwatch_log_group_name : null + + log_stream_log_group_name = local.created_log_group_name + + log_metric_filter_log_group_name = local.created_log_group_name + + metric_alarm_metric_name = try(var.log_metric_filter.metric_transformation_name, null) + + metric_alarm_namespace = try(var.log_metric_filter.metric_transformation_namespace, null) + + metric_alarms_by_multiple_dimensions_metric_name = try(var.log_metric_filter.metric_transformation_name, null) + + metric_alarms_by_multiple_dimensions_namespace = try(var.log_metric_filter.metric_transformation_namespace, null) +} \ No newline at end of file diff --git a/infrastructure/modules/cloudwatch/main.tf b/infrastructure/modules/cloudwatch/main.tf new file mode 100644 index 00000000..d9ea95b1 --- /dev/null +++ b/infrastructure/modules/cloudwatch/main.tf @@ -0,0 +1,117 @@ +################################################################ +# CloudWatch +# +# Thin NHS wrapper around the community CloudWatch submodules that +# provides a single entry point for the most common log and alarm +# building blocks used by screening teams: +# +# * log-group +# * log-stream +# * log-metric-filter +# * metric-alarm +# * metric-alarms-by-multiple-dimensions +# +# Naming and tagging are derived from context.tf via module.this. +################################################################ + +module "log_group" { + source = "terraform-aws-modules/cloudwatch/aws//modules/log-group" + version = "5.7.2" + + create = module.this.enabled && var.log_group != null + + name = local.log_group_name + + tags = module.this.tags +} + +module "log_stream" { + source = "terraform-aws-modules/cloudwatch/aws//modules/log-stream" + version = "5.7.2" + + create = module.this.enabled && var.log_stream != null + + name = local.log_stream_name + log_group_name = local.log_stream_log_group_name +} + +module "log_metric_filter" { + source = "terraform-aws-modules/cloudwatch/aws//modules/log-metric-filter" + version = "5.7.2" + + create_cloudwatch_log_metric_filter = module.this.enabled && var.log_metric_filter != null + + name = local.log_metric_filter_name + log_group_name = local.log_metric_filter_log_group_name + pattern = var.log_metric_filter.pattern + + metric_transformation_name = var.log_metric_filter.metric_transformation_name + metric_transformation_namespace = var.log_metric_filter.metric_transformation_namespace +} + +module "metric_alarm" { + source = "terraform-aws-modules/cloudwatch/aws//modules/metric-alarm" + version = "5.7.2" + + create_metric_alarm = module.this.enabled && var.metric_alarm != null + + alarm_name = local.metric_alarm_name + comparison_operator = var.metric_alarm.comparison_operator + evaluation_periods = var.metric_alarm.evaluation_periods + threshold = var.metric_alarm.threshold + + metric_name = local.metric_alarm_metric_name + namespace = local.metric_alarm_namespace + period = "60" + statistic = "Sum" + + tags = module.this.tags +} + +module "metric_alarms_by_multiple_dimensions" { + source = "terraform-aws-modules/cloudwatch/aws//modules/metric-alarms-by-multiple-dimensions" + version = "5.7.2" + + create_metric_alarm = module.this.enabled && var.metric_alarms_by_multiple_dimensions != null + + alarm_name = local.metric_alarms_by_multiple_dimensions_name + comparison_operator = var.metric_alarms_by_multiple_dimensions.comparison_operator + evaluation_periods = var.metric_alarms_by_multiple_dimensions.evaluation_periods + threshold = var.metric_alarms_by_multiple_dimensions.threshold + + metric_name = local.metric_alarms_by_multiple_dimensions_metric_name + namespace = local.metric_alarms_by_multiple_dimensions_namespace + period = "60" + statistic = "Sum" + dimensions = var.metric_alarms_by_multiple_dimensions.dimensions + + tags = module.this.tags +} + +check "log_stream_log_group_name" { + assert { + condition = var.log_stream == null || var.log_group != null + error_message = "log_stream requires log_group to be configured in the same module call." + } +} + +check "log_metric_filter_log_group_name" { + assert { + condition = var.log_metric_filter == null || var.log_group != null + error_message = "log_metric_filter requires log_group to be configured in the same module call." + } +} + +check "metric_alarm_metric_identity" { + assert { + condition = var.metric_alarm == null || (local.metric_alarm_metric_name != null && local.metric_alarm_namespace != null) + error_message = "metric_alarm requires metric_name and namespace, either directly on metric_alarm or indirectly from log_metric_filter." + } +} + +check "metric_alarms_by_multiple_dimensions_metric_identity" { + assert { + condition = var.metric_alarms_by_multiple_dimensions == null || (local.metric_alarms_by_multiple_dimensions_metric_name != null && local.metric_alarms_by_multiple_dimensions_namespace != null) + error_message = "metric_alarms_by_multiple_dimensions requires metric_name and namespace, either directly on metric_alarms_by_multiple_dimensions or indirectly from log_metric_filter." + } +} \ No newline at end of file diff --git a/infrastructure/modules/cloudwatch/outputs.tf b/infrastructure/modules/cloudwatch/outputs.tf new file mode 100644 index 00000000..b022b4c9 --- /dev/null +++ b/infrastructure/modules/cloudwatch/outputs.tf @@ -0,0 +1,44 @@ +output "cloudwatch_log_group_name" { + description = "Name of the CloudWatch log group, if created." + value = module.log_group.cloudwatch_log_group_name +} + +output "cloudwatch_log_group_arn" { + description = "ARN of the CloudWatch log group, if created." + value = module.log_group.cloudwatch_log_group_arn +} + +output "cloudwatch_log_stream_name" { + description = "Name of the CloudWatch log stream, if created." + value = module.log_stream.cloudwatch_log_stream_name +} + +output "cloudwatch_log_stream_arn" { + description = "ARN of the CloudWatch log stream, if created." + value = module.log_stream.cloudwatch_log_stream_arn +} + +output "cloudwatch_log_metric_filter_id" { + description = "The name of the CloudWatch log metric filter, if created." + value = module.log_metric_filter.cloudwatch_log_metric_filter_id +} + +output "cloudwatch_metric_alarm_id" { + description = "The ID of the CloudWatch metric alarm, if created." + value = module.metric_alarm.cloudwatch_metric_alarm_id +} + +output "cloudwatch_metric_alarm_arn" { + description = "The ARN of the CloudWatch metric alarm, if created." + value = module.metric_alarm.cloudwatch_metric_alarm_arn +} + +output "cloudwatch_metric_alarm_ids" { + description = "Map of CloudWatch metric alarm IDs created by the multiple-dimensions submodule, if configured." + value = module.metric_alarms_by_multiple_dimensions.cloudwatch_metric_alarm_ids +} + +output "cloudwatch_metric_alarm_arns" { + description = "Map of CloudWatch metric alarm ARNs created by the multiple-dimensions submodule, if configured." + value = module.metric_alarms_by_multiple_dimensions.cloudwatch_metric_alarm_arns +} \ No newline at end of file diff --git a/infrastructure/modules/cloudwatch/variables.tf b/infrastructure/modules/cloudwatch/variables.tf new file mode 100644 index 00000000..4ff1c4f4 --- /dev/null +++ b/infrastructure/modules/cloudwatch/variables.tf @@ -0,0 +1,49 @@ +################################################################ +# CloudWatch submodule inputs. +# +# Naming, tagging and the master `enabled` switch come from +# context.tf via `module.this`. +################################################################ + +variable "log_group" { + description = "Configuration for the CloudWatch log group submodule. Set to null to skip creating a log group." + type = object({}) + default = null +} + +variable "log_stream" { + description = "Configuration for the CloudWatch log stream submodule. Set to null to skip creating a log stream." + type = object({}) + default = null +} + +variable "log_metric_filter" { + description = "Configuration for the CloudWatch log metric filter submodule. Set to null to skip creating a log metric filter." + type = object({ + pattern = string + metric_transformation_name = string + metric_transformation_namespace = string + }) + default = null +} + +variable "metric_alarm" { + description = "Configuration for the CloudWatch metric alarm submodule. Set to null to skip creating a metric alarm." + type = object({ + comparison_operator = string + evaluation_periods = number + threshold = number + }) + default = null +} + +variable "metric_alarms_by_multiple_dimensions" { + description = "Configuration for the CloudWatch metric alarms by multiple dimensions submodule. Set to null to skip creating these alarms." + type = object({ + comparison_operator = string + evaluation_periods = number + threshold = number + dimensions = map(map(string)) + }) + default = null +} \ No newline at end of file diff --git a/infrastructure/modules/cloudwatch/versions.tf b/infrastructure/modules/cloudwatch/versions.tf new file mode 100644 index 00000000..d6b7d5f0 --- /dev/null +++ b/infrastructure/modules/cloudwatch/versions.tf @@ -0,0 +1,10 @@ +terraform { + required_version = ">= 1.13" + + required_providers { + aws = { + source = "hashicorp/aws" + version = ">= 6.42" + } + } +} \ No newline at end of file