Support traffic-port for healthcheck of target groups (#71)

Author: posquit0

examples/alb-with-instance-target-group/main.tf

@@ -157,13 +157,15 @@ module "target_group_alpha" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = false
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 5
     unhealthy_threshold = 2
-    path                = "/health"
   }
 
   tags = {
@@ -201,13 +203,15 @@ module "target_group_beta" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = false
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 5
     unhealthy_threshold = 2
-    path                = "/health"
   }
 
   tags = {

examples/alb-with-instance-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

examples/alb-with-ip-target-group/main.tf

@@ -162,13 +162,15 @@ module "target_group_alpha" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = false
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 5
     unhealthy_threshold = 2
-    path                = "/health"
   }
 
   tags = {
@@ -207,13 +209,15 @@ module "target_group_beta" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = false
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 5
     unhealthy_threshold = 2
-    path                = "/health"
   }
 
   tags = {

examples/alb-with-ip-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

examples/gwlb-with-instance-target-group/main.tf

@@ -67,12 +67,14 @@ module "target_group" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = true
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 3
     unhealthy_threshold = 3
-    path                = "/health"
   }
 }

examples/gwlb-with-instance-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

examples/gwlb-with-ip-target-group/main.tf

@@ -67,12 +67,14 @@ module "target_group" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "TCP"
+    port          = 80
+    port_override = true
+    path          = "/"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 3
     unhealthy_threshold = 3
-    path                = "/health"
   }
 }

examples/gwlb-with-ip-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

examples/nlb-with-alb-target-group/alb.tf

@@ -44,8 +44,9 @@ module "alb" {
         protocol = "HTTPS"
         port     = 443
       }
