ecs-service

Provides an ECS service - effectively a task that is expected to run until an error occurs or a user terminates it (typically a webserver or a database). This module's primary intent is to make it easier to set up a load balanced service using an existing Application Load Balancer. If using a load balancer the module will automatically create a listener rule, a target group, and security groups when in awsvpc mode. In addition, the module will automatically create a task definition if one is not supplied. This module does not support Amazon's Classic Load Balancer or Network Load Balancer.

See the ECS Services section in Amazon's ECS developer guide.

Example Usage

The containers.json file

For an ECS service that does not use an existing task definition, the set of containers that will comprise the service must be specified in the container_definition_file argument. This file is named containers.json by default, and must be a valid JSON document.

Please note that this example contains only a small subset of the available parameters. For further information, see container_definition_file argument in the Task definition block.

[
  {
    "name": "apache",
    "image": "httpd",
    "portMappings": [
      {
        "containerPort": 80
      }
    ]
  }
]

Simple Fargate service on a public subnet

module "service_name" {
  source = "git@github.com:techservicesillinois/terraform-aws-ecs-service//"

  name = "service_name"

  load_balancer = {
    name           = "load_balancer_name"
    port           = 443
    container_name = "main_container_name"
    container_port = 8080
    host_header    = "myservice.example.com"
  }

  alias = {
    domain   = "example.com"
    hostname = "myservice"
  }

  network_configuration = {
    assign_public_ip = true
    subnet_type      = "public"
    vpc              = "my-vpc"
  }
}

Simple Fargate service on a private subnet with a NAT gateway with service discovery

module "service_name" {
  source = "git@github.com:techservicesillinois/terraform-aws-ecs-service//"

  name  = "service_name"

  service_discovery = {
    namespace_id = "ns-cxn6fqejoygbxan5"
  }

  network_configuration = {
    subnet_id = "campus"
    vpc       = "my-vpc"
  }
}

Simple ECS service in bridge mode

module "service_name" {
  source = "git@github.com:techservicesillinois/terraform-aws-ecs-service//"

  name        = "service_name"
  launch_type = "EC2"

  load_balancer = {
    name           = "load_balancer_name"
    port           = 443
    container_name = "main_container_name"
    container_port = 8080
    host_header    = "myservice.example.com"
  }

  alias = {
    domain   = "example.com"
    hostname = "myservice"
  }

  task_definition = {
    network_mode = "bridge"
  }
}

ECS service using an externally defined task definition

module "service_name" {
  source = "git@github.com:techservicesillinois/terraform-aws-ecs-service//"

  name                = "service_name"
  cluster             = "cluster_name"
  launch_type         = "EC2"

  task_definition_arn = "task_definition_name:revision"
  desired_count       = 3

  load_balancer = {
    name           = "load_balancer_name"
    port           = 443
    container_name = "main_container_name"
    container_port = 8080
    host_header    = "myservice.example.com"
  }

  alias = {
    domain   = "example.com"
    hostname = "myservice"
  }

  ordered_placement_strategy = [
    {
      type  = "binpack"
      field = "cpu"
    }
  ]

  placement_constraints = [
    {
      type       = "memberOf"
      expression = "attribute:ecs.availability-zone in [us-west-2a, us-west-2b]"
    }
  ]
}

Configure autoscaling policy and cloudwatch alarms for ECS service

autoscale = {
  autoscale_max_capacity        = 5
  metric_name                   = "CPUUtilization"
  datapoints_to_alarm           = 1 
  evaluation_periods            = 1
  period                        = 60
  cooldown                      = 60
  adjustment_type               = "ChangeInCapacity"

  ### Cloudwatch Alaram Scale up and Scale down ###
  scale_up_threshold            = 70
  scale_down_threshold          = 40

  ### AutoScale Policy Scale up ###
  scale_up_comparison_operator   = "GreaterThanOrEqualToThreshold"
  scale_up_interval_lower_bound  = 1
  scale_up_adjustment            = 1
  
  ### AutoScale Policy Scale down ###
  scale_down_comparison_operator   = "LessThanThreshold"
  scale_down_interval_lower_bound  = 0
  scale_down_adjustment            = -1

}

