Adding volume configuration

Author: jnonino

README.md

@@ -17,7 +17,7 @@ Check versions for this module on:
 
         module "td" {
             source          = "cn-terraform/ecs-fargate-task-definition/aws"
-            version         = "1.0.8"
+            version         = "1.0.9"
             name_preffix    = var.name_preffix
             profile         = var.profile
             region          = var.region

main.tf

@@ -25,13 +25,13 @@ resource "aws_iam_role_policy_attachment" "ecs_task_execution_role_policy_attach
 # Container Definition
 module "container_definition" {
   source  = "cloudposse/ecs-container-definition/aws"
-  version = "0.21.0"
+  version = "0.23.0"
 
   container_name               = var.container_name
   container_image              = var.container_image
   container_memory             = var.container_memory
   container_memory_reservation = var.container_memory_reservation
-  port_mappings                = local.port_mappings
+  port_mappings                = var.port_mappings
   healthcheck                  = var.healthcheck
   container_cpu                = var.container_cpu
   essential                    = var.essential
@@ -41,6 +41,9 @@ module "container_definition" {
   environment                  = var.environment
   secrets                      = var.secrets
   readonly_root_filesystem     = var.readonly_root_filesystem
+  linux_parameters             = var.linux_parameters
+  log_configuration            = var.log_configuration
+  firelens_configuration       = var.firelens_configuration
   mount_points                 = var.mount_points
   dns_servers                  = var.dns_servers
   ulimits                      = var.ulimits
@@ -53,8 +56,6 @@ module "container_definition" {
   start_timeout                = var.start_timeout
   stop_timeout                 = var.stop_timeout
   system_controls              = var.system_controls
-  firelens_configuration       = var.firelens_configuration
-  log_configuration            = var.log_configuration
 }
 
 # Task Definition
@@ -82,5 +83,34 @@ resource "aws_ecs_task_definition" "td" {
       type           = lookup(proxy_configuration.value, "type", null)
     }
   }
+  dynamic "volume" {
+    for_each = var.volumes
+    content {
+      host_path = lookup(volume.value, "host_path", null)
+      name      = volume.value.name
+
+      dynamic "docker_volume_configuration" {
+        for_each = lookup(volume.value, "docker_volume_configuration", [])
+        content {
+          autoprovision = lookup(docker_volume_configuration.value, "autoprovision", null)
+          driver        = lookup(docker_volume_configuration.value, "driver", null)
+          driver_opts   = lookup(docker_volume_configuration.value, "driver_opts", null)
+          labels        = lookup(docker_volume_configuration.value, "labels", null)
+          scope         = lookup(docker_volume_configuration.value, "scope", 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)
+        }
+      }
+    }
+  }
 }
 
+
+
+# inference_accelerator - (Optional) Configuration block(s) with Inference Accelerators settings. Detailed below.

variables.tf

@@ -32,21 +32,24 @@ variable "container_name" {
 }
 
 variable "command" {
-  type        = list(string)
   description = "(Optional) The command that is passed to the container"
+  type        = list(string)
   default     = null
 }
 
 variable "container_cpu" {
   # https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html#fargate-task-defs
   description = "(Optional) The number of cpu units to reserve for the container. This is optional for tasks using Fargate launch type and the total amount of container_cpu of all containers in a task will need to be lower than the task-level cpu value"
-  default     = 1024 # 1 vCPU 
+  default     = 1024 # 1 vCPU
 }
 
 variable "container_depends_on" {
-  type        = list(string)
   description = "(Optional) The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed"
-  default     = null
+  type = list(object({
+    containerName = string
+    condition     = string
+  }))
+  default = null
 }
 
 variable "container_memory" {
@@ -68,63 +71,91 @@ variable "dns_servers" {
 }
 
 variable "docker_labels" {
-  type        = map(string)
   description = "(Optional) The configuration options to send to the `docker_labels`"
+  type        = map(string)
   default     = null
 }
 
 variable "entrypoint" {
-  type        = list(string)
   description = "(Optional) The entry point that is passed to the container"
+  type        = list(string)
   default     = null
 }
 
 variable "environment" {
+  description = "(Optional) The environment variables to pass to the container. This is a list of maps"
   type = list(object({
     name  = string
     value = string
   }))
-  description = "(Optional) The environment variables to pass to the container. This is a list of maps"
-  default     = null
+  default = null
 }
 
 variable "essential" {
-  type        = bool
   description = "(Optional) Determines whether all other containers in a task are stopped, if this container fails or stops for any reason. Due to how Terraform type casts booleans in json it is required to double quote this value"
+  type        = bool
   default     = true
 }
 
 # https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FirelensConfiguration.html
 variable "firelens_configuration" {
+  description = "(Optional) The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FirelensConfiguration.html"
   type = object({
     type    = string
     options = map(string)
   })
-  description = "(Optional) The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FirelensConfiguration.html"
-  default     = null
+  default = null
 }
 
 # https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html
 variable "healthcheck" {
+  description = "(Optional) A map containing command (string), timeout, interval (duration in seconds), retries (1-10, number of times to retry before marking container unhealthy), and startPeriod (0-300, optional grace period to wait, in seconds, before failed healthchecks count toward retries)"
   type = object({
     command     = list(string)
     retries     = number
     timeout     = number
     interval    = number
     startPeriod = number
   })
-  description = "(Optional) A map containing command (string), timeout, interval (duration in seconds), retries (1-10, number of times to retry before marking container unhealthy), and startPeriod (0-300, optional grace period to wait, in seconds, before failed healthchecks count toward retries)"
-  default     = null
+  default = null
 }
 
 variable "links" {
-  type        = list(string)
   description = "(Optional) List of container names this container can communicate with without port mappings"
+  type        = list(string)
   default     = null
 }
 
+# https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LinuxParameters.html
+variable "linux_parameters" {
+  description = "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LinuxParameters.html"
+  type = object({
+    capabilities = object({
+      add  = list(string)
+      drop = list(string)
+    })
+    devices = list(object({
+      containerPath = string
+      hostPath      = string
+      permissions   = list(string)
+    }))
+    initProcessEnabled = bool
+    maxSwap            = number
+    sharedMemorySize   = number
+    swappiness         = number
+    tmpfs = list(object({
+      containerPath = string
+      mountOptions  = list(string)
+      size          = number
+    }))
+  })
+
+  default = null
+}
+
 # https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html
 variable "log_configuration" {
+  description = "(Optional) Log configuration options to send to a custom log driver for the container. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html"
   type = object({
     logDriver = string
     options   = map(string)
@@ -133,48 +164,53 @@ variable "log_configuration" {
       valueFrom = string
     }))
   })
-  description = "(Optional) Log configuration options to send to a custom log driver for the container. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html"
-  default     = null
+  default = null
 }
 
 variable "mount_points" {
+  description = "(Optional) Container mount points. This is a list of maps, where each map should contain a `containerPath` and `sourceVolume`"
   type = list(object({
     containerPath = string
     sourceVolume  = string
   }))
-  description = "(Optional) Container mount points. This is a list of maps, where each map should contain a `containerPath` and `sourceVolume`"
-  default     = null
+  default = null
 }
 