-      rules = {
-        10 = {
+      rules = [
+        {
+          priority = 10
           conditions = [
             {
               type   = "PATH"
@@ -61,7 +62,7 @@ module "alb" {
             EOF
           }
         }
-      }
+      ]
     },
     # {
     #   port         = 443

examples/nlb-with-alb-target-group/main.tf

@@ -76,12 +76,14 @@ module "target_group" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = false
+    path          = "/ping"
+
     interval            = 10
     healthy_threshold   = 3
     unhealthy_threshold = 3
-    path                = "/ping"
   }
 
   tags = {

examples/nlb-with-alb-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

examples/nlb-with-instance-target-group/main.tf

@@ -85,13 +85,15 @@ module "target_group" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 80
+    port_override = true
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 3
     unhealthy_threshold = 3
-    path                = "/health"
   }
 
   tags = {

examples/nlb-with-instance-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

examples/nlb-with-ip-target-group/main.tf

@@ -90,13 +90,15 @@ module "target_group" {
   ]
 
   health_check = {
-    port                = 80
-    protocol            = "HTTP"
+    protocol      = "HTTP"
+    port          = 443
+    port_override = false
+    path          = "/health"
+
     interval            = 10
     timeout             = 5
     healthy_threshold   = 3
     unhealthy_threshold = 3
-    path                = "/health"
   }
 
   tags = {

examples/nlb-with-ip-target-group/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = "~> 1.1"
+  required_version = "~> 1.3"
 
   required_providers {
     aws = {

modules/alb-instance-target-group/README.md

@@ -10,14 +10,14 @@ This module creates following resources.
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.2 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.71 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.36.1 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.37.0 |
 
 ## Modules
 
@@ -41,7 +41,7 @@ This module creates following resources.
 | <a name="input_protocol"></a> [protocol](#input\_protocol) | (Required) The protocol to use for routing traffic to the targets. Valid values are `HTTP` and `HTTPS`. Defaults to `HTTP`. | `string` | n/a | yes |
 | <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | (Required) The ID of the VPC which the target group belongs to. | `string` | n/a | yes |
 | <a name="input_deregistration_delay"></a> [deregistration\_delay](#input\_deregistration\_delay) | (Optional) The time to wait for in-flight requests to complete while deregistering a target. During this time, the state of the target is draining. | `number` | `300` | no |
-| <a name="input_health_check"></a> [health\_check](#input\_health\_check) | (Optional) Health Check configuration block. The associated load balancer periodically sends requests to the registered targets to test their status. `health_check` block as defined below.<br>    (Optional) `port` - The port the load balancer uses when performing health checks on targets. The default is the port on which each target receives traffic from the load balancer. Valid values are either ports 1-65535.<br>    (Optional) `protocol` - Protocol to use to connect with the target. The possible values are `HTTP` and `HTTPS`. Defaults to `HTTP`.<br>    (Optional) `healthy_threshold` - The number of consecutive health checks successes required before considering an unhealthy target healthy. Valid value range is 2 - 10. Defaults to `5`.<br>    (Optional) `unhealthy_threshold` - The number of consecutive health check failures required before considering a target unhealthy. Valid value range is 2 - 10. Defaults to `2`.<br>    (Optional) `interval` - Approximate amount of time, in seconds, between health checks of an individual target. Valid value range is 5 - 300. Defaults to `30`.<br>    (Optional) `timeout` - The amount of time, in seconds, during which no response means a failed health check. Valid value range is 2 - 120. Defaults to `5`.<br>    (Optional) `success_codes` - The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, `200,202`) or a range of values (for example, `200-299`).<br>    (Optional) `path` - Use the default path of `/` to ping the root, or specify a custom path if preferred. | `any` | `{}` | no |
+| <a name="input_health_check"></a> [health\_check](#input\_health\_check) | (Optional) Health Check configuration block. The associated load balancer periodically sends requests to the registered targets to test their status. `health_check` block as defined below.<br>    (Optional) `protocol` - Protocol to use to connect with the target. The possible values are `HTTP` and `HTTPS`. Defaults to `HTTP`.<br>    (Optional) `port` - The port the load balancer uses when performing health checks on targets. The default is the port on which each target receives traffic from the load balancer. Valid values are either ports 1-65535.<br>    (Optional) `port_override` - Whether to override the port on which each target receives trafficfrom the load balancer to a different port. Defaults to `false`.<br>    (Optional) `path` - Use the default path of `/` to ping the root, or specify a custom path if preferred.<br>    (Optional) `success_codes` - The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, `200,202`) or a range of values (for example, `200-299`).<br>    (Optional) `healthy_threshold` - The number of consecutive health checks successes required before considering an unhealthy target healthy. Valid value range is 2 - 10. Defaults to `5`.<br>    (Optional) `unhealthy_threshold` - The number of consecutive health check failures required before considering a target unhealthy. Valid value range is 2 - 10. Defaults to `2`.<br>    (Optional) `interval` - Approximate amount of time, in seconds, between health checks of an individual target. Valid value range is 5 - 300. Defaults to `30`.<br>    (Optional) `timeout` - The amount of time, in seconds, during which no response means a failed health check. Valid value range is 2 - 120. Defaults to `5`. | <pre>object({<br>    protocol      = optional(string, "HTTP")<br>    port          = optional(number, null)<br>    port_override = optional(bool, false)<br>    path          = optional(string, null)<br>    success_codes = optional(string, null)<br><br>    healthy_threshold   = optional(number, 5)<br>    unhealthy_threshold = optional(number, 2)<br>    interval            = optional(number, 30)<br>    timeout             = optional(number, 5)<br>  })</pre> | `{}` | no |
 | <a name="input_load_balancing_algorithm"></a> [load\_balancing\_algorithm](#input\_load\_balancing\_algorithm) | (Optional) Determines how the load balancer selects targets when routing requests. Valid values are `ROUND_ROBIN` or `LEAST_OUTSTANDING_REQUESTS`. Defaults to `ROUND_ROBIN`. | `string` | `"ROUND_ROBIN"` | no |
 | <a name="input_module_tags_enabled"></a> [module\_tags\_enabled](#input\_module\_tags\_enabled) | (Optional) Whether to create AWS Resource Tags for the module informations. | `bool` | `true` | no |
 | <a name="input_protocol_version"></a> [protocol\_version](#input\_protocol\_version) | (Optional) Use `HTTP1` to send requests to targets using HTTP/1.1. Supported when the request protocol is HTTP/1.1 or HTTP/2. Use `HTTP2` to send requests to targets using HTTP/2. Supported when the request protocol is HTTP/2 or gRPC, but gRPC-specific features are not available. Use `GRPC` to send requests to targets using gRPC. Supported when the request protocol is gRPC. Defaults to `HTTP1`. | `string` | `"HTTP1"` | no |
@@ -54,7 +54,7 @@ This module creates following resources.
 | <a name="input_stickiness_enabled"></a> [stickiness\_enabled](#input\_stickiness\_enabled) | (Optional) Whether to enable the type of stickiness associated with this target group. If enabled, the load balancer binds a client’s session to a specific instance within the target group. Defaults to `false`. | `bool` | `false` | no |
 | <a name="input_stickiness_type"></a> [stickiness\_type](#input\_stickiness\_type) | (Optional) The type of sticky sessions. Valid values are `LB_COOKIE` or `APP_COOKIE`. Defaults to `LB_COOKIE`. | `string` | `"LB_COOKIE"` | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | (Optional) A map of tags to add to all resources. | `map(string)` | `{}` | no |
-| <a name="input_targets"></a> [targets](#input\_targets) | (Optional) A set of targets to add to the target group. Each value of `targets` block as defined below.<br>    (Required) `instance` - This is the Instance ID for an instance, or the container ID for an ECS container.<br>    (Optional) `port` - The port on which targets receive traffic. | `set(map(string))` | `[]` | no |
+| <a name="input_targets"></a> [targets](#input\_targets) | (Optional) A set of targets to add to the target group. Each value of `targets` block as defined below.<br>    (Required) `instance` - This is the Instance ID for an instance, or the container ID for an ECS container.<br>    (Optional) `port` - The port on which targets receive traffic. | <pre>set(object({<br>    instance = string<br>    port     = optional(number, null)<br>  }))</pre> | `[]` | no |
 
 ## Outputs
 

modules/alb-instance-target-group/main.tf

@@ -46,20 +46,24 @@ resource "aws_lb_target_group" "this" {
   health_check {
     enabled = true
 
-    port     = try(var.health_check.port, var.port)
-    protocol = try(var.health_check.protocol, "HTTP")
-
-    healthy_threshold   = try(var.health_check.healthy_threshold, 5)
-    unhealthy_threshold = try(var.health_check.unhealthy_threshold, 2)
-    interval            = try(var.health_check.interval, 30)
-    timeout             = try(var.health_check.timeout, 5)
-
-    matcher = (var.protocol_version != "GRPC"
-      ? try(var.health_check.success_codes, "200")
-    : try(var.health_check.success_codes, "12"))
+    protocol = var.health_check.protocol
+    port = (var.health_check.port_override
+      ? coalesce(var.health_check.port, var.port)
+      : "traffic-port"
+    )
     path = (var.protocol_version != "GRPC"
-      ? try(var.health_check.path, "/")
-    : try(var.health_check.path, "/AWS.ALB/healthcheck"))
+      ? coalesce(var.health_check.path, "/")
+      : coalesce(var.health_check.path, "/AWS.ALB/healthcheck")
+    )
+    matcher = (var.protocol_version != "GRPC"
+      ? coalesce(var.health_check.success_codes, "200")
+      : coalesce(var.health_check.success_codes, "12")
+    )
+
+    healthy_threshold   = var.health_check.healthy_threshold
+    unhealthy_threshold = var.health_check.unhealthy_threshold
+    interval            = var.health_check.interval
+    timeout             = var.health_check.timeout
   }
 
   tags = merge(

modules/alb-instance-target-group/outputs.tf

@@ -71,15 +71,14 @@ output "attributes" {
 output "health_check" {
   description = "Health Check configuration of the target group."
   value = {
-    protocol = aws_lb_target_group.this.health_check[0].protocol
-    port     = aws_lb_target_group.this.health_check[0].port
+    protocol      = aws_lb_target_group.this.health_check[0].protocol
+    port          = aws_lb_target_group.this.health_check[0].port
+    path          = aws_lb_target_group.this.health_check[0].path
+    success_codes = aws_lb_target_group.this.health_check[0].matcher
 
     healthy_threshold   = aws_lb_target_group.this.health_check[0].healthy_threshold
     unhealthy_threshold = aws_lb_target_group.this.health_check[0].unhealthy_threshold
     interval            = aws_lb_target_group.this.health_check[0].interval
     timeout             = aws_lb_target_group.this.health_check[0].timeout
-
-    success_codes = aws_lb_target_group.this.health_check[0].matcher
-    path          = aws_lb_target_group.this.health_check[0].path
   }
 }