Feature/task healthcheck (#11)

ghaddow · web-flow · commit 06cc2e1058fa · 2020-03-19T15:09:58.000Z
* do not create target group if we dont need it (when we are not load balancing)

* add optional task healthcheck

* regen readme
diff --git a/README.md b/README.md
@@ -70,57 +70,65 @@ Module is to be used with Terraform > 0.12.
 Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](https://www.linkedin.com/in/marcincuber/).
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+| null | n/a |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| capacity\_provider\_strategy | \(Optional\) The capacity\_provider\_strategy configuration block. This is a list of maps, where each map should contain "capacity\_provider ", "weight" and "base" | list | `[]` | no |
-| cluster\_id | The Amazon Resource Name \(ARN\) that identifies the cluster. | string | n/a | yes |
-| container\_name | Optional name for the container to be used instead of name\_prefix. | string | `""` | no |
-| deployment\_controller\_type | Type of deployment controller. Valid values: CODE\_DEPLOY, ECS. | string | `"ECS"` | no |
-| deployment\_maximum\_percent | The upper limit of the number of running tasks that can be running in a service during a deployment | number | `"200"` | no |
-| deployment\_minimum\_healthy\_percent | The lower limit of the number of running tasks that must remain running and healthy in a service during a deployment | number | `"50"` | no |
-| desired\_count | The number of instances of the task definitions to place and keep running. | number | `"1"` | no |
-| docker\_volume\_configuration | \(Optional\) Used to configure a docker volume option "docker\_volume\_configuration". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs\_task\_definition.html | list | `[]` | no |
-| health\_check | A health block containing health check settings for the target group. Overrides the defaults. | map(string) | n/a | yes |
-| health\_check\_grace\_period\_seconds | Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. Only valid for services configured to use load balancers. | number | `"300"` | no |
-| lb\_arn | Arn for the LB for which the service should be attach to. | string | n/a | yes |
-| load\_balanced | Whether the task should be loadbalanced. | bool | `"true"` | no |
-| log\_retention\_in\_days | Number of days the logs will be retained in CloudWatch. | number | `"30"` | no |
-| logs\_kms\_key | The KMS key ARN to use to encrypt container logs. | string | `""` | no |
-| name\_prefix | A prefix used for naming resources. | string | n/a | yes |
-| placement\_constraints | \(Optional\) A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placement\_constraints is 10. This is a list of maps, where each map should contain "type" and "expression" | list | `[]` | no |
-| private\_subnet\_ids | A list of private subnets inside the VPC | list(string) | n/a | yes |
-| propogate\_tags | Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK\_DEFINITION. | string | `"TASK_DEFINITION"` | no |
-| proxy\_configuration | \(Optional\) The proxy configuration details for the App Mesh proxy. This is a list of maps, where each map should contain "container\_name", "properties" and "type" | list | `[]` | no |
-| repository\_credentials | name or ARN of a secrets manager secret \(arn:aws:secretsmanager:region:aws\_account\_id:secret:secret\_name\) | string | `""` | no |
-| repository\_credentials\_kms\_key | key id, key ARN, alias name or alias ARN of the key that encrypted the repository credentials | string | `"alias/aws/secretsmanager"` | no |
-| service\_registry\_arn | ARN of aws\_service\_discovery\_service resource | string | `""` | no |
-| tags | A map of tags \(key-value pairs\) passed to resources. | map(string) | `{}` | no |
-| target\_group\_name | The name for the tasks target group | string | `""` | no |
-| task\_container\_assign\_public\_ip | Assigned public IP to the container. | bool | `"false"` | no |
-| task\_container\_command | The command that is passed to the container. | list(string) | `[]` | no |
-| task\_container\_environment | The environment variables to pass to a container. | map(string) | `{}` | no |
-| task\_container\_image | The image used to start a container. | string | n/a | yes |
-| task\_container\_port | The port number on the container that is bound to the user-specified or automatically assigned host port | number | n/a | yes |
-| task\_container\_protocol | Protocol that the container exposes. | string | `"HTTP"` | no |
-| task\_definition\_cpu | Amount of CPU to reserve for the task. | number | `"256"` | no |
-| task\_definition\_memory | The soft limit \(in MiB\) of memory to reserve for the container. | number | `"512"` | no |
-| task\_host\_port | The port number on the container instance to reserve for your container. | number | `"0"` | no |
-| volume | \(Optional\) A set of volume blocks that containers in your task may use. This is a list of maps, where each map should contain "name", "host\_path" and "docker\_volume\_configuration". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs\_task\_definition.html | list | `[]` | no |
-| vpc\_id | The VPC ID. | string | n/a | yes |
+|------|-------------|------|---------|:-----:|
+| capacity\_provider\_strategy | (Optional) The capacity\_provider\_strategy configuration block. This is a list of maps, where each map should contain "capacity\_provider ", "weight" and "base" | `list` | `[]` | no |
+| cluster\_id | The Amazon Resource Name (ARN) that identifies the cluster. | `string` | n/a | yes |
+| container\_name | Optional name for the container to be used instead of name\_prefix. | `string` | `""` | no |
+| deployment\_controller\_type | Type of deployment controller. Valid values: CODE\_DEPLOY, ECS. | `string` | `"ECS"` | no |
+| deployment\_maximum\_percent | The upper limit of the number of running tasks that can be running in a service during a deployment | `number` | `200` | no |
+| deployment\_minimum\_healthy\_percent | The lower limit of the number of running tasks that must remain running and healthy in a service during a deployment | `number` | `50` | no |
+| desired\_count | The number of instances of the task definitions to place and keep running. | `number` | `1` | no |
+| docker\_volume\_configuration | (Optional) Used to configure a docker volume option "docker\_volume\_configuration". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html | `list` | `[]` | no |
+| health\_check | A health block containing health check settings for the target group. Overrides the defaults. | `map(string)` | n/a | yes |
+| health\_check\_grace\_period\_seconds | Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. Only valid for services configured to use load balancers. | `number` | `300` | no |
+| lb\_arn | Arn for the LB for which the service should be attach to. | `string` | n/a | yes |
+| load\_balanced | Whether the task should be loadbalanced. | `bool` | `true` | no |
+| log\_retention\_in\_days | Number of days the logs will be retained in CloudWatch. | `number` | `30` | no |
+| logs\_kms\_key | The KMS key ARN to use to encrypt container logs. | `string` | `""` | no |
+| name\_prefix | A prefix used for naming resources. | `string` | n/a | yes |
+| placement\_constraints | (Optional) A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placement\_constraints is 10. This is a list of maps, where each map should contain "type" and "expression" | `list` | `[]` | no |
+| private\_subnet\_ids | A list of private subnets inside the VPC | `list(string)` | n/a | yes |
+| propogate\_tags | Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK\_DEFINITION. | `string` | `"TASK_DEFINITION"` | no |
+| proxy\_configuration | (Optional) The proxy configuration details for the App Mesh proxy. This is a list of maps, where each map should contain "container\_name", "properties" and "type" | `list` | `[]` | no |
+| repository\_credentials | name or ARN of a secrets manager secret (arn:aws:secretsmanager:region:aws\_account\_id:secret:secret\_name) | `string` | `""` | no |
+| repository\_credentials\_kms\_key | key id, key ARN, alias name or alias ARN of the key that encrypted the repository credentials | `string` | `"alias/aws/secretsmanager"` | no |
+| service\_registry\_arn | ARN of aws\_service\_discovery\_service resource | `string` | `""` | no |
+| tags | A map of tags (key-value pairs) passed to resources. | `map(string)` | `{}` | no |
+| target\_group\_name | The name for the tasks target group | `string` | `""` | no |
+| task\_container\_assign\_public\_ip | Assigned public IP to the container. | `bool` | `false` | no |
+| task\_container\_command | The command that is passed to the container. | `list(string)` | `[]` | no |
+| task\_container\_environment | The environment variables to pass to a container. | `map(string)` | `{}` | no |
+| task\_container\_image | The image used to start a container. | `string` | n/a | yes |
+| task\_container\_port | The port number on the container that is bound to the user-specified or automatically assigned host port | `number` | n/a | yes |
+| task\_container\_protocol | Protocol that the container exposes. | `string` | `"HTTP"` | no |
+| task\_definition\_cpu | Amount of CPU to reserve for the task. | `number` | `256` | no |
+| task\_definition\_memory | The soft limit (in MiB) of memory to reserve for the container. | `number` | `512` | no |
+| task\_health\_check | An optional healthcheck definition for the task | `object({ command = list(string), interval = number, timeout = number, retries = number, startPeriod = number })` | n/a | yes |
+| task\_host\_port | The port number on the container instance to reserve for your container. | `number` | `0` | no |
+| volume | (Optional) A set of volume blocks that containers in your task may use. This is a list of maps, where each map should contain "name", "host\_path" and "docker\_volume\_configuration". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html | `list` | `[]` | no |
+| vpc\_id | The VPC ID. | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
 | log\_group\_name | The name of the Cloudwatch log group for the task. |
-| service\_arn | The Amazon Resource Name \(ARN\) that identifies the ECS service. |
+| service\_arn | The Amazon Resource Name (ARN) that identifies the ECS service. |
 | service\_name | The name of the service. |
-| service\_sg\_id | The Amazon Resource Name \(ARN\) that identifies the service security group. |
+| service\_sg\_id | The Amazon Resource Name (ARN) that identifies the service security group. |
 | target\_group\_arn | The ARN of the Target Group used by Load Balancer. |
 | target\_group\_name | The Name of the Target Group used by Load Balancer. |
-| task\_role\_arn | The Amazon Resource Name \(ARN\) specifying the ECS service role. |
+| task\_role\_arn | The Amazon Resource Name (ARN) specifying the ECS service role. |
 | task\_role\_name | The name of the Fargate task service role. |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/main.tf b/main.tf
@@ -74,6 +74,7 @@ resource "aws_security_group_rule" "egress_service" {
 # Load Balancer Target group
 #####
 resource "aws_lb_target_group" "task" {
+  count       = var.load_balanced ? 1 : 0
   name        = var.target_group_name != "" ? var.target_group_name : "${var.name_prefix}-target-${var.task_container_port}"
   vpc_id      = var.vpc_id
   protocol    = var.task_container_protocol
@@ -158,6 +159,15 @@ resource "aws_ecs_task_definition" "task" {
       "awslogs-stream-prefix": "container"
     }
   },
+  %{if var.task_health_check != null~}
+  "healthcheck": {
+      "command": ${jsonencode(var.task_health_check.command)},
+      "interval": ${var.task_health_check.interval},
+      "timeout": ${var.task_health_check.timeout},
+      "retries": ${var.task_health_check.retries},
+      "startPeriod": ${var.task_health_check.startPeriod}
+  },
+  %{~endif}
   "command": ${jsonencode(var.task_container_command)},
   "environment": ${jsonencode(local.task_environment)}
 }]