Argument Reference

The following arguments are supported:

name - (Required) The name of the service (up to 255 letters, numbers, hyphens, and underscores).
task_definition - (Optional) A Task definition block. Task definition blocks are documented below.
task_definition_arn - (Optional) The family and revision (family:revision) or full ARN of the task definition that you want to run in your service. If given, the task definition block is ignored.
desired_count - (Optional) The number of instances of the task definition to place and keep running. Defaults to 1.
launch_type - (Optional) The launch type on which to run your service. The valid values are EC2 and FARGATE. Defaults to FARGATE.
cluster - (Optional) ARN of an ECS cluster. Defaults to default.
deployment_maximum_percent - (Optional) The upper limit (as a percentage of the service's desired_count) of the number of running tasks that can be running in a service during a deployment. Defaults to 200%.
deployment_minimum_healthy_percent - (Optional) The lower limit (as a percentage of the service's desired_count) of the number of running tasks that must remain running and healthy in a service during a deployment. Defaults to 50%.
ordered_placement_strategy - (Optional) Service level strategy rules that are taken into consideration during task placement. The maximum number of ordered_placement_strategy blocks is 5. Defined below.
health_check_grace_period_seconds - (Optional) Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 1800. Only valid for services configured to use a load balancer.
load_balancer - (Optional) A Load Balancer block. Load balancer blocks documented below.
placement_constraints - (Optional) rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Defined below.
network_configuration - (Optional) A Network Configuration block. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes.
stickiness - (Optional) A Stickiness block. Stickiness blocks are documented below.
health_check - (Optional) A Health Check block. Health Check blocks are documented below.
volume - (Optional) A set of volume blocks that containers in your task may use. Volume blocks are documented below.
service_discovery - (Optional) A Service Discovery block. This parameter is used to configure Amazon Service Discovery for the service.
service_discovery_health_check_config – (Optional) A Service Discovery health check config block that contains settings for an optional health check. Only for public DNS namespaces.
service_discovery_health_check_custom_config – (Optional) A Service Discovery custom health check config block that contains settings for ECS managed health checks.
alias – (Optional) An alias block used to define a Route 53 alias record that points to the load balancer. Requires that a load_balancer block is definied.
autoscale – (Optional) An autoscale block used to create an autoscaling configuration. Requires that a autoscale block is defined. Learn more about ECS autoscaling.
tags - Tags to be applied to resources where supported.

`autoscale`

An autoscale block supports the following for autoscale up and down policies:

autoscale_scale_up - (Optional) The name of the autoscaling policy for scale up. Default name is ('service name'-up)
autoscale_scale_down - (Optional) The name of the autoscaling policy for scale down. Default name is ('service name'-down)
adjustment_type - (Required) Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
cooldown - (Required) Seconds between scaling actions.
aggregation_type - (Optional) The aggregation type for the policy's metrics. Valid values are "Minimum", "Maximum", and "Average". Default is "Average"
scale_up_interval_lower_bound - (Optional) Difference between the alarm threshold and the CloudWatch metric. For scale down the default is -infinity if not specified.
scale_down_interval_upper_bound - (Optional) Difference between the alarm threshold and the CloudWatch metric. For scale up the default is infinity if not specified.
scale_up_adjustment - (Required) The number of members by which to scale, when the adjustment bounds are breached. A positive value scales up.
scale_down_adjustment - (Required) The number of members by which to scale, when the adjustment bounds are breached. A negative value scales down.

The ecs target configuration for scale up and down needs the following:

autoscale_max_capacity - (Optional) The maximum number of instances to run. Defaults to 5.
service_desired_count - (Optional) The minimum number of instances of task definition to run. Defaults to 1.

The cloudwatch alarm configuration for scale up and down needs the following:

autoscale_scale_up - (Optional) The name of the cloudwatch metric alarm for scale up. Default name is ('service name' up)
autoscale_scale_down - (Optional) The name of the cloudwatch metric alarm for scale down. Default name is ('service name' down)
scale_up_comparison_operator - (Required) The arithmetic operation to use when comparing the specified statistic and threshold for scale up. The specified Statistic value is used as the first operand. supported are, GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold.
scale_down_comparison_operator - (Required) The arithmetic operation to use when comparing the specified statistic and threshold for scale down. The specified Statistic value is used as the first operand. supported are, GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold.
scale_up_threshold - (Required) The value against which the specified statistic is compared for scale up.
scale_down_threshold - (Required) The value against which the specified statistic is compared for scale down.
evaluation_periods - (Required) The number of periods over which data is compared to the specified threshold.
metric_name - (Required) The name of the metric. For ECS Service predefined metrics are CPUUtilization and MemoryUtilization.
period - (Optional) The period in seconds over which the specified statistic is applied.
statistic - (Optional) The statistic to apply to the alarm's associated metric. supported are: SampleCount, Average, Sum, Minimum, Maximum. Defaults to Average.
datapoints_to_alarm - (Optional) The Number of times the metric reaches the specified threshold to trigger an alarm. Note: datapoints_to_alarm must be less than or equal to the evaluation_periods.
dimensions - (Optional) The dimensions for the alarm's associated metric. The available dimensions for ECS service are ClusterName and ServiceName.

`alias`

An alias block supports the following:

domain - (Required) The name of the Route 53 zone in which the alias record is to be created.
hostname – (Optional) The name of the host to be created in the specified Route 53 zone. Defaults to the value of the name attribute (i.e., the service name).

`load_balancer`

A load_balancer block supports the following:

name - (Required) The name of the LB.
port - (Optional) The port of the listener. Defaults to 443.
container_name - (Required) The name of the container to associate with the load balancer as it appears in the container definition (by default, containers.json).
container_port - (Required) The port on the container to associate with the load balancer as it appears in the container definition (by default, containers.json).
certificate_domain - (Optional) The domain name associated with an Amazon Certificate Manager (ACM) certificate. If specified, the certificate is looked up by the domain name, and the resulting certificate ARN is associated with the listener for the ECS service.
host_header - (Required) A hostname condition that defines a rule to forward requests to the service's target group.
path_pattern - (Optional) A path condition that defines a rule to forward requests based on the URL path. Defaults to '*'.
deregistration_delay - (Optional) The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
security_group_id - (Optional) The Security Group ARN associated with the Load Balancer. If not specified it is looked up by the name of the Load Balancer.
priority - (Optional) The priority for the rule between 1 and 50000. Leaving it unset will automatically set the rule with next available priority after currently existing highest rule. A listener can't have multiple rules with the same priority.

Note: As a result of an AWS limitation, a single load_balancer can be attached to the ECS service at most. See related docs.

`stickiness`

A stickiness block supports the following:

type - (Required) The type of sticky sessions. The only current possible value is lb_cookie.
cookie_duration - (Optional) The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
enabled - (Optional) Boolean to enable / disable stickiness. Default is true

`health_check`

A health_check block supports the following:

interval - (Optional) The approximate amount of time, in seconds, between health checks of an individual target. Minimum value 5 seconds, Maximum value 300 seconds. Default 30 seconds.
path - (Optional) The destination for the health check request. Default /.
port - (Optional) The port to use to connect with the target. Valid values are either ports 1-65536, or container_port. Defaults to container_port.
protocol - (Optional) The protocol to use to connect with the target. Defaults to HTTP.
timeout - (Optional) The amount of time, in seconds, during which no response means a failed health check. The range is 2 to 60 seconds and the default is 5 seconds.
healthy_threshold - (Optional) The number of consecutive health checks successes required before considering an unhealthy target healthy. Defaults to 3.
unhealthy_threshold - (Optional) The number of consecutive health check failures required before considering the target unhealthy. Defaults to 3.
matcher - (Optional) The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

`ordered_placement_strategy`

ordered_placement_strategy blocks support the following:

type - (Required) The type of placement strategy. Must be one of: binpack, random, or spread
field - (Optional) For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance. For the binpack type, valid values are memory and cpu. For the random type, this attribute is not needed. For more information, see Placement Strategy.

Note: ordered_placement_strategy is not supported when launch_type is FARGATE.

Note: for spread, host and instanceId will be normalized, by AWS, to be instanceId. This means the statefile will show instanceId but your config will differ if you use host.

`placement_constraints`

placement_constraints blocks support the following:

type - (Required) The type of constraint. The only valid values at this time are memberOf and distinctInstance.
expression - (Optional) Cluster Query Language expression to apply to the constraint. Does not need to be specified for the distinctInstance type. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

Note: placement_constraints is not supported when launch_type is FARGATE.

`network_configuration`

A network_configuration block supports the following:

subnet_type - (Required) Subnet type (e.g., 'campus', 'private', 'public') for resource placement.
vpc - (Optional) The name of the virtual private cloud to be associated with the task or service. NOTE: Required when using subnet_type.
subnets - (Required) The subnet IDs to associated with the task or service. NOTE: Optional when using subnet_type.
security_groups - (Optional) The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.
security_group_names - (Optional) Additonal security groups to associated with the task or service. This is a space delimited string list of security group names. This may be specified with or without security_groups in which case both lists are merged. If you do not specify a security group, the default security group for the VPC is used.
assign_public_ip - (Optional) Assign a public IP address to the ENI (Fargate launch type only). Valid values are true or false. Default false.
ports - (Optional) Ports to open on the container to outside traffic. (For FARGATE testing use only.)

For more information, see Task Networking.

Note: network_configuration is only supported when network_mode is aws_vpc.

Note: The subnet_type and subnet attributes can be used together. In this case the subnets to be associated with the service consist of the union of the subnets defined explicitly in subnet and derived from subnet_type and vpc.

`service_discovery`

A service_discovery block configures Amazon Service Discovery and supports the following:

name – (Optional) The hostname of the service. Defaults to the service name specified by the name argument.
namespace_id – (Required) The ID of the namespace to use for DNS configuration.
dns_routing_policy – (Optional) The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify the service. Valid Values: MULTIVALUE, WEIGHTED.
dns_ttl – (Optional) The amount of time, in seconds, that you want DNS resolvers to cache the settings for this resource record set. Default is 60 seconds.
dns_type – (Optional) The type of the resource, which indicates the value that Amazon Route 53 returns in response to DNS queries. Valid Values: A, AAAA, SRV, CNAME. Default is "A".

`service_discovery_health_check_config`

The following arguments are supported:

failure_threshold – (Optional) The number of consecutive health checks. Maximum value of 10.
resource_path – (Optional) The path that you want Route 53 to request when performing health checks. Route 53 automatically adds the DNS name for the service. If you don't specify a value, the default value is /.
type – (Optional) The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP

`service_discovery_health_check_custom_config`

The following arguments are supported:

failure_threshold – (Optional) The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.

`task_definition`

If a task_definition_arn is not given, a container definition will be created for the service. The name of the automatically created container definition is the same as the ECS service name. The created container definition may optionally be further modified by specifying a task_definition block with one of more of the following options:

container_definition_file - (Optional) A file containing a list of valid container definitions provided as a single JSON document. See Example Task Definitions for example container definitions, note that only the content of the containerDefinitions key in these example task definitions belongs in the specified container_definition_file. The default filename is containers.json.
task_role_arn - (Optional) The ARN of an IAM role that allows your Amazon ECS container task to make calls to other AWS services.
network_mode - (Optional) The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.
cpu - (Optional) The number of cpu units used by the task. Supported for FARGATE only, defaults to 256 (0.25 vCPU).
memory - (Optional) The amount (in MiB) of memory used by the task. Supported for FARGATE only, defaults to 512.

`volume`

A volume block supports the following:

name - (Required) The name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
host_path - (Optional) The path on the host container instance that is presented to the container. If not set, ECS will create a non persistent data volume that starts empty and is deleted after the task has finished.
docker_volume_configuration - (Optional, but see note) Used to configure a Docker volume. NOTE: Due to limitations in Terraform object typing, either a valid docker_volume_configuration map or the value null must be specified.
efs_volume_configuration - (Optional, but see note) Used to configure an EFS volume. NOTE: Due to limitations in Terraform object typing, either a valid efs_volume_configuration map or the value null must be specified.

volume = [
    {
      name      = "docker-volume"
      host_path = null

      docker_volume_configuration = null   # Needs to be specified as null, even if not used.
      efs_volume_configuration    = null   # Needs to be specified as null, even if not used.
    }
 ]

`docker_volume_configuration`

A docker_volume_configuration block appears within a volume block, and supports the following:

scope - (Optional) The scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
autoprovision - (Optional) If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
driver - (Optional) The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
driver_opts - (Optional) A map of Docker driver specific options.
`labels - (Optional) A map of custom metadata to add to your Docker volume.

For more information, see Specifying a Docker volume in your Task Definition Developer Guide

`efs_volume_configuration`

An efs_volume_configuration block appears within a volume block, and supports the following:

file_system_id - (Required) The ID of the EFS File System.
root_directory - (Optional) The path to mount on the host.

volume = [
    {
      name = "efs-volume"
      host_path = null

      docker_volume_configuration = null

      efs_volume_configuration = {
        file_system_id = "fs-012345678"
        root_directory = null
      }
    }
 ]

For more information, see Specifying an Amazon EFS File System in your Task Definition.

Attributes Reference

The following attributes are exported:

id - The Amazon Resource Name (ARN) that identifies the service
fqdn – The fully qualified domain name of the Route 53 record for the service. Only created when an alias block is provided.
target_group_arn - The ARN of the Target Group created when a load_balancer block is given
task_definition_arn - Full ARN of the Task Definition created for the service when a task_definition_arn is not given
security_group_id - The ID of the security group created for the service (awsvpc mode only)
subnet_ids – A list of subnet IDs associated with the service.

Credits

Nota bene: The vast majority of the verbiage on this page was taken directly from the Terraform manual, and in a few cases from Amazon's documentation.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

ecs-service

Example Usage

The containers.json file

Simple Fargate service on a public subnet

Simple Fargate service on a private subnet with a NAT gateway with service discovery

Simple ECS service in bridge mode

ECS service using an externally defined task definition

Configure autoscaling policy and cloudwatch alarms for ECS service

Argument Reference

`autoscale`

`alias`

`load_balancer`

`stickiness`

`health_check`

`ordered_placement_strategy`

`placement_constraints`

`network_configuration`

`service_discovery`

`service_discovery_health_check_config`

`service_discovery_health_check_custom_config`

`task_definition`

`volume`

`docker_volume_configuration`

`efs_volume_configuration`

Attributes Reference

Credits

Files

README.md

Latest commit

History

README.md

File metadata and controls

ecs-service

Example Usage

The containers.json file

Simple Fargate service on a public subnet

Simple Fargate service on a private subnet with a NAT gateway with service discovery

Simple ECS service in bridge mode

ECS service using an externally defined task definition

Configure autoscaling policy and cloudwatch alarms for ECS service

Argument Reference

autoscale

alias

load_balancer

stickiness

health_check

ordered_placement_strategy

placement_constraints

network_configuration

service_discovery

service_discovery_health_check_config

service_discovery_health_check_custom_config

task_definition

volume

docker_volume_configuration

efs_volume_configuration

Attributes Reference

Credits

`autoscale`

`alias`

`load_balancer`

`stickiness`

`health_check`

`ordered_placement_strategy`

`placement_constraints`

`network_configuration`

`service_discovery`

`service_discovery_health_check_config`

`service_discovery_health_check_custom_config`

`task_definition`

`volume`

`docker_volume_configuration`

`efs_volume_configuration`