Add support for additional variables and configuration options. (#12)

Author: marcincuber

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
     args: ['--allow-missing-credentials']
   - id: trailing-whitespace
 - repo: git://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.25.0
+  rev: v1.29.0
   hooks:
   - id: terraform_fmt
   - id: terraform_docs

README.md

@@ -88,7 +88,6 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](http
 | 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 |
@@ -97,6 +96,7 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](http
 | 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 |
+| platform\_version | The platform version on which to run your service. Only applicable for launch\_type set to FARGATE. | `string` | `"LATEST"` | 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 |
@@ -107,15 +107,19 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](http
 | 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\_cpu | Amount of CPU to reserve for the container. | `number` | n/a | yes |
 | 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\_memory | The hard limit (in MiB) of memory for the container. | `number` | n/a | yes |
+| task\_container\_memory\_reservation | The soft limit (in MiB) of memory to reserve for the container. | `number` | 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\_container\_working\_directory | The working directory to run commands inside the container. | `string` | `""` | 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\_definition\_memory | The soft limit (in MiB) of memory to reserve for the task. | `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 |
+| 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 |
 | vpc\_id | The VPC ID. | `string` | n/a | yes |
 
 ## Outputs

examples/core/main.tf

@@ -83,6 +83,8 @@ module "fargate" {
   lb_arn             = module.alb.arn
   cluster_id         = aws_ecs_cluster.cluster.id
 
+  platform_version = "1.4.0" # defaults to LATEST
+
   task_container_image   = "marcincuber/2048-game:latest"
   task_definition_cpu    = 256
   task_definition_memory = 512

main.tf

@@ -161,14 +161,26 @@ resource "aws_ecs_task_definition" "task" {
   },
   %{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}
+    "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)},
+  %{if var.task_container_working_directory != ""~}
+  "workingDirectory": ${var.task_container_working_directory},
+  %{~endif}
+  %{if var.task_container_memory != null~}
+  "memory": ${var.task_container_memory},
+  %{~endif}
+  %{if var.task_container_memory_reservation != null~}
+  "memoryReservation": ${var.task_container_memory_reservation},
+  %{~endif}
+  %{if var.task_container_cpu != null~}
+  "cpu": ${var.task_container_cpu},
+  %{~endif}
   "environment": ${jsonencode(local.task_environment)}
 }]
 EOF
@@ -197,7 +209,7 @@ EOF
       host_path = lookup(volume.value, "host_path", null)
 
       dynamic "docker_volume_configuration" {
-        for_each = var.docker_volume_configuration
+        for_each = lookup(volume.value, "docker_volume_configuration", [])
         content {
           scope         = lookup(docker_volume_configuration.value, "scope", null)
           autoprovision = lookup(docker_volume_configuration.value, "autoprovision", null)
@@ -206,6 +218,14 @@ EOF
           labels        = lookup(docker_volume_configuration.value, "labels", null)
         }
       }
+
+      dynamic "efs_volume_configuration" {
+        for_each = lookup(volume.value, "efs_volume_configuration", [])
+        content {
+          file_system_id = lookup(efs_volume_configuration.value, "file_system_id", null)
+          root_directory = lookup(efs_volume_configuration.value, "root_directory", null)
+        }
+      }
     }
   }
 
@@ -218,13 +238,17 @@ EOF
 }
 
 resource "aws_ecs_service" "service" {
-  depends_on                         = [null_resource.lb_exists]
-  name                               = var.name_prefix
-  cluster                            = var.cluster_id
-  task_definition                    = aws_ecs_task_definition.task.arn
-  desired_count                      = var.desired_count
-  propagate_tags                     = var.propogate_tags
-  launch_type                        = length(var.capacity_provider_strategy) == 0 ? "FARGATE" : null
+  name = var.name_prefix
+
+  cluster         = var.cluster_id
+  task_definition = aws_ecs_task_definition.task.arn
+
+  desired_count  = var.desired_count
+  propagate_tags = var.propogate_tags
+
+  platform_version = var.platform_version
+  launch_type      = length(var.capacity_provider_strategy) == 0 ? "FARGATE" : null
+
   deployment_minimum_healthy_percent = var.deployment_minimum_healthy_percent
   deployment_maximum_percent         = var.deployment_maximum_percent
   health_check_grace_period_seconds  = var.load_balanced ? var.health_check_grace_period_seconds : null
@@ -272,6 +296,8 @@ resource "aws_ecs_service" "service" {
       Name = "${var.name_prefix}-service"
     },
   )
+
+  depends_on = [null_resource.lb_exists]
 }
 
 # HACK: The workaround used in ecs/service does not work for some reason in this module, this fixes the following error:

variables.tf

@@ -24,6 +24,11 @@ variable "cluster_id" {
   type        = string
 }
 
+variable "platform_version" {
+  description = "The platform version on which to run your service. Only applicable for launch_type set to FARGATE."
+  default     = "LATEST"
+}
+
 variable "task_container_image" {
   description = "The image used to start a container."
   type        = string
@@ -70,7 +75,7 @@ variable "task_definition_cpu" {
 }
 
 variable "task_definition_memory" {
-  description = "The soft limit (in MiB) of memory to reserve for the container."
+  description = "The soft limit (in MiB) of memory to reserve for the task."
   default     = 512
   type        = number
 }
@@ -191,18 +196,36 @@ variable "proxy_configuration" {
 
 variable "volume" {
   type        = list
-  description = "(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"
-  default     = []
-}
-
-variable "docker_volume_configuration" {
-  type        = list
-  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"
+  description = "(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"
   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
-}
+}
+
+variable "task_container_cpu" {
+  description = "Amount of CPU to reserve for the container."
+  default     = null
+  type        = number
+}
+
+variable "task_container_memory" {
+  description = "The hard limit (in MiB) of memory for the container."
+  default     = null
+  type        = number
+}
+
+variable "task_container_memory_reservation" {
+  description = "The soft limit (in MiB) of memory to reserve for the container."
+  default     = null
+  type        = number
+}
+
+variable "task_container_working_directory" {
+  description = "The working directory to run commands inside the container."
+  default     = ""
+  type        = string
+}