diff --git a/outputs.tf b/outputs.tf
@@ -5,12 +5,12 @@ output "service_arn" {
 
 output "target_group_arn" {
   description = "The ARN of the Target Group used by Load Balancer."
-  value       = aws_lb_target_group.task.arn
+  value       = concat(aws_lb_target_group.task[*].arn, [""])[0]
 }
 
 output "target_group_name" {
   description = "The Name of the Target Group used by Load Balancer."
-  value       = aws_lb_target_group.task.name
+  value       = concat(aws_lb_target_group.task[*].name, [""])[0]
 }
 
 output "task_role_arn" {
diff --git a/variables.tf b/variables.tf
@@ -200,3 +200,9 @@ variable "docker_volume_configuration" {
   description = "(Optional) Used to configure a docker volume option \"docker_volume_configuration\". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html"
   default     = []
 }
+
+variable "task_health_check" {
+  type        = object({ command = list(string), interval = number, timeout = number, retries = number, startPeriod = number })
+  description = "An optional healthcheck definition for the task"
+  default     = null
+}

Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,12 @@ output "service_arn" {`
`5`	`5`
`6`	`6`	`output "target_group_arn" {`
`7`	`7`	`description = "The ARN of the Target Group used by Load Balancer."`
`8`		`- value = aws_lb_target_group.task.arn`
	`8`	`+ value = concat(aws_lb_target_group.task[*].arn, [""])[0]`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`output "target_group_name" {`
`12`	`12`	`description = "The Name of the Target Group used by Load Balancer."`
`13`		`- value = aws_lb_target_group.task.name`
	`13`	`+ value = concat(aws_lb_target_group.task[*].name, [""])[0]`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`output "task_role_arn" {`