Break down task health check into two variables (#48)

Author: Abdul Wahid

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.4.0
+  rev: v4.0.1
   hooks:
   - id: check-added-large-files
     args: ['--maxkb=500']
@@ -18,7 +18,7 @@ repos:
     args: ['--allow-missing-credentials']
   - id: trailing-whitespace
 - repo: git://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.50.0
+  rev: v1.60.0
   hooks:
   - id: terraform_fmt
   - id: terraform_docs

CHANGELOG.md

@@ -5,7 +5,25 @@ All notable changes to this project will be documented in this file.
 <a name="unreleased"></a>
 ## [Unreleased]
 
-- Make deregistration_delay attribute customizable for ALB Target Groups
+- Break down task health check into two variables
+
+
+<a name="6.4.0"></a>
+## [6.4.0] - 2021-10-20
+
+- Add ephemeral_storage ([#47](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/47))
+
+
+<a name="6.3.0"></a>
+## [6.3.0] - 2021-09-30
+
+- Added pseudo_terminal attribute ([#45](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/45))
+
+
+<a name="6.2.2"></a>
+## [6.2.2] - 2021-08-20
+
+- Make deregistration_delay attribute customizable for ALB Target Groups ([#42](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/42))
 
 
 <a name="6.2.1"></a>
@@ -200,7 +218,10 @@ All notable changes to this project will be documented in this file.
 - Initial commit
 
 
-[Unreleased]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.2.1...HEAD
+[Unreleased]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.4.0...HEAD
+[6.4.0]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.3.0...6.4.0
+[6.3.0]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.2.2...6.3.0
+[6.2.2]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.2.1...6.2.2
 [6.2.1]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.2.0...6.2.1
 [6.2.0]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.1.0...6.2.0
 [6.1.0]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/6.0.0...6.1.0

README.md

@@ -162,13 +162,15 @@ No modules.
 | <a name="input_task_container_secrets"></a> [task\_container\_secrets](#input\_task\_container\_secrets) | The secrets variables to pass to a container. | `list(map(string))` | `null` | no |
 | <a name="input_task_container_working_directory"></a> [task\_container\_working\_directory](#input\_task\_container\_working\_directory) | The working directory to run commands inside the container. | `string` | `""` | no |
 | <a name="input_task_definition_cpu"></a> [task\_definition\_cpu](#input\_task\_definition\_cpu) | Amount of CPU to reserve for the task. | `number` | `256` | no |
+| <a name="input_task_definition_ephemeral_storage"></a> [task\_definition\_ephemeral\_storage](#input\_task\_definition\_ephemeral\_storage) | The total amount, in GiB, of ephemeral storage to set for the task. | `number` | `0` | no |
 | <a name="input_task_definition_memory"></a> [task\_definition\_memory](#input\_task\_definition\_memory) | The soft limit (in MiB) of memory to reserve for the task. | `number` | `512` | no |
-| <a name="input_task_health_check"></a> [task\_health\_check](#input\_task\_health\_check) | An optional healthcheck definition for the task | `object({ command = list(string), interval = number, timeout = number, retries = number, startPeriod = number })` | `null` | no |
+| <a name="input_task_health_check"></a> [task\_health\_check](#input\_task\_health\_check) | An optional healthcheck definition for the task | `map(number)` | `null` | no |
+| <a name="input_task_health_command"></a> [task\_health\_command](#input\_task\_health\_command) | A string array representing the command that the container runs to determine if it is healthy. | `list(string)` | <pre>[<br>  ""<br>]</pre> | no |
 | <a name="input_task_host_port"></a> [task\_host\_port](#input\_task\_host\_port) | The port number on the container instance to reserve for your container. | `number` | `0` | no |
 | <a name="input_task_mount_points"></a> [task\_mount\_points](#input\_task\_mount\_points) | The mount points for data volumes in your container. Each object inside the list requires "sourceVolume", "containerPath" and "readOnly". For more information see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html | `list(object({ sourceVolume = string, containerPath = string, readOnly = bool }))` | `null` | no |
+| <a name="input_task_pseudo_terminal"></a> [task\_pseudo\_terminal](#input\_task\_pseudo\_terminal) | Allocate TTY in the container | `bool` | `null` | no |
 | <a name="input_task_start_timeout"></a> [task\_start\_timeout](#input\_task\_start\_timeout) | Time duration (in seconds) to wait before giving up on resolving dependencies for a container. If this parameter is not specified, the default value of 3 minutes is used (fargate). | `number` | `null` | no |
 | <a name="input_task_stop_timeout"></a> [task\_stop\_timeout](#input\_task\_stop\_timeout) | Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. | `number` | `null` | no |
-| <a name="input_task_pseudo_terminal"></a> [task\_pseudo\_terminal](#input\_task\_pseudo\_terminal) | Allocate TTY to the container's task. | `bool` | `null` | no |
 | <a name="input_volume"></a> [volume](#input\_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", "docker\_volume\_configuration" and "efs\_volume\_configuration". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html | `list` | `[]` | no |
 | <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The VPC ID. | `string` | n/a | yes |
 | <a name="input_wait_for_steady_state"></a> [wait\_for\_steady\_state](#input\_wait\_for\_steady\_state) | If true, Terraform will wait for the service to reach a steady state (like aws ecs wait services-stable) before continuing. | `bool` | `false` | no |

examples/core/main.tf

@@ -108,6 +108,10 @@ module "fargate" {
     }
   ]
 
+  task_health_check = {
+    timeout = 60
+  }
+
   health_check = {
     port = "traffic-port"
     path = "/"
@@ -139,4 +143,3 @@ resource "aws_security_group_rule" "test_sg_ingress" {
   to_port                  = 3022
   source_security_group_id = module.fargate.service_sg_id
 }
-

main.tf

@@ -157,7 +157,7 @@ resource "aws_ecs_task_definition" "task" {
       size_in_gib = var.task_definition_ephemeral_storage
     }
   }
-  
+
   container_definitions = <<EOF
 [{
   "name": "${var.container_name != "" ? var.container_name : var.name_prefix}",
@@ -189,13 +189,13 @@ resource "aws_ecs_task_definition" "task" {
       "awslogs-stream-prefix": "container"
     }
   },
-  %{if var.task_health_check != null~}
+  %{if var.task_health_check != null || var.task_health_command != 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}
+    "command": ${jsonencode(var.task_health_command)},
+    "interval": ${lookup(var.task_health_check, "interval", 30)},
+    "timeout": ${lookup(var.task_health_check, "timeout", 5)},
+    "retries": ${lookup(var.task_health_check, "retries", 3)},
+    "startPeriod": ${lookup(var.task_health_check, "startPeriod", 0)}
   },
   %{~endif}
   "command": ${jsonencode(var.task_container_command)},

variables.tf

@@ -217,8 +217,14 @@ variable "volume" {
   default     = []
 }
 
+variable "task_health_command" {
+  type        = list(string)
+  description = "A string array representing the command that the container runs to determine if it is healthy."
+  default     = [""]
+}
+
 variable "task_health_check" {
-  type        = object({ command = list(string), interval = number, timeout = number, retries = number, startPeriod = number })
+  type        = map(number)
   description = "An optional healthcheck definition for the task"
   default     = null
 }