From 0e80d7af3cf1a7caef57d51eba2685ba5e1af481 Mon Sep 17 00:00:00 2001 From: piravinth Date: Thu, 14 May 2026 19:26:36 +0100 Subject: [PATCH] intro LM module --- .../modules/license-manager/context.tf | 365 ++++++++++++++++++ .../modules/license-manager/main.tf | 58 +++ .../modules/license-manager/outputs.tf | 19 + .../modules/license-manager/readme.md | 79 ++++ .../modules/license-manager/variables.tf | 69 ++++ 5 files changed, 590 insertions(+) create mode 100644 infrastructure/modules/license-manager/context.tf create mode 100644 infrastructure/modules/license-manager/main.tf create mode 100644 infrastructure/modules/license-manager/outputs.tf create mode 100644 infrastructure/modules/license-manager/readme.md create mode 100644 infrastructure/modules/license-manager/variables.tf diff --git a/infrastructure/modules/license-manager/context.tf b/infrastructure/modules/license-manager/context.tf new file mode 100644 index 0000000..5eb0bc6 --- /dev/null +++ b/infrastructure/modules/license-manager/context.tf @@ -0,0 +1,365 @@ +# +# 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 = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags?ref=feature/BCSS-23189-add-new-modules-to-suppport-bcss" + + 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 + 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 + 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 + 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 "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/license-manager/main.tf b/infrastructure/modules/license-manager/main.tf new file mode 100644 index 0000000..bc6b030 --- /dev/null +++ b/infrastructure/modules/license-manager/main.tf @@ -0,0 +1,58 @@ +################################################################ +# License Manager +# +# Creates a self-managed AWS License Manager license configuration +# (vCPU / Core / Socket / Instance counted), optionally enforces a +# hard limit, and optionally associates the configuration with one +# or more resource ARNs (e.g. AMIs, EC2 instances, hosts). +# +# Naming and tagging are derived from `context.tf` via +# `module.this` so this module composes consistently across +# screening service stacks and accounts. +################################################################ + +locals { + # Allow callers to override the generated name. Fall back to the + # context-derived id so naming stays consistent with sibling + # modules. + license_configuration_name = coalesce(var.name_override, module.this.id) +} + +################################################################ +# License configuration +################################################################ + +resource "aws_licensemanager_license_configuration" "this" { + count = module.this.enabled ? 1 : 0 + + name = local.license_configuration_name + description = var.description + license_count = var.license_count + license_count_hard_limit = var.license_count_hard_limit + license_counting_type = var.license_counting_type + license_rules = var.license_rules + + tags = module.this.tags + + lifecycle { + precondition { + condition = local.license_configuration_name != null && local.license_configuration_name != "" + error_message = "License configuration name resolved to an empty string. Set var.name (via context) or var.name_override." + } + } +} + +################################################################ +# Associations (e.g. AMIs, EC2 instances, hosts) +# +# The for_each key is a stable, caller-supplied identifier so +# resources can be added/removed without forcing other entries to +# be re-created. +################################################################ + +resource "aws_licensemanager_association" "this" { + for_each = module.this.enabled ? var.associated_resource_arns : {} + + license_configuration_arn = aws_licensemanager_license_configuration.this[0].arn + resource_arn = each.value +} diff --git a/infrastructure/modules/license-manager/outputs.tf b/infrastructure/modules/license-manager/outputs.tf new file mode 100644 index 0000000..b0e72e4 --- /dev/null +++ b/infrastructure/modules/license-manager/outputs.tf @@ -0,0 +1,19 @@ +output "license_configuration_arn" { + description = "ARN of the License Manager license configuration." + value = try(aws_licensemanager_license_configuration.this[0].arn, null) +} + +output "license_configuration_id" { + description = "ID (ARN) of the License Manager license configuration." + value = try(aws_licensemanager_license_configuration.this[0].id, null) +} + +output "owner_account_id" { + description = "AWS account ID that owns the license configuration." + value = try(aws_licensemanager_license_configuration.this[0].owner_account_id, null) +} + +output "association_ids" { + description = "Map of license configuration associations keyed by the caller-supplied identifier, with the association ID as the value." + value = { for k, v in aws_licensemanager_association.this : k => v.id } +} diff --git a/infrastructure/modules/license-manager/readme.md b/infrastructure/modules/license-manager/readme.md new file mode 100644 index 0000000..8f3f907 --- /dev/null +++ b/infrastructure/modules/license-manager/readme.md @@ -0,0 +1,79 @@ +# License Manager + + + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider_aws) | n/a | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [this](#module_this) | `git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags` | feature/BCSS-23189-add-new-modules-to-suppport-bcss | + +## Resources + +| Name | Type | +|------|------| +| [aws_licensemanager_association.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/licensemanager_association) | resource | +| [aws_licensemanager_license_configuration.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/licensemanager_license_configuration) | resource | + +## 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`. | `map(string)` | `{}` | no | +| [application_role](#input_application_role) | The role the application is performing | `string` | `"General"` | no | +| [associated_resource_arns](#input_associated_resource_arns) | Map of resource ARNs to associate with the license configuration. Keys are stable identifiers; values are AMI/instance/host ARNs. | `map(string)` | `{}` | 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. | `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. | `any` | see `context.tf` | 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). | `string` | `null` | no | +| [description](#input_description) | Description of the License Manager license configuration. | `string` | `null` | no | +| [descriptor_formats](#input_descriptor_formats) | Describe additional descriptors to be output in the `descriptors` output map. | `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). | `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. | `string` | `null` | no | +| [label_order](#input_label_order) | The order in which the labels (ID elements) appear in the `id`. | `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. | `string` | `null` | no | +| [labels_as_tags](#input_labels_as_tags) | Set of labels (ID elements) to include as tags in the `tags` output. | `set(string)` | `["default"]` | no | +| [license_count](#input_license_count) | Number of licenses managed by the configuration. Null means no count is tracked. | `number` | `null` | no | +| [license_count_hard_limit](#input_license_count_hard_limit) | If true, the `license_count` is enforced as a hard limit. | `bool` | `false` | no | +| [license_counting_type](#input_license_counting_type) | Dimension used to track license inventory. One of: vCPU, Instance, Core, Socket. | `string` | n/a | yes | +| [license_rules](#input_license_rules) | Optional list of License Manager rules in the form `#RuleType=RuleValue`. | `list(string)` | `[]` | no | +| [name](#input_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. | `string` | `null` | no | +| [name_override](#input_name_override) | Optional explicit name for the License Manager license configuration. When null, the name is derived from the shared context (`module.this.id`). | `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. | `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. | `string` | `null` | no | +| [region](#input_region) | ID element. Short region abbreviation e.g. 'uw2', 'ew2'. | `string` | `null` | no | +| [service](#input_service) | ID element. Service directorate abbreviation, e.g. 'bcss'. | `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'}`). | `map(string)` | `{}` | 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 | +|------|-------------| +| [association_ids](#output_association_ids) | Map of license configuration associations keyed by the caller-supplied identifier, with the association ID as the value. | +| [license_configuration_arn](#output_license_configuration_arn) | ARN of the License Manager license configuration. | +| [license_configuration_id](#output_license_configuration_id) | ID (ARN) of the License Manager license configuration. | +| [owner_account_id](#output_owner_account_id) | AWS account ID that owns the license configuration. | + + diff --git a/infrastructure/modules/license-manager/variables.tf b/infrastructure/modules/license-manager/variables.tf new file mode 100644 index 0000000..f3dcbac --- /dev/null +++ b/infrastructure/modules/license-manager/variables.tf @@ -0,0 +1,69 @@ +################################################################ +# License Manager-specific inputs. +# +# Naming, tagging and the master `enabled` switch come from +# `context.tf` via `module.this` — see that file for the full +# list of inherited inputs (service, project, environment, +# stack, name, owner, data_classification, tags, etc.). +################################################################ + +variable "name_override" { + description = "Optional explicit name for the License Manager license configuration. When null, the name is derived from the shared context (`module.this.id`)." + type = string + default = null +} + +variable "description" { + description = "Description of the License Manager license configuration." + type = string + default = null +} + +variable "license_counting_type" { + description = "Dimension used to track license inventory. One of: vCPU, Instance, Core, Socket." + type = string + + validation { + condition = contains(["vCPU", "Instance", "Core", "Socket"], var.license_counting_type) + error_message = "license_counting_type must be one of vCPU, Instance, Core, Socket." + } +} + +variable "license_count" { + description = "Number of licenses managed by the configuration. Null means no count is tracked. Note: removing this attribute after creation is not supported by the License Manager API and requires resource replacement." + type = number + default = null +} + +variable "license_count_hard_limit" { + description = "If true, the `license_count` is enforced as a hard limit (further usage is blocked once exceeded)." + type = bool + default = false +} + +variable "license_rules" { + description = <<-EOT + Optional list of License Manager rules in the form `#RuleType=RuleValue`. + Supported rule types: minimumVcpus, maximumVcpus, minimumCores, maximumCores, + minimumSockets, maximumSockets, allowedTenancy. Example: + ["#minimumSockets=2", "#allowedTenancy=EC2-DedicatedHost"] + EOT + type = list(string) + default = [] +} + +################################################################ +# Associations +################################################################ + +variable "associated_resource_arns" { + description = <<-EOT + Map of resource ARNs to associate with the license configuration. + Keys are stable, caller-supplied identifiers (e.g. `windows-ami-2022`) + used so resources can be added/removed without forcing other + associations to be re-created. Values are the ARNs of AMIs, EC2 + instances, hosts, or other supported resources. + EOT + type = map(string) + default = {} +}