diff --git a/README.md b/README.md index a4cd8aa..ba54104 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,82 @@ # terraform-aws-vpc-endpoint-service Terraform module which creates a vpc endpoint service + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.3.0 | +| [aws](#requirement\_aws) | >= 4.67 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | >= 4.67 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [this](#module\_this) | justtrackio/label/null | 0.26.0 | + +## Resources + +| Name | Type | +|------|------| +| [aws_lb.lb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb) | resource | +| [aws_lb_listener.listener](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener) | resource | +| [aws_lb_target_group.target_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource | +| [aws_vpc_endpoint_service.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint_service) | resource | +| [aws_subnets.subnets](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnets) | data source | + +## 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 | +| [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\_account\_id](#input\_aws\_account\_id) | AWS account id | `string` | `null` | no | +| [aws\_region](#input\_aws\_region) | AWS region | `string` | `null` | 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,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
| 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 | +| [endpoint\_service\_acceptance\_required](#input\_endpoint\_service\_acceptance\_required) | Whether or not a consumer of this service needs to be accepted | `bool` | `false` | no | +| [endpoint\_service\_allowed\_principals](#input\_endpoint\_service\_allowed\_principals) | Principals allowed to access this VPC endpoint service | `set(string)` | `[]` | no | +| [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', '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 | +| [lb\_enable\_cross\_zone\_load\_balancing](#input\_lb\_enable\_cross\_zone\_load\_balancing) | Whether or not to enable cross zone load balancing for the load balancer | `bool` | `true` | no | +| [lb\_enable\_deletion\_protection](#input\_lb\_enable\_deletion\_protection) | Whether or not to enable deletion protection for the load balancer | `bool` | `false` | no | +| [lb\_subnet\_ids](#input\_lb\_subnet\_ids) | Set of subnet ids to use for the load balancer | `list(string)` | `[]` | no | +| [lb\_subnets\_tags](#input\_lb\_subnets\_tags) | Map with tags to filter for subnets that the load balancer should be available in (when lb\_subnet\_ids is not set) | `map(string)` | 
{
  "Type": "private"
}
| no | +| [lb\_target\_group\_port](#input\_lb\_target\_group\_port) | Port to listen on | `number` | `8088` | 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 | +| [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no | +| [organizational\_unit](#input\_organizational\_unit) | Usually used to indicate the AWS organizational unit, e.g. 'prod', 'sdlc' | `string` | `null` | 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 | +| [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | 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 | +| [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no | +| [vpc\_id](#input\_vpc\_id) | VPC id to filter for discovering private subnets | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [lb\_arn](#output\_lb\_arn) | ARN of the LB | +| [lb\_dns\_name](#output\_lb\_dns\_name) | DNS name of the LB | +| [lb\_name](#output\_lb\_name) | Name of the LB | +| [lb\_private\_ips](#output\_lb\_private\_ips) | Private IPs of the LB | +| [lb\_target\_group\_arn](#output\_lb\_target\_group\_arn) | ARN of the LBs target group | +| [vpc\_endpoint\_service\_arn](#output\_vpc\_endpoint\_service\_arn) | ARN of the VPC endpoint service | +| [vpc\_endpoint\_service\_availability\_zones](#output\_vpc\_endpoint\_service\_availability\_zones) | AZs of the VPC endpoint service | +| [vpc\_endpoint\_service\_id](#output\_vpc\_endpoint\_service\_id) | ID of the VPC endpoint service | +| [vpc\_endpoint\_service\_service\_name](#output\_vpc\_endpoint\_service\_service\_name) | Name of the VPC endpoint service | +| [vpc\_endpoint\_service\_service\_type](#output\_vpc\_endpoint\_service\_service\_type) | Type of the VPC endpoint service | + diff --git a/data.tf b/data.tf new file mode 100644 index 0000000..0bed7d7 --- /dev/null +++ b/data.tf @@ -0,0 +1,10 @@ +data "aws_subnets" "subnets" { + count = length(var.lb_subnet_ids) == 0 ? 1 : 0 + + filter { + name = "vpc-id" + values = [var.vpc_id] + } + + tags = var.lb_subnets_tags +} diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..90c8b38 --- /dev/null +++ b/main.tf @@ -0,0 +1,44 @@ +locals { + data_subnets = try(data.aws_subnets.subnets[0].ids, []) + subnet_ids = coalescelist(tolist(local.data_subnets), var.lb_subnet_ids) +} + +resource "aws_lb" "lb" { + name = "${module.this.id}-vpces" + internal = true + load_balancer_type = "network" + subnets = local.subnet_ids + enable_deletion_protection = var.lb_enable_deletion_protection + enable_cross_zone_load_balancing = var.lb_enable_cross_zone_load_balancing + + tags = module.this.tags +} + +resource "aws_lb_target_group" "target_group" { + name = "${module.this.environment}-${module.this.stage}-${module.this.name}" + port = var.lb_target_group_port + protocol = "TCP" + vpc_id = var.vpc_id + + tags = module.this.tags +} + +resource "aws_lb_listener" "listener" { + load_balancer_arn = aws_lb.lb.arn + port = 80 + protocol = "TCP" + default_action { + type = "forward" + target_group_arn = aws_lb_target_group.target_group.arn + } + + tags = module.this.tags +} + +resource "aws_vpc_endpoint_service" "service" { + acceptance_required = var.endpoint_service_acceptance_required + network_load_balancer_arns = [aws_lb.lb.arn] + allowed_principals = var.endpoint_service_allowed_principals + + tags = module.this.tags +} diff --git a/outputs.tf b/outputs.tf new file mode 100644 index 0000000..d9fe6eb --- /dev/null +++ b/outputs.tf @@ -0,0 +1,49 @@ +output "lb_arn" { + description = "ARN of the LB" + value = aws_lb.lb.arn +} + +output "lb_name" { + description = "Name of the LB" + value = aws_lb.lb.name +} + +output "lb_dns_name" { + description = "DNS name of the LB" + value = aws_lb.lb.dns_name +} + +output "lb_private_ips" { + description = "Private IPs of the LB" + value = [for mapping in aws_lb.lb.subnet_mapping : mapping.private_ipv4_address] +} + +output "lb_target_group_arn" { + description = "ARN of the LBs target group" + value = aws_lb_target_group.target_group.arn +} + +output "vpc_endpoint_service_arn" { + description = "ARN of the VPC endpoint service" + value = aws_vpc_endpoint_service.service.arn +} + +output "vpc_endpoint_service_id" { + description = "ID of the VPC endpoint service" + value = aws_vpc_endpoint_service.service.id +} + +output "vpc_endpoint_service_service_name" { + description = "Name of the VPC endpoint service" + value = aws_vpc_endpoint_service.service.service_name +} + +output "vpc_endpoint_service_service_type" { + description = "Type of the VPC endpoint service" + value = aws_vpc_endpoint_service.service.service_type +} + +output "vpc_endpoint_service_availability_zones" { + description = "AZs of the VPC endpoint service" + value = aws_vpc_endpoint_service.service.availability_zones +} diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..47e9daa --- /dev/null +++ b/variables.tf @@ -0,0 +1,48 @@ +variable "endpoint_service_acceptance_required" { + type = bool + description = "Whether or not a consumer of this service needs to be accepted" + default = false +} + +variable "endpoint_service_allowed_principals" { + type = set(string) + description = "Principals allowed to access this VPC endpoint service" + default = [] +} + +variable "lb_enable_cross_zone_load_balancing" { + type = bool + description = "Whether or not to enable cross zone load balancing for the load balancer" + default = true +} + +variable "lb_enable_deletion_protection" { + type = bool + description = "Whether or not to enable deletion protection for the load balancer" + default = false +} + +variable "lb_target_group_port" { + type = number + description = "Port to listen on" + default = 8088 +} + +variable "lb_subnets_tags" { + type = map(string) + description = "Map with tags to filter for subnets that the load balancer should be available in (when lb_subnet_ids is not set)" + default = { + Type = "private" + } +} + +variable "lb_subnet_ids" { + type = list(string) + description = "Set of subnet ids to use for the load balancer" + default = [] +} + +variable "vpc_id" { + type = string + description = "VPC id to filter for discovering private subnets" +} diff --git a/versions.tf b/versions.tf new file mode 100644 index 0000000..d20b84c --- /dev/null +++ b/versions.tf @@ -0,0 +1,9 @@ +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + version = ">= 4.67" + } + } + required_version = ">= 1.3.0" +}