A Terraform module which implements a web app on ECS and supporting AWS resources.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
IMPORTANT: The master
branch is used in source
just as an example. In your code, do not pin to master
because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z
) of one of our latest releases.
For a complete example, see examples/complete.
For automated tests of the complete example using bats and Terratest (which test and deploy the example on AWS), see test.
Other examples:
- without authentication - without authentication
- with Google OIDC authentication - with Google OIDC authentication
- with Cognito authentication - with Cognito authentication
module "default_backend_web_app" {
source = "git::https://github.com/cloudposse/terraform-aws-ecs-web-app.git?ref=master"
namespace = "eg"
stage = "testing"
name = "appname"
vpc_id = module.vpc.vpc_id
alb_ingress_unauthenticated_listener_arns = module.alb.listener_arns
alb_ingress_unauthenticated_listener_arns_count = 1
aws_logs_region = "us-east-2"
ecs_cluster_arn = aws_ecs_cluster.default.arn
ecs_cluster_name = aws_ecs_cluster.default.name
ecs_security_group_ids = [module.vpc.vpc_default_security_group_id]
ecs_private_subnet_ids = module.subnets.private_subnet_ids
alb_ingress_healthcheck_path = "/healthz"
alb_ingress_unauthenticated_paths = ["/*"]
codepipeline_enabled = false
environment = [
{
name = "COOKIE"
value = "cookiemonster"
},
{
name = "PORT"
value = "80"
}
]
}
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Description | Type | Default | Required |
---|---|---|---|---|
alb_arn_suffix | ARN suffix of the ALB for the Target Group | string | `` | no |
alb_ingress_authenticated_hosts | Authenticated hosts to match in Hosts header | list(string) | <list> |
no |
alb_ingress_authenticated_listener_arns | A list of authenticated ALB listener ARNs to attach ALB listener rules to | list(string) | <list> |
no |
alb_ingress_authenticated_listener_arns_count | The number of authenticated ARNs in alb_ingress_authenticated_listener_arns . This is necessary to work around a limitation in Terraform where counts cannot be computed |
number | 0 |
no |
alb_ingress_authenticated_paths | Authenticated path pattern to match (a maximum of 1 can be defined) | list(string) | <list> |
no |
alb_ingress_healthcheck_path | The path of the healthcheck which the ALB checks | string | / |
no |
alb_ingress_listener_authenticated_priority | The priority for the rules with authentication, between 1 and 50000 (1 being highest priority). Must be different from alb_ingress_listener_unauthenticated_priority since a listener can't have multiple rules with the same priority |
number | 300 |
no |
alb_ingress_listener_unauthenticated_priority | The priority for the rules without authentication, between 1 and 50000 (1 being highest priority). Must be different from alb_ingress_listener_authenticated_priority since a listener can't have multiple rules with the same priority |
number | 1000 |
no |
alb_ingress_unauthenticated_hosts | Unauthenticated hosts to match in Hosts header | list(string) | <list> |
no |
alb_ingress_unauthenticated_listener_arns | A list of unauthenticated ALB listener ARNs to attach ALB listener rules to | list(string) | <list> |
no |
alb_ingress_unauthenticated_listener_arns_count | The number of unauthenticated ARNs in alb_ingress_unauthenticated_listener_arns . This is necessary to work around a limitation in Terraform where counts cannot be computed |
number | 0 |
no |
alb_ingress_unauthenticated_paths | Unauthenticated path pattern to match (a maximum of 1 can be defined) | list(string) | <list> |
no |
alb_security_group | Security group of the ALB | string | - | yes |
alb_target_group_alarms_3xx_threshold | The maximum number of 3XX HTTPCodes in a given period for ECS Service | number | 25 |
no |
alb_target_group_alarms_4xx_threshold | The maximum number of 4XX HTTPCodes in a given period for ECS Service | number | 25 |
no |
alb_target_group_alarms_5xx_threshold | The maximum number of 5XX HTTPCodes in a given period for ECS Service | number | 25 |
no |
alb_target_group_alarms_alarm_actions | A list of ARNs (i.e. SNS Topic ARN) to execute when ALB Target Group alarms transition into an ALARM state from any other state | list(string) | <list> |
no |
alb_target_group_alarms_enabled | A boolean to enable/disable CloudWatch Alarms for ALB Target metrics | bool | false |
no |
alb_target_group_alarms_evaluation_periods | The number of periods to analyze for ALB CloudWatch Alarms | number | 1 |
no |
alb_target_group_alarms_insufficient_data_actions | A list of ARNs (i.e. SNS Topic ARN) to execute when ALB Target Group alarms transition into an INSUFFICIENT_DATA state from any other state | list(string) | <list> |
no |
alb_target_group_alarms_ok_actions | A list of ARNs (i.e. SNS Topic ARN) to execute when ALB Target Group alarms transition into an OK state from any other state | list(string) | <list> |
no |
alb_target_group_alarms_period | The period (in seconds) to analyze for ALB CloudWatch Alarms | number | 300 |
no |
alb_target_group_alarms_response_time_threshold | The maximum ALB Target Group response time | number | 0.5 |
no |
attributes | Additional attributes (e.g. "1") | list(string) | <list> |
no |
authentication_cognito_user_pool_arn | Cognito User Pool ARN | string | `` | no |
authentication_cognito_user_pool_client_id | Cognito User Pool Client ID | string | `` | no |
authentication_cognito_user_pool_domain | Cognito User Pool Domain. The User Pool Domain should be set to the domain prefix (xxx ) instead of full domain (https://xxx.auth.us-west-2.amazoncognito.com) |
string | `` | no |
authentication_oidc_authorization_endpoint | OIDC Authorization Endpoint | string | `` | no |
authentication_oidc_client_id | OIDC Client ID | string | `` | no |
authentication_oidc_client_secret | OIDC Client Secret | string | `` | no |
authentication_oidc_issuer | OIDC Issuer | string | `` | no |
authentication_oidc_token_endpoint | OIDC Token Endpoint | string | `` | no |
authentication_oidc_user_info_endpoint | OIDC User Info Endpoint | string | `` | no |
authentication_type | Authentication type. Supported values are COGNITO and OIDC |
string | `` | no |
autoscaling_dimension | Dimension to autoscale on (valid options: cpu, memory) | string | memory |
no |
autoscaling_enabled | A boolean to enable/disable Autoscaling policy for ECS Service | bool | false |
no |
autoscaling_max_capacity | Maximum number of running instances of a Service | number | 2 |
no |
autoscaling_min_capacity | Minimum number of running instances of a Service | number | 1 |
no |
autoscaling_scale_down_adjustment | Scaling adjustment to make during scale down event | number | -1 |
no |
autoscaling_scale_down_cooldown | Period (in seconds) to wait between scale down events | number | 300 |
no |
autoscaling_scale_up_adjustment | Scaling adjustment to make during scale up event | number | 1 |
no |
autoscaling_scale_up_cooldown | Period (in seconds) to wait between scale up events | number | 60 |
no |
aws_logs_region | The region for the AWS Cloudwatch Logs group | string | - | yes |
badge_enabled | Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled | bool | false |
no |
branch | Branch of the GitHub repository, e.g. master |
string | `` | no |
build_image | Docker image for build environment, e.g. aws/codebuild/docker:docker:17.09.0 |
string | aws/codebuild/docker:17.09.0 |
no |
build_timeout | How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed | number | 60 |
no |
buildspec | Declaration to use for building the project. For more info | string | `` | no |
codepipeline_enabled | A boolean to enable/disable AWS Codepipeline and ECR | bool | true |
no |
codepipeline_s3_bucket_force_destroy | A boolean that indicates all objects should be deleted from the CodePipeline artifact store S3 bucket so that the bucket can be destroyed without error | bool | false |
no |
container_cpu | The vCPU setting to control cpu limits of container. (If FARGATE launch type is used below, this must be a supported vCPU size from the table here: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html) | number | 256 |
no |
container_image | The default container image to use in container definition | string | cloudposse/default-backend |
no |
container_memory | The amount of RAM to allow container to use in MB. (If FARGATE launch type is used below, this must be a supported Memory size from the table here: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html) | number | 512 |
no |
container_memory_reservation | The amount of RAM (Soft Limit) to allow container to use in MB. This value must be less than container_memory if set |
number | 128 |
no |
container_port | The port number on the container bound to assigned host_port | number | 80 |
no |
delimiter | Delimiter between namespace , stage , name and attributes |
string | - |
no |
desired_count | The desired number of tasks to start with. Set this to 0 if using DAEMON Service type. (FARGATE does not suppoert DAEMON Service type) | number | 1 |
no |
ecs_alarms_cpu_utilization_high_alarm_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization High Alarm action | list(string) | <list> |
no |
ecs_alarms_cpu_utilization_high_evaluation_periods | Number of periods to evaluate for the alarm | number | 1 |
no |
ecs_alarms_cpu_utilization_high_ok_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization High OK action | list(string) | <list> |
no |
ecs_alarms_cpu_utilization_high_period | Duration in seconds to evaluate for the alarm | number | 300 |
no |
ecs_alarms_cpu_utilization_high_threshold | The maximum percentage of CPU utilization average | number | 80 |
no |
ecs_alarms_cpu_utilization_low_alarm_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization Low Alarm action | list(string) | <list> |
no |
ecs_alarms_cpu_utilization_low_evaluation_periods | Number of periods to evaluate for the alarm | number | 1 |
no |
ecs_alarms_cpu_utilization_low_ok_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization Low OK action | list(string) | <list> |
no |
ecs_alarms_cpu_utilization_low_period | Duration in seconds to evaluate for the alarm | number | 300 |
no |
ecs_alarms_cpu_utilization_low_threshold | The minimum percentage of CPU utilization average | number | 20 |
no |
ecs_alarms_enabled | A boolean to enable/disable CloudWatch Alarms for ECS Service metrics | bool | false |
no |
ecs_alarms_memory_utilization_high_alarm_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization High Alarm action | list(string) | <list> |
no |
ecs_alarms_memory_utilization_high_evaluation_periods | Number of periods to evaluate for the alarm | number | 1 |
no |
ecs_alarms_memory_utilization_high_ok_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization High OK action | list(string) | <list> |
no |
ecs_alarms_memory_utilization_high_period | Duration in seconds to evaluate for the alarm | number | 300 |
no |
ecs_alarms_memory_utilization_high_threshold | The maximum percentage of Memory utilization average | number | 80 |
no |
ecs_alarms_memory_utilization_low_alarm_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization Low Alarm action | list(string) | <list> |
no |
ecs_alarms_memory_utilization_low_evaluation_periods | Number of periods to evaluate for the alarm | number | 1 |
no |
ecs_alarms_memory_utilization_low_ok_actions | A list of ARNs (i.e. SNS Topic ARN) to notify on Memory Utilization Low OK action | list(string) | <list> |
no |
ecs_alarms_memory_utilization_low_period | Duration in seconds to evaluate for the alarm | number | 300 |
no |
ecs_alarms_memory_utilization_low_threshold | The minimum percentage of Memory utilization average | number | 20 |
no |
ecs_cluster_arn | The ECS Cluster ARN where ECS Service will be provisioned | string | - | yes |
ecs_cluster_name | The ECS Cluster Name to use in ECS Code Pipeline Deployment step | string | - | yes |
ecs_private_subnet_ids | List of Private Subnet IDs to provision ECS Service onto | list(string) | - | yes |
ecs_security_group_ids | Additional Security Group IDs to allow into ECS Service | list(string) | <list> |
no |
environment | The environment variables to pass to the container. This is a list of maps | object | null |
no |
github_oauth_token | GitHub Oauth Token with permissions to access private repositories | string | `` | no |
github_webhook_events | A list of events which should trigger the webhook. See a list of available events | list(string) | <list> |
no |
github_webhooks_token | GitHub OAuth Token with permissions to create webhooks. If not provided, can be sourced from the GITHUB_TOKEN environment variable |
string | `` | no |
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 | 0 |
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 | null |
no |
launch_type | The ECS launch type (valid options: FARGATE or EC2) | string | FARGATE |
no |
log_driver | The log driver to use for the container. If using Fargate launch type, only supported value is awslogs | string | awslogs |
no |
name | Name of the application | string | - | yes |
namespace | Namespace (e.g. eg or cp ) |
string | `` | no |
poll_source_changes | Periodically check the location of your source content and run the pipeline if changes are detected | bool | false |
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 | object | <list> |
no |
region | AWS Region for S3 bucket | string | - | yes |
repo_name | GitHub repository name of the application to be built and deployed to ECS | string | `` | no |
repo_owner | GitHub Organization or Username | string | `` | no |
secrets | The secrets to pass to the container. This is a list of maps | object | null |
no |
stage | Stage (e.g. prod , dev , staging ) |
string | `` | no |
tags | Additional tags (e.g. { BusinessUnit : ABC }) | map(string) | <map> |
no |
vpc_id | The VPC ID where resources are created | string | - | yes |
webhook_authentication | The type of authentication to use. One of IP, GITHUB_HMAC, or UNAUTHENTICATED | string | GITHUB_HMAC |
no |
webhook_enabled | Set to false to prevent the module from creating any webhook resources | bool | true |
no |
webhook_filter_json_path | The JSON path to filter on | string | $.ref |
no |
webhook_filter_match_equals | The value to match on (e.g. refs/heads/{Branch}) | string | refs/heads/{Branch} |
no |
webhook_target_action | The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline | string | Source |
no |
Name | Description |
---|---|
alb_ingress_target_group_arn | ALB Target Group ARN |
alb_ingress_target_group_arn_suffix | ALB Target Group ARN suffix |
alb_ingress_target_group_name | ALB Target Group name |
codebuild_badge_url | The URL of the build badge when badge_enabled is enabled |
codebuild_cache_bucket_arn | CodeBuild cache S3 bucket ARN |
codebuild_cache_bucket_name | CodeBuild cache S3 bucket name |
codebuild_project_id | CodeBuild project ID |
codebuild_project_name | CodeBuild project name |
codebuild_role_arn | CodeBuild IAM Role ARN |
codebuild_role_id | CodeBuild IAM Role ID |
codepipeline_arn | CodePipeline ARN |
codepipeline_id | CodePipeline ID |
codepipeline_webhook_id | The CodePipeline webhook's ID |
codepipeline_webhook_url | The CodePipeline webhook's URL. POST events to this endpoint to trigger the target |
container_definition_json | JSON encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition |
container_definition_json_map | JSON encoded container definitions for use with other terraform resources such as aws_ecs_task_definition |
ecr_registry_id | Registry ID |
ecr_registry_url | Registry URL |
ecr_repository_name | Registry name |
ecs_alarms_cpu_utilization_high_cloudwatch_metric_alarm_arn | ECS CPU utilization high CloudWatch metric alarm ARN |
ecs_alarms_cpu_utilization_high_cloudwatch_metric_alarm_id | ECS CPU utilization high CloudWatch metric alarm ID |
ecs_alarms_cpu_utilization_low_cloudwatch_metric_alarm_arn | ECS CPU utilization low CloudWatch metric alarm ARN |
ecs_alarms_cpu_utilization_low_cloudwatch_metric_alarm_id | ECS CPU utilization low CloudWatch metric alarm ID |
ecs_alarms_memory_utilization_high_cloudwatch_metric_alarm_arn | ECS Memory utilization high CloudWatch metric alarm ARN |
ecs_alarms_memory_utilization_high_cloudwatch_metric_alarm_id | ECS Memory utilization high CloudWatch metric alarm ID |
ecs_alarms_memory_utilization_low_cloudwatch_metric_alarm_arn | ECS Memory utilization low CloudWatch metric alarm ARN |
ecs_alarms_memory_utilization_low_cloudwatch_metric_alarm_id | ECS Memory utilization low CloudWatch metric alarm ID |
ecs_cloudwatch_autoscaling_scale_down_policy_arn | ARN of the scale down policy |
ecs_cloudwatch_autoscaling_scale_up_policy_arn | ARN of the scale up policy |
ecs_exec_role_policy_id | The ECS service role policy ID, in the form of role_name:role_policy_name |
ecs_exec_role_policy_name | ECS service role name |
ecs_service_name | ECS Service name |
ecs_service_role_arn | ECS Service role ARN |
ecs_service_security_group_id | Security Group ID of the ECS task |
ecs_task_definition_family | ECS task definition family |
ecs_task_definition_revision | ECS task definition revision |
ecs_task_exec_role_arn | ECS Task exec role ARN |
ecs_task_exec_role_name | ECS Task role name |
ecs_task_role_arn | ECS Task role ARN |
ecs_task_role_id | ECS Task role id |
ecs_task_role_name | ECS Task role name |
httpcode_elb_5xx_count_cloudwatch_metric_alarm_arn | ALB 5xx count CloudWatch metric alarm ARN |
httpcode_elb_5xx_count_cloudwatch_metric_alarm_id | ALB 5xx count CloudWatch metric alarm ID |
httpcode_target_3xx_count_cloudwatch_metric_alarm_arn | ALB Target Group 3xx count CloudWatch metric alarm ARN |
httpcode_target_3xx_count_cloudwatch_metric_alarm_id | ALB Target Group 3xx count CloudWatch metric alarm ID |
httpcode_target_4xx_count_cloudwatch_metric_alarm_arn | ALB Target Group 4xx count CloudWatch metric alarm ARN |
httpcode_target_4xx_count_cloudwatch_metric_alarm_id | ALB Target Group 4xx count CloudWatch metric alarm ID |
httpcode_target_5xx_count_cloudwatch_metric_alarm_arn | ALB Target Group 5xx count CloudWatch metric alarm ARN |
httpcode_target_5xx_count_cloudwatch_metric_alarm_id | ALB Target Group 5xx count CloudWatch metric alarm ID |
target_response_time_average_cloudwatch_metric_alarm_arn | ALB Target Group response time average CloudWatch metric alarm ARN |
target_response_time_average_cloudwatch_metric_alarm_id | ALB Target Group response time average CloudWatch metric alarm ID |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-aws-alb - Terraform module to provision a standard ALB for HTTP/HTTP traffic
- terraform-aws-alb-ingress - Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB
- terraform-aws-codebuild - Terraform Module to easily leverage AWS CodeBuild for Continuous Integration
- terraform-aws-ecr - Terraform Module to manage Docker Container Registries on AWS ECR
- terraform-aws-ecs-alb-service-task - Terraform module which implements an ECS service which exposes a web service via ALB.
- terraform-aws-ecs-codepipeline - Terraform Module for CI/CD with AWS Code Pipeline and Code Build for ECS
- terraform-aws-ecs-container-definition - Terraform module to generate well-formed JSON documents that are passed to the aws_ecs_task_definition Terraform resource
- terraform-aws-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs.
- terraform-aws-eks-cluster - Terraform module for provisioning an EKS cluster
- terraform-aws-eks-workers - Terraform module to provision an AWS AutoScaling Group, IAM Role, and Security Group for EKS Workers
- terraform-aws-ec2-autoscale-group - Terraform module to provision Auto Scaling Group and Launch Template on AWS
Got a question?
File a GitHub issue, send us an email or join our Slack Community.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
- Questions. We'll use a Shared Slack channel between your team and ours.
- Troubleshooting. We'll help you triage why things aren't working.
- Code Reviews. We'll review your Pull Requests and provide constructive feedback.
- Bug Fixes. We'll rapidly work to fix any bugs in our projects.
- Build New Terraform Modules. We'll develop original modules to provision infrastructure.
- Cloud Architecture. We'll assist with your cloud strategy and design.
- Implementation. We'll provide hands-on support to implement our reference architectures.
Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2019 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Erik Osterman |
Igor Rodionov |
Andriy Knysh |
Sarkis Varozian |
---|