Skip to content

Latest commit

 

History

History
127 lines (105 loc) · 16.6 KB

README.md

File metadata and controls

127 lines (105 loc) · 16.6 KB
Raw

nventive

terraform-aws-ecs-container-definition

License Latest Release

Terraform module to generate an ECS container definition.

Examples

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

module "container_definition" {
  source = "nventive/ecs-container-definition/aws"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  container_name = "test"
  environment = [{
    name  = "NODE_ENV"
    value = "production"
  }]
}

Requirements

Name Version
terraform >= 0.13.0
aws >= 4.9
null >= 2.0

Providers

No providers.

Modules

Name Source Version
container_definition cloudposse/ecs-container-definition/aws 0.58.2

Resources

No resources.

Inputs

Name Description Type Default Required
command The command that is passed to the container list(string) null no
container_cpu 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 number 0 no
container_definition Container definition overrides which allows for extra keys or overriding existing keys. map(any) {} no
container_depends_on 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. The condition can be one of START, COMPLETE, SUCCESS or HEALTHY 
list(object({
    containerName = string
    condition     = string
  }))
 null no
container_image The image used to start the container. Images in the Docker Hub registry available by default string n/a yes
container_memory The amount of memory (in MiB) to allow the container to use. This is a hard limit, if the container attempts to exceed the container_memory, the container is killed. This field is optional for Fargate launch type and the total amount of container_memory of all containers in a task will need to be lower than the task memory value number null no
container_memory_reservation The amount of memory (in MiB) to reserve for the container. If container needs to exceed this threshold, it can do so up to the set container_memory hard limit number null no
container_name The name of the container. Up to 255 characters ([a-z], [A-Z], [0-9], -, _ allowed) string n/a yes
disable_networking When this parameter is true, networking is disabled within the container. bool null no
dns_search_domains Container DNS search domains. A list of DNS search domains that are presented to the container list(string) null no
dns_servers Container DNS servers. This is a list of strings specifying the IP addresses of the DNS servers list(string) null no
docker_labels The configuration options to send to the docker_labels map(string) null no
docker_security_options A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. list(string) null no
entrypoint The entry point that is passed to the container list(string) null no
environment The environment variables to pass to the container. This is a list of maps. map_environment overrides environment 
list(object({
    name  = string
    value = string
  }))
 [] no
environment_extra Extra environment variables to pass to the container. This will be merged with environment and will take precedence over already defined variables 
list(object({
    name  = string
    value = string
  }))
 [] no
environment_files One or more files containing the environment variables to pass to the container. This maps to the --env-file option to docker run. The file must be hosted in Amazon S3. This option is only available to tasks using the EC2 launch type. This is a list of maps 
list(object({
    value = string
    type  = string
  }))
 null no
essential 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 bool true no
extra_hosts A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This is a list of maps 
list(object({
    ipAddress = string
    hostname  = string
  }))
 null no
firelens_configuration 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 
object({
    type    = string
    options = map(string)
  })
 null no
healthcheck 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) 
object({
    command     = list(string)
    retries     = number
    timeout     = number
    interval    = number
    startPeriod = number
  })
 null no
hostname The hostname to use for your container. string null no
interactive When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. bool null no
links List of container names this container can communicate with without port mappings list(string) null no
linux_parameters 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 
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
    }))
  })
 null no
log_configuration 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 any null no
map_environment The environment variables to pass to the container. This is a map of string: {key: value}. map_environment overrides environment map(string) null no
map_secrets The secrets variables to pass to the container. This is a map of string: {key: value}. map_secrets overrides secrets map(string) null no
mount_points Container mount points. This is a list of maps, where each map should contain containerPath, sourceVolume and readOnly 
list(object({
    containerPath = string
    sourceVolume  = string
    readOnly      = bool
  }))
 [] no
port_mappings 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 
list(object({
    containerPort = number
    hostPort      = number
    protocol      = string
  }))
 [] no
privileged When this variable is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter is not supported for Windows containers or tasks using the Fargate launch type. bool null no
pseudo_terminal When this parameter is true, a TTY is allocated. bool null no
readonly_root_filesystem 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 bool false no
repository_credentials 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 map(string) null no
resource_requirements The type and amount of a resource to assign to a container. The only supported resource is a GPU. 
list(object({
    type  = string
    value = string
  }))
 null no
secrets The secrets to pass to the container. This is a list of maps 
list(object({
    name      = string
    valueFrom = string
  }))
 [] no
secrets_extra Extra secrets to pass to the container. This will be merged with secrets and will take precedence over already secrets 
list(object({
    name      = string
    valueFrom = string
  }))
 [] no
start_timeout Time duration (in seconds) to wait before giving up on resolving dependencies for a container number null no
stop_timeout Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own number null no
system_controls 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 = ""} list(map(string)) null no
ulimits Container ulimit settings. This is a list of maps, where each map should contain "name", "hardLimit" and "softLimit" 
list(object({
    name      = string
    hardLimit = number
    softLimit = number
  }))
 null no
user The user to run as inside the container. Can be any of these formats: user, user:group, uid, uid:gid, user:gid, uid:group. The default (null) will use the container's configured USER directive or root if not set. string null no
volumes_from 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) 
list(object({
    sourceContainer = string
    readOnly        = bool
  }))
 [] no
working_directory The working directory to run commands inside the container string null no

Outputs

Name Description
json_map_encoded JSON string encoded container definitions for use with other terraform resources such as aws_ecs_task_definition.
json_map_encoded_list JSON string encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition.
json_map_object JSON map encoded container definition.
sensitive_json_map_encoded JSON string encoded container definitions for use with other terraform resources such as aws_ecs_task_definition (sensitive).
sensitive_json_map_encoded_list JSON string encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition (sensitive).
sensitive_json_map_object JSON map encoded container definition (sensitive).

Breaking Changes

Please consult BREAKING_CHANGES.md for more information about version history and compatibility.

Contributing

Please read CONTRIBUTING.md for details on the process for contributing to this project.

Be mindful of our Code of Conduct.

We're hiring

Look for current openings on BambooHR https://nventive.bamboohr.com/careers/

Stay in touch

nventive.com | Linkedin | Instagram | YouTube | Spotify