-locals {
-  port_mappings = [
+variable "port_mappings" {
+  description = "The port mappings to configure for the container. This is a list of maps. Each map should contain \"containerPort\", \"hostPort\", and \"protocol\", where \"protocol\" is one of \"tcp\" or \"udp\". If using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort"
+  type = list(object({
+    containerPort = number
+    hostPort      = number
+    protocol      = string
+  }))
+  default = [
     {
-      "containerPort" = var.container_port
-      "hostPort"      = var.container_port
-      "protocol"      = "HTTP"
-    },
+      containerPort = 80
+      hostPort      = 80
+      protocol      = "tcp"
+    }
   ]
 }
 
 variable "readonly_root_filesystem" {
-  type        = bool
   description = "(Optional) Determines whether a container is given read-only access to its root filesystem. Due to how Terraform type casts booleans in json it is required to double quote this value"
+  type        = bool
   default     = false
 }
 
 variable "repository_credentials" {
-  type        = map(string)
   description = "(Optional) Container repository credentials; required when using a private repo.  This map currently supports a single key; \"credentialsParameter\", which should be the ARN of a Secrets Manager's secret holding the credentials"
+  type        = map(string)
   default     = null
 }
 
 variable "secrets" {
+  description = "(Optional) The secrets to pass to the container. This is a list of maps"
   type = list(object({
     name      = string
     valueFrom = string
   }))
-  description = "(Optional) The secrets to pass to the container. This is a list of maps"
-  default     = null
+  default = null
 }
 
 variable "start_timeout" {
@@ -183,60 +219,79 @@ variable "start_timeout" {
 }
 
 variable "system_controls" {
-  type        = list(map(string))
   description = "(Optional) A list of namespaced kernel parameters to set in the container, mapping to the --sysctl option to docker run. This is a list of maps: { namespace = \"\", value = \"\"}"
+  type        = list(map(string))
   default     = null
 }
 
 variable "stop_timeout" {
-  type        = number
   description = "(Optional) Timeout in seconds between sending SIGTERM and SIGKILL to container"
+  type        = number
   default     = 30
 }
 
 variable "ulimits" {
+  description = "(Optional) Container ulimit settings. This is a list of maps, where each map should contain \"name\", \"hardLimit\" and \"softLimit\""
   type = list(object({
     name      = string
     hardLimit = number
     softLimit = number
   }))
-  description = "(Optional) Container ulimit settings. This is a list of maps, where each map should contain \"name\", \"hardLimit\" and \"softLimit\""
-  default     = null
+  default = null
 }
 
 variable "user" {
-  type        = string
   description = "(Optional) The user to run as inside the container. Can be any of these formats: user, user:group, uid, uid:gid, user:gid, uid:group"
+  type        = string
   default     = null
 }
 
 variable "volumes_from" {
+  description = "(Optional) A list of VolumesFrom maps which contain \"sourceContainer\" (name of the container that has the volumes to mount) and \"readOnly\" (whether the container can write to the volume)"
   type = list(object({
     sourceContainer = string
     readOnly        = bool
   }))
-  description = "(Optional) A list of VolumesFrom maps which contain \"sourceContainer\" (name of the container that has the volumes to mount) and \"readOnly\" (whether the container can write to the volume)"
-  default     = null
+  default = null
 }
 
 variable "working_directory" {
-  type        = string
   description = "(Optional) The working directory to run commands inside the container"
+  type        = string
   default     = null
 }
 
 # ---------------------------------------------------------------------------------------------------------------------
 # AWS ECS Task Definition Variables
 # ---------------------------------------------------------------------------------------------------------------------
 variable "placement_constraints" {
-  type        = list
   description = "(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\""
+  type        = list
   default     = []
 }
 
 variable "proxy_configuration" {
-  type        = list
   description = "(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\""
+  type        = list
   default     = []
 }
 
+variable "volumes" {
+  description = "(Optional) A set of volume blocks that containers in your task may use"
+  type = list(object({
+    host_path = string
+    name      = string
+    docker_volume_configuration = list(object({
+      autoprovision = bool
+      driver        = string
+      driver_opts   = map(string)
+      labels        = map(string)
+      scope         = string
+    }))
+    efs_volume_configuration = list(object({
+      file_system_id = string
+      root_directory = string
+    }))
+  }))
+  default = []
+}