diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index ed8d5c8..8a5e7c0 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -36,6 +36,7 @@ updates: - package-ecosystem: "terraform" directories: - "infrastructure/modules/acm" + - "infrastructure/modules/alb" - "infrastructure/modules/api-gateway" - "infrastructure/modules/aws-backup-destination" - "infrastructure/modules/aws-backup-source" diff --git a/README.md b/README.md index bc97b9f..59c13cf 100644 --- a/README.md +++ b/README.md @@ -302,6 +302,7 @@ Rules: | Module | Wraps | Description | | --- | --- | --- | | `acm` | terraform-aws-modules/acm/aws | AWS Certificate Manager (ACM) certificate management | +| `alb` | — | — | | `api-gateway` | — | API Gateway configuration with custom domain and integration | | `aws-backup-destination` | — | AWS Backup destination vault | | `aws-backup-source` | — | AWS Backup source configuration | diff --git a/infrastructure/modules/alb/.terraform.lock.hcl b/infrastructure/modules/alb/.terraform.lock.hcl new file mode 100644 index 0000000..994ba44 --- /dev/null +++ b/infrastructure/modules/alb/.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 = ">= 6.14.0, >= 6.28.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/alb/README.md b/infrastructure/modules/alb/README.md new file mode 100644 index 0000000..e1a9786 --- /dev/null +++ b/infrastructure/modules/alb/README.md @@ -0,0 +1,282 @@ +# AWS Application / Network Load Balancer Terraform module + +Thin NHS wrapper around [terraform-aws-modules/alb/aws](https://registry.terraform.io/modules/terraform-aws-modules/alb/aws) that enforces the screening platform's baseline controls. + +## What this module enforces + +| Setting | Value | Reason | +|---|---|---| +| `drop_invalid_header_fields` | `true` (ALB only) | Prevents HTTP header injection attacks | + +## Usage + +### Internet-facing ALB with HTTPS + +```hcl +module "alb" { + source = "../../modules/alb" + + context = module.this.context + stack = "web" + name = "bcss-web" + label_order = ["service", "environment", "stack", "name"] + + vpc_id = data.aws_vpc.selected.id + subnets = data.aws_subnets.public.ids + + access_logs = { + bucket = module.logs_bucket.id + prefix = terraform.workspace + enabled = true + } + + security_group_ingress_rules = { + http = { + from_port = 80 + to_port = 80 + ip_protocol = "tcp" + description = "HTTP from internet — redirected to HTTPS by listener" + cidr_ipv4 = "0.0.0.0/0" + } + https = { + from_port = 443 + to_port = 443 + ip_protocol = "tcp" + description = "HTTPS from internet" + cidr_ipv4 = "0.0.0.0/0" + } + } + + security_group_egress_rules = { + https_out = { + from_port = 443 + to_port = 443 + ip_protocol = "tcp" + description = "HTTPS to targets" + cidr_ipv4 = "0.0.0.0/0" + } + } + + # HTTP → HTTPS redirect on port 80 is added automatically by this module. + listeners = { + https = { + port = 443 + protocol = "HTTPS" + ssl_policy = "ELBSecurityPolicy-TLS13-1-2-Res-2021-06" + certificate_arn = local.acm_certificate_arn + forward = { + target_group_key = "web" + } + } + } + + target_groups = { + web = { + port = 443 + protocol = "HTTPS" + target_type = "ip" + health_check = { + protocol = "HTTPS" + path = "/health" + matcher = "200" + healthy_threshold = 2 + unhealthy_threshold = 2 + interval = 60 + } + } + } +} +``` + +### ALB with WAF association + +```hcl +module "alb" { + source = "../../modules/alb" + + context = module.this.context + name = "bcss-web" + + vpc_id = data.aws_vpc.selected.id + subnets = data.aws_subnets.public.ids + + listeners = { ... } + target_groups = { ... } + + web_acl_arn = module.waf.web_acl_arn +} +``` + +### Internal NLB + +```hcl +module "nlb" { + source = "../../modules/alb" + + context = module.this.context + name = "internal-nlb" + + load_balancer_type = "network" + internal = true + vpc_id = data.aws_vpc.selected.id + subnets = data.aws_subnets.private.ids + + security_group_ingress_rules = { + tcp = { + from_port = 8080 + to_port = 8080 + ip_protocol = "tcp" + description = "Internal TCP traffic" + cidr_ipv4 = data.aws_vpc.selected.cidr_block + } + } + + security_group_egress_rules = { + tcp_out = { + from_port = 8080 + to_port = 8080 + ip_protocol = "tcp" + cidr_ipv4 = data.aws_vpc.selected.cidr_block + } + } + + listeners = { + tcp = { + port = 8080 + protocol = "TCP" + forward = { target_group_key = "service" } + } + } + + target_groups = { + service = { + port = 8080 + protocol = "TCP" + target_type = "ip" + health_check = { + protocol = "TCP" + port = "8080" + } + } + } +} +``` + +## Conventions + +* The load balancer name is derived from `module.this.id` and cannot be overridden — pass `context`, `name`, and `label_order` to control the generated name. +* `internal` defaults to `false` (internet-facing). Set `internal = true` for ALBs and NLBs that should only be reachable from within the VPC. +* `enable_deletion_protection` defaults to `true`. Set it to `false` for non-production environments where the load balancer needs to be freely destroyed. +* HTTP-to-HTTPS redirect on port 80 is added automatically for ALBs (`enable_http_https_redirect = true` by default). Set to `false` if you need custom HTTP listener behaviour or the ALB is not serving HTTPS traffic. Does not apply to NLBs. +* Security group rules are caller-supplied via `security_group_ingress_rules` and `security_group_egress_rules`. This supports both ALB (HTTP/HTTPS) and NLB (TCP/TLS) patterns without constraining port numbers. +* Access logging is optional. Supply an S3 bucket ARN via `access_logs` to enable it. NHS production environments should always enable access logging. +* For NLBs, `drop_invalid_header_fields` is set to `null` automatically — this argument is only valid for ALBs. + +## What this module does NOT do + +* Create SSL/TLS certificates — use the `acm` module and pass the certificate ARN into `listeners`. +* Create an S3 bucket for access logs — use the `s3-bucket` module and pass the bucket ID via `access_logs.bucket`. +* Create Route53 DNS records — create an alias record pointing to `module.alb.dns_name` and `module.alb.zone_id` in your stack. +* Create a WAF Web ACL — use the `waf` module and pass the ARN via `web_acl_arn`. +* Enforce a minimum TLS policy — callers must specify `ssl_policy` on HTTPS listeners; use `ELBSecurityPolicy-TLS13-1-2-Res-2021-06` or later. + +## Outputs + +| Name | Description | Used by | +|---|---|---| +| `arn` | ARN of the load balancer | WAF ACL association | +| `dns_name` | DNS name of the load balancer | Route53 alias records | +| `zone_id` | Hosted zone ID of the load balancer | Route53 alias records | +| `listeners` | Map of listeners and their attributes | ECS task `depends_on` | +| `target_groups` | Map of target groups and their attributes | ECS task `target_group_arn` | +| `security_group_id` | ID of the load balancer security group | ECS task security group rules | + + + + +## Requirements + +| Name | Version | +| ---- | ------- | +| [terraform](#requirement\_terraform) | >= 1.13 | +| [aws](#requirement\_aws) | >= 6.42 | + +## Providers + +No providers. + +## Modules + +| Name | Source | Version | +| ---- | ------ | ------- | +| [alb](#module\_alb) | terraform-aws-modules/alb/aws | 10.5.0 | +| [this](#module\_this) | ../tags | n/a | + +## Resources + +No resources. + +## Inputs + +| Name | Description | Type | Default | Required | +| ---- | ----------- | ---- | ------- | :------: | +| [access\_logs](#input\_access\_logs) | S3 access log delivery configuration. When null, access logging is disabled. |
object({
bucket = string
prefix = optional(string)
enabled = optional(bool, true)
})
| `null` | no | +| [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 | +| [enable\_deletion\_protection](#input\_enable\_deletion\_protection) | When true, deletion protection is enabled on the load balancer. Set to false for non-production environments where the load balancer needs to be freely destroyed. | `bool` | `true` | no | +| [enable\_http\_https\_redirect](#input\_enable\_http\_https\_redirect) | When true, automatically adds a port-80 HTTP-to-HTTPS (301) redirect listener. Only applies when load\_balancer\_type is 'application'. Set to false if you are defining your own HTTP listener or the ALB is not serving HTTPS traffic. | `bool` | `true` | 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 | +| [internal](#input\_internal) | When true, the load balancer is internal (private). When false, it is internet-facing. Defaults to false. | `bool` | `false` | 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 | +| [listeners](#input\_listeners) | Map of listener configurations to create. Passed directly to the upstream module.
For ALB, define HTTPS and HTTP listeners here. For NLB, define TCP/TLS listeners.
See https://registry.terraform.io/modules/terraform-aws-modules/alb/aws/latest
for full schema documentation. | `any` | `{}` | no | +| [load\_balancer\_type](#input\_load\_balancer\_type) | Type of load balancer to create. Either 'application' (ALB) or 'network' (NLB). | `string` | `"application"` | 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 | +| [security\_group\_egress\_rules](#input\_security\_group\_egress\_rules) | Map of egress rules to add to the load balancer security group.
Example:
security\_group\_egress\_rules = {
https\_out = {
from\_port = 443
to\_port = 443
ip\_protocol = "tcp"
cidr\_ipv4 = "0.0.0.0/0"
}
} | `any` | `{}` | no | +| [security\_group\_ingress\_rules](#input\_security\_group\_ingress\_rules) | Map of ingress rules to add to the load balancer security group.
Each key is a logical name; each value is an object describing the rule.
Example:
security\_group\_ingress\_rules = {
https = {
from\_port = 443
to\_port = 443
ip\_protocol = "tcp"
description = "HTTPS from internet"
cidr\_ipv4 = "0.0.0.0/0"
}
} | `any` | `{}` | 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 | +| [subnets](#input\_subnets) | List of subnet IDs to attach to the load balancer. For internet-facing ALBs, use public subnets. | `list(string)` | n/a | yes | +| [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 | +| [target\_groups](#input\_target\_groups) | Map of target group configurations to create. Passed directly to the upstream module.
See https://registry.terraform.io/modules/terraform-aws-modules/alb/aws/latest
for full schema documentation. | `any` | `{}` | 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 | +| [vpc\_id](#input\_vpc\_id) | ID of the VPC in which the load balancer security group will be created. | `string` | n/a | yes | +| [web\_acl\_arn](#input\_web\_acl\_arn) | ARN of a WAFv2 Web ACL to associate with the load balancer. Only valid for ALB. When null, no WAF association is created. | `string` | `null` | no | +| [workspace](#input\_workspace) | ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces | `string` | `null` | no | + +## Outputs + +| Name | Description | +| ---- | ----------- | +| [arn](#output\_arn) | ARN of the load balancer. Used by WAF to associate a Web ACL. | +| [arn\_suffix](#output\_arn\_suffix) | ARN suffix of the load balancer. Used with CloudWatch metrics. | +| [dns\_name](#output\_dns\_name) | DNS name of the load balancer. Used by Route53 alias records. | +| [id](#output\_id) | ID of the load balancer (same as ARN). | +| [listeners](#output\_listeners) | Map of listeners created and their attributes. ECS tasks use this for depends\_on. | +| [security\_group\_arn](#output\_security\_group\_arn) | ARN of the security group created for the load balancer. | +| [security\_group\_id](#output\_security\_group\_id) | ID of the security group created for the load balancer. | +| [target\_groups](#output\_target\_groups) | Map of target groups created and their attributes. ECS tasks reference target\_group ARNs from here. | +| [zone\_id](#output\_zone\_id) | Hosted zone ID of the load balancer. Used by Route53 alias records. | + + + diff --git a/infrastructure/modules/alb/context.tf b/infrastructure/modules/alb/context.tf new file mode 100644 index 0000000..f813fc8 --- /dev/null +++ b/infrastructure/modules/alb/context.tf @@ -0,0 +1,374 @@ +# 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" + + 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 +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/alb/main.tf b/infrastructure/modules/alb/main.tf new file mode 100644 index 0000000..6472f30 --- /dev/null +++ b/infrastructure/modules/alb/main.tf @@ -0,0 +1,87 @@ +################################################################ +# Application / Network Load Balancer +# +# Thin NHS wrapper around the community ALB module that enforces +# the screening platform's baseline controls: +# +# * Deletion protection: enabled by default; set enable_deletion_protection = false for non-prod +# * Invalid header fields: always dropped (ALB only) +# * HTTP→HTTPS redirect: automatic on port 80 for ALBs (disable with enable_http_https_redirect = false) +# * Naming: derived from context labels via module.this.id +# * Tagging: all NHS-required tags applied automatically +# * Enabled flag: create = module.this.enabled +# +# Inputs intentionally NOT exposed (hardcoded below): +# - drop_invalid_header_fields → always true (ALB); null (NLB) +################################################################ + +locals { + # Inject an HTTP → HTTPS redirect listener on port 80 when enabled (ALB only). + # Callers can override by providing their own "http-redirect" key in var.listeners. + http_redirect_listener = var.enable_http_https_redirect && var.load_balancer_type == "application" ? { + http-redirect = { + port = 80 + protocol = "HTTP" + redirect = { + port = "443" + protocol = "HTTPS" + status_code = "HTTP_301" + } + } + } : {} + + effective_listeners = merge(local.http_redirect_listener, var.listeners) +} + +module "alb" { + source = "terraform-aws-modules/alb/aws" + version = "10.5.0" + + create = module.this.enabled + + name = module.this.id + load_balancer_type = var.load_balancer_type + internal = var.internal + vpc_id = var.vpc_id + subnets = var.subnets + + # ---------------------------------------------------------------- + # Security baseline — drop_invalid_header_fields is hardcoded. + # enable_deletion_protection defaults to true; callers may set it to + # false for non-production environments. + # drop_invalid_header_fields is ALB-only; pass null for NLB so + # the upstream module does not error. + # ---------------------------------------------------------------- + enable_deletion_protection = var.enable_deletion_protection + drop_invalid_header_fields = var.load_balancer_type == "application" ? true : null + + # ---------------------------------------------------------------- + # Security group rules — caller-supplied so both ALB (HTTP+HTTPS) + # and NLB (TCP) patterns are supported. + # ---------------------------------------------------------------- + security_group_ingress_rules = var.security_group_ingress_rules + security_group_egress_rules = var.security_group_egress_rules + + # ---------------------------------------------------------------- + # Access logging to a caller-supplied S3 bucket. + # ---------------------------------------------------------------- + access_logs = var.access_logs + + # ---------------------------------------------------------------- + # Listeners — merged with the automatic HTTP→HTTPS redirect (ALB only). + # Target groups are passed through as-is. + # ---------------------------------------------------------------- + listeners = local.effective_listeners + target_groups = var.target_groups + + # ---------------------------------------------------------------- + # WAF association — optional, ALB only. + # ---------------------------------------------------------------- + associate_web_acl = var.web_acl_arn != null + web_acl_arn = var.web_acl_arn + + # ---------------------------------------------------------------- + # Tags — automatically populated from context. + # ---------------------------------------------------------------- + tags = module.this.tags +} diff --git a/infrastructure/modules/alb/outputs.tf b/infrastructure/modules/alb/outputs.tf new file mode 100644 index 0000000..6a659a9 --- /dev/null +++ b/infrastructure/modules/alb/outputs.tf @@ -0,0 +1,44 @@ +output "arn" { + description = "ARN of the load balancer. Used by WAF to associate a Web ACL." + value = module.alb.arn +} + +output "dns_name" { + description = "DNS name of the load balancer. Used by Route53 alias records." + value = module.alb.dns_name +} + +output "zone_id" { + description = "Hosted zone ID of the load balancer. Used by Route53 alias records." + value = module.alb.zone_id +} + +output "id" { + description = "ID of the load balancer (same as ARN)." + value = module.alb.id +} + +output "arn_suffix" { + description = "ARN suffix of the load balancer. Used with CloudWatch metrics." + value = module.alb.arn_suffix +} + +output "listeners" { + description = "Map of listeners created and their attributes. ECS tasks use this for depends_on." + value = module.alb.listeners +} + +output "target_groups" { + description = "Map of target groups created and their attributes. ECS tasks reference target_group ARNs from here." + value = module.alb.target_groups +} + +output "security_group_id" { + description = "ID of the security group created for the load balancer." + value = module.alb.security_group_id +} + +output "security_group_arn" { + description = "ARN of the security group created for the load balancer." + value = module.alb.security_group_arn +} diff --git a/infrastructure/modules/alb/variables.tf b/infrastructure/modules/alb/variables.tf new file mode 100644 index 0000000..a823e7e --- /dev/null +++ b/infrastructure/modules/alb/variables.tf @@ -0,0 +1,122 @@ +################################################################ +# ALB/NLB-specific inputs. +# +# Naming, tagging and the master `enabled` switch come from +# context.tf via `module.this`. +# +# Inputs intentionally NOT exposed (hardcoded in main.tf): +# - enable_deletion_protection → always true +# - drop_invalid_header_fields → always true for ALB +################################################################ + +variable "load_balancer_type" { + type = string + default = "application" + description = "Type of load balancer to create. Either 'application' (ALB) or 'network' (NLB)." + + validation { + condition = contains(["application", "network"], var.load_balancer_type) + error_message = "load_balancer_type must be 'application' or 'network'." + } +} + +variable "internal" { + type = bool + default = false + description = "When true, the load balancer is internal (private). When false, it is internet-facing. Defaults to false." +} + +variable "subnets" { + type = list(string) + description = "List of subnet IDs to attach to the load balancer. For internet-facing ALBs, use public subnets." +} + +variable "vpc_id" { + type = string + description = "ID of the VPC in which the load balancer security group will be created." +} + +variable "security_group_ingress_rules" { + type = any + default = {} + description = <<-EOT + Map of ingress rules to add to the load balancer security group. + Each key is a logical name; each value is an object describing the rule. + Example: + security_group_ingress_rules = { + https = { + from_port = 443 + to_port = 443 + ip_protocol = "tcp" + description = "HTTPS from internet" + cidr_ipv4 = "0.0.0.0/0" + } + } + EOT +} + +variable "security_group_egress_rules" { + type = any + default = {} + description = <<-EOT + Map of egress rules to add to the load balancer security group. + Example: + security_group_egress_rules = { + https_out = { + from_port = 443 + to_port = 443 + ip_protocol = "tcp" + cidr_ipv4 = "0.0.0.0/0" + } + } + EOT +} + +variable "access_logs" { + type = object({ + bucket = string + prefix = optional(string) + enabled = optional(bool, true) + }) + default = null + description = "S3 access log delivery configuration. When null, access logging is disabled." +} + +variable "listeners" { + type = any + default = {} + description = <<-EOT + Map of listener configurations to create. Passed directly to the upstream module. + For ALB, define HTTPS and HTTP listeners here. For NLB, define TCP/TLS listeners. + See https://registry.terraform.io/modules/terraform-aws-modules/alb/aws/latest + for full schema documentation. + EOT +} + +variable "target_groups" { + type = any + default = {} + description = <<-EOT + Map of target group configurations to create. Passed directly to the upstream module. + See https://registry.terraform.io/modules/terraform-aws-modules/alb/aws/latest + for full schema documentation. + EOT +} + +variable "web_acl_arn" { + type = string + default = null + description = "ARN of a WAFv2 Web ACL to associate with the load balancer. Only valid for ALB. When null, no WAF association is created." +} + +variable "enable_deletion_protection" { + type = bool + default = true + description = "When true, deletion protection is enabled on the load balancer. Set to false for non-production environments where the load balancer needs to be freely destroyed." +} + +variable "enable_http_https_redirect" { + type = bool + default = true + description = "When true, automatically adds a port-80 HTTP-to-HTTPS (301) redirect listener. Only applies when load_balancer_type is 'application'. Set to false if you are defining your own HTTP listener or the ALB is not serving HTTPS traffic." +} diff --git a/infrastructure/modules/alb/versions.tf b/infrastructure/modules/alb/versions.tf new file mode 100644 index 0000000..cb30fe5 --- /dev/null +++ b/infrastructure/modules/alb/versions.tf @@ -0,0 +1,10 @@ +terraform { + required_version = ">= 1.13" + + required_providers { + aws = { + source = "hashicorp/aws" + version = ">= 6.42" + } + } +}