diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index ed8d5c8..25377d7 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -40,6 +40,7 @@ updates: - "infrastructure/modules/aws-backup-destination" - "infrastructure/modules/aws-backup-source" - "infrastructure/modules/aws-scheduler" + - "infrastructure/modules/cloudwatch" - "infrastructure/modules/cognito" - "infrastructure/modules/cw-firehose-splunk" - "infrastructure/modules/ecr" diff --git a/README.md b/README.md index bc97b9f..2ee881f 100644 --- a/README.md +++ b/README.md @@ -298,6 +298,7 @@ Rules: ## Available modules + | Module | Wraps | Description | | --- | --- | --- | @@ -306,6 +307,7 @@ Rules: | `aws-backup-destination` | — | AWS Backup destination vault | | `aws-backup-source` | — | AWS Backup source configuration | | `aws-scheduler` | — | EventBridge Scheduler configuration | +| `cloudwatch` | terraform-aws-modules/cloudwatch/aws | CloudWatch log groups, streams, metric filters, and alarms | | `cognito` | — | Cognito user and identity pools | | `cw-firehose-splunk` | — | CloudWatch logs to Splunk via Firehose | | `ecr` | — | ECR repository with security controls | @@ -341,6 +343,7 @@ Rules: | `waf` | — | WAF web ACL with rules | + ## Pre-commit hooks diff --git a/infrastructure/modules/cloudwatch/.terraform.lock.hcl b/infrastructure/modules/cloudwatch/.terraform.lock.hcl new file mode 100644 index 0000000..82c6771 --- /dev/null +++ b/infrastructure/modules/cloudwatch/.terraform.lock.hcl @@ -0,0 +1,30 @@ +# This file is maintained automatically by "terraform init". +# Manual edits may be lost in future updates. + +provider "registry.terraform.io/hashicorp/aws" { + version = "6.52.0" + constraints = ">= 5.81.0, >= 6.14.0, >= 6.42.0" + hashes = [ + "h1:8m5zm0JaUac+YikXZoZDTV7R0iYL+q3IvTL4Ac8GfDA=", + "h1:Dg9X3Gde96OCT3TovLKAKumnR64VqIIQ37m/9NRJ00Y=", + "h1:F1r7mTJ289EBvU7Z7XAvWMHUt3VJ3zSFH8SUjLPFiqM=", + "h1:iXIFHX6zIvG0hoEi1fImeuHG9V4JOop6O6L6f+MOL2c=", + "h1:lpXqosKH8yAahK3SA1P5Pdy1ziXJcY+blUidY0q9yGk=", + "zh:1ab1d78f2336fed42b4e13fa0077a0be9d86a7899897cda5b9f1a60051ec2e93", + "zh:1df11f5f252030803939a1c778931dbdcee1b1070b38b98d9a8cbfc26c2aeb8e", + "zh:20ec9af03c0c1f2f8582a8805d43a4cd1a0a65082308e00f025d87605715a88f", + "zh:2d5562ed0e7cb0892fb537c7989d25fdde1d0ac1f3a768ba15fa087985f2a0f5", + "zh:40d64f668961a172355c3d11d258e19172ffafb421c40d89266b129ed8f92a5d", + "zh:497792bccc33001247473bc32a148c067982cb3d245b8f3610afb920635d2235", + "zh:8011f9167082af74ed9257582a83d54e889388656597721b2691797f1dd6fb58", + "zh:8b10d1bbca51b0da1e1be0967ce75b039f2d5d86f2ca7339994a92d35cdf47a8", + "zh:9549647dbf7c913512c26fed6badd7bf24a29a36c2bd308536849303a85427da", + "zh:97c4b726cdbe48166f4b9e6a1230312a7933dc19dd139d941ca6aca86706eb33", + "zh:9b12af85486a96aedd8d7984b0ff811a4b42e3d88dad1a3fb4c0b580d04fa425", + "zh:a484bc8166278b546bfe53698fa9e0a919dffe3bfda3c8bf8a0fc6811b5b9e66", + "zh:aa96e76bd9f93e5395a553fccec485554a74acae46b3834b1296374eba4f010f", + "zh:cf290ee3d0dfe91b596445f860440d9f18826f7395ff785f83f70d36cedadd1c", + "zh:d56b6a79207663673f66d9ed378d705c1bd1b4d117eeb5e2be3938cf1b75b7be", + "zh:febef068317f8e49bd438ccdf2f54345fc3bc4b80a2699d9ab3c449d7e521d8e", + ] +} diff --git a/infrastructure/modules/cloudwatch/README.md b/infrastructure/modules/cloudwatch/README.md new file mode 100644 index 0000000..8930199 --- /dev/null +++ b/infrastructure/modules/cloudwatch/README.md @@ -0,0 +1,165 @@ +# CloudWatch + +NHS Screening wrapper around selected submodules from the +[terraform-aws-modules CloudWatch module](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`. + + + + +## Requirements + +| Name | Version | +| ---- | ------- | +| [terraform](#requirement\_terraform) | >= 1.13 | +| [aws](#requirement\_aws) | >= 6.42 | + +## Providers + +No providers. + +## Modules + +| Name | Source | Version | +| ---- | ------ | ------- | +| [log\_group](#module\_log\_group) | terraform-aws-modules/cloudwatch/aws//modules/log-group | 5.7.2 | +| [log\_metric\_filter](#module\_log\_metric\_filter) | terraform-aws-modules/cloudwatch/aws//modules/log-metric-filter | 5.7.2 | +| [log\_stream](#module\_log\_stream) | terraform-aws-modules/cloudwatch/aws//modules/log-stream | 5.7.2 | +| [metric\_alarm](#module\_metric\_alarm) | terraform-aws-modules/cloudwatch/aws//modules/metric-alarm | 5.7.2 | +| [metric\_alarms\_by\_multiple\_dimensions](#module\_metric\_alarms\_by\_multiple\_dimensions) | terraform-aws-modules/cloudwatch/aws//modules/metric-alarms-by-multiple-dimensions | 5.7.2 | +| [this](#module\_this) | ../tags | n/a | + +## Resources + +No resources. + +## Inputs + +| Name | Description | Type | Default | Required | +| ---- | ----------- | ---- | ------- | :------: | +| [additional\_tag\_map](#input\_additional\_tag\_map) | 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. | `map(string)` | `{}` | no | +| [application\_role](#input\_application\_role) | The role the application is performing | `string` | `"General"` | no | +| [attributes](#input\_attributes) | 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. | `list(string)` | `[]` | no | +| [aws\_region](#input\_aws\_region) | The AWS region | `string` | `"eu-west-2"` | no | +| [context](#input\_context) | 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. | `any` | 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "project": null,
  "regex_replace_chars": null,
  "region": null,
  "service": null,
  "stack": null,
  "tags": {},
  "terraform_source": null,
  "workspace": null
}
| no | +| [data\_classification](#input\_data\_classification) | Used to identify the data classification of the resource, e.g 1-5 | `string` | `"n/a"` | no | +| [data\_type](#input\_data\_type) | The tag data\_type | `string` | `"None"` | no | +| [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no | +| [descriptor\_formats](#input\_descriptor\_formats) | 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). | `any` | `{}` | no | +| [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | +| [environment](#input\_environment) | ID element. Usually used to indicate role, e.g. 'prd', 'dev', 'test', 'preprod', 'prod', 'uat' | `string` | `null` | no | +| [id\_length\_limit](#input\_id\_length\_limit) | 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`. | `number` | `null` | no | +| [label\_key\_case](#input\_label\_key\_case) | 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`. | `string` | `null` | no | +| [label\_order](#input\_label\_order) | 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. | `list(string)` | `null` | no | +| [label\_value\_case](#input\_label\_value\_case) | 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`. | `string` | `null` | no | +| [labels\_as\_tags](#input\_labels\_as\_tags) | 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. | `set(string)` | 
[
  "default"
]
| no | +| [log\_group](#input\_log\_group) | Configuration for the CloudWatch log group submodule. Set to null to skip creating a log group. | `object({})` | `null` | no | +| [log\_metric\_filter](#input\_log\_metric\_filter) | Configuration for the CloudWatch log metric filter submodule. Set to null to skip creating a log metric filter. | 
object({
    pattern                         = string
    metric_transformation_name      = string
    metric_transformation_namespace = string
  })
| `null` | no | +| [log\_stream](#input\_log\_stream) | Configuration for the CloudWatch log stream submodule. Set to null to skip creating a log stream. | `object({})` | `null` | no | +| [metric\_alarm](#input\_metric\_alarm) | Configuration for the CloudWatch metric alarm submodule. Set to null to skip creating a metric alarm. | 
object({
    comparison_operator = string
    evaluation_periods  = number
    threshold           = number
  })
| `null` | no | +| [metric\_alarms\_by\_multiple\_dimensions](#input\_metric\_alarms\_by\_multiple\_dimensions) | Configuration for the CloudWatch metric alarms by multiple dimensions submodule. Set to null to skip creating these alarms. | 
object({
    comparison_operator = string
    evaluation_periods  = number
    threshold           = number
    dimensions          = map(map(string))
  })
| `null` | no | +| [name](#input\_name) | 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. | `string` | `null` | no | +| [on\_off\_pattern](#input\_on\_off\_pattern) | Used to turn resources on and off based on a time pattern | `string` | `"n/a"` | no | +| [owner](#input\_owner) | The name and or NHS.net email address of the service owner | `string` | `"None"` | no | +| [project](#input\_project) | ID element. A project identifier, indicating the name or role of the project the resource is for, such as `website` or `api` | `string` | `null` | no | +| [public\_facing](#input\_public\_facing) | Whether this resource is public facing | `bool` | `false` | no | +| [regex\_replace\_chars](#input\_regex\_replace\_chars) | 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. | `string` | `null` | no | +| [region](#input\_region) | 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 | `string` | `null` | no | +| [service](#input\_service) | ID element. Usually an abbreviation of your service directorate name, e.g. 'bcss' or 'csms', to help ensure generated IDs are globally unique | `string` | `null` | no | +| [service\_category](#input\_service\_category) | The tag service\_category | `string` | `"n/a"` | no | +| [stack](#input\_stack) | ID element. The name of the stack/component, e.g. `database`, `web`, `waf`, `eks` | `string` | `null` | no | +| [tag\_version](#input\_tag\_version) | Used to identify the tagging version in use | `string` | `"1.0"` | no | +| [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no | +| [terraform\_source](#input\_terraform\_source) | Source location to record in the Terraform\_source tag. Defaults to this module path. | `string` | `null` | no | +| [tool](#input\_tool) | The tool used to deploy the resource | `string` | `"Terraform"` | no | +| [workspace](#input\_workspace) | ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces | `string` | `null` | no | + +## Outputs + +| Name | Description | +| ---- | ----------- | +| [cloudwatch\_log\_group\_arn](#output\_cloudwatch\_log\_group\_arn) | ARN of the CloudWatch log group, if created. | +| [cloudwatch\_log\_group\_name](#output\_cloudwatch\_log\_group\_name) | Name of the CloudWatch log group, if created. | +| [cloudwatch\_log\_metric\_filter\_id](#output\_cloudwatch\_log\_metric\_filter\_id) | The name of the CloudWatch log metric filter, if created. | +| [cloudwatch\_log\_stream\_arn](#output\_cloudwatch\_log\_stream\_arn) | ARN of the CloudWatch log stream, if created. | +| [cloudwatch\_log\_stream\_name](#output\_cloudwatch\_log\_stream\_name) | Name of the CloudWatch log stream, if created. | +| [cloudwatch\_metric\_alarm\_arn](#output\_cloudwatch\_metric\_alarm\_arn) | The ARN of the CloudWatch metric alarm, if created. | +| [cloudwatch\_metric\_alarm\_arns](#output\_cloudwatch\_metric\_alarm\_arns) | Map of CloudWatch metric alarm ARNs created by the multiple-dimensions submodule, if configured. | +| [cloudwatch\_metric\_alarm\_id](#output\_cloudwatch\_metric\_alarm\_id) | The ID of the CloudWatch metric alarm, if created. | +| [cloudwatch\_metric\_alarm\_ids](#output\_cloudwatch\_metric\_alarm\_ids) | Map of CloudWatch metric alarm IDs created by the multiple-dimensions submodule, if configured. | + + + diff --git a/infrastructure/modules/cloudwatch/context.tf b/infrastructure/modules/cloudwatch/context.tf new file mode 100644 index 0000000..62befcb --- /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 0000000..bce2072 --- /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) +} diff --git a/infrastructure/modules/cloudwatch/main.tf b/infrastructure/modules/cloudwatch/main.tf new file mode 100644 index 0000000..71db305 --- /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." + } +} diff --git a/infrastructure/modules/cloudwatch/outputs.tf b/infrastructure/modules/cloudwatch/outputs.tf new file mode 100644 index 0000000..875cdba --- /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 +} diff --git a/infrastructure/modules/cloudwatch/variables.tf b/infrastructure/modules/cloudwatch/variables.tf new file mode 100644 index 0000000..f69cf4b --- /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 +} diff --git a/infrastructure/modules/cloudwatch/versions.tf b/infrastructure/modules/cloudwatch/versions.tf new file mode 100644 index 0000000..cb30fe5 --- /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" + } + } +} diff --git a/scripts/config/generate-available-modules.yaml b/scripts/config/generate-available-modules.yaml index 41e5b7b..5cd9f16 100644 --- a/scripts/config/generate-available-modules.yaml +++ b/scripts/config/generate-available-modules.yaml @@ -29,6 +29,10 @@ aws-scheduler: description: "EventBridge Scheduler configuration" wraps: "—" +cloudwatch: + description: "CloudWatch log groups, streams, metric filters, and alarms" + wraps: "terraform-aws-modules/cloudwatch/aws" + cognito: description: "Cognito user and identity pools" wraps: "—"