hookercookerman / terraform-aws-ecs-web-app

Terraform module that implements a web app on ECS and supports autoscaling, CI/CD, monitoring, ALB integration, and much more.

Home Page:https://cloudposse.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README Header

Cloud Posse

terraform-aws-ecs-web-app Build Status Latest Release Slack Community

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.

Terraform Open Source Modules

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!

Usage

module "default-backend-web-app" {
  source                       = "git::https://github.com/cloudposse/terraform-aws-ecs-web-app.git?ref=tags/0.1.0"
  name                         = "appname"
  namespace                    = "eg"
  stage                        = "testing"
  vpc_id                       = "${module.vpc.vpc_id}"
  listener_arns                = "${module.alb.listener_arns}"
  listener_arns_count          = "1"
  aws_logs_region              = "us-west-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_paths            = ["/*"]
  codepipeline_enabled         = "false"
  environment = [
      {
        name = "COOKIE"
        value = "cookiemonster"
      },
      {
        name = "PORT"
        value = "80"
      }
    ]
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name Description Type Default Required
alb_arn_suffix ARN suffix of the ALB for the Target Group. string `` no
alb_ingress_healthcheck_path The path of the healthcheck which the ALB checks. string / no
alb_ingress_hosts Hosts to match in Hosts header, at least one of hosts or paths must be set list <list> no
alb_ingress_listener_priority Priority of the listeners, a number between 1 - 50000 (1 is highest priority) string 1000 no
alb_ingress_paths Path pattern to match (a maximum of 1 can be defined), at least one of hosts or paths must be set list <list> no
alb_name Name of the ALB for the Target Group. string `` no
alb_target_group_alarms_3xx_threshold The maximum number of 3XX HTTPCodes in a given period for ECS Service. string 25 no
alb_target_group_alarms_4xx_threshold The maximum number of 4XX HTTPCodes in a given period for ECS Service. string 25 no
alb_target_group_alarms_5xx_threshold The maximum number of 5XX HTTPCodes in a given period for ECS Service. string 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 <list> no
alb_target_group_alarms_enabled A boolean to enable/disable CloudWatch Alarms for ALB Target metrics. string false no
alb_target_group_alarms_evaluation_periods The number of periods to analyze for ALB CloudWatch Alarms. string 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 <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 <list> no
alb_target_group_alarms_period The period (in seconds) to analyze for ALB CloudWatch Alarms. string 300 no
alb_target_group_alarms_response_time_threshold The maximum ALB Target Group response time. string 0.5 no
alb_target_group_arn Pass target group down to module string `` no
attributes List of attributes to add to label. list <list> 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. string false no
autoscaling_max_capacity Maximum number of running instances of a Service. string 2 no
autoscaling_min_capacity Minimum number of running instances of a Service. string 1 no
autoscaling_scale_down_adjustment Scaling adjustment to make during scale down event. string -1 no
autoscaling_scale_down_cooldown Period (in seconds) to wait between scale down events. string 300 no
autoscaling_scale_up_adjustment Scaling adjustment to make during scale up event. string 1 no
autoscaling_scale_up_cooldown Period (in seconds) to wait between scale up events. string 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. string false no
branch Branch of the GitHub repository, e.g. master string `` 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. string 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 string true 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) string 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) string 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. string `` no
container_port The port number on the container bound to assigned host_port. string 80 no
delimiter The delimiter to be used in labels. 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) string 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 <list> no
ecs_alarms_cpu_utilization_high_evaluation_periods Number of periods to evaluate for the alarm. string 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 <list> no
ecs_alarms_cpu_utilization_high_period Duration in seconds to evaluate for the alarm. string 300 no
ecs_alarms_cpu_utilization_high_threshold The maximum percentage of CPU utilization average. string 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 <list> no
ecs_alarms_cpu_utilization_low_evaluation_periods Number of periods to evaluate for the alarm. string 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 <list> no
ecs_alarms_cpu_utilization_low_period Duration in seconds to evaluate for the alarm. string 300 no
ecs_alarms_cpu_utilization_low_threshold The minimum percentage of CPU utilization average. string 20 no
ecs_alarms_enabled A boolean to enable/disable CloudWatch Alarms for ECS Service metrics. string 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 <list> no
ecs_alarms_memory_utilization_high_evaluation_periods Number of periods to evaluate for the alarm. string 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 <list> no
ecs_alarms_memory_utilization_high_period Duration in seconds to evaluate for the alarm. string 300 no
ecs_alarms_memory_utilization_high_threshold The maximum percentage of Memory utilization average. string 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 <list> no
ecs_alarms_memory_utilization_low_evaluation_periods Number of periods to evaluate for the alarm. string 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 <list> no
ecs_alarms_memory_utilization_low_period Duration in seconds to evaluate for the alarm. string 300 no
ecs_alarms_memory_utilization_low_threshold The minimum percentage of Memory utilization average. string 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 - yes
ecs_security_group_ids Additional Security Group IDs to allow into ECS Service. list <list> no
environment The environment variables for the task definition. This is a list of maps list <list> 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 <list> no
healthcheck A map containing command (string), 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) map <map> no
host_port The port number to bind container_port to on the host string `` no
launch_type The ECS launch type (valid options: FARGATE or EC2) string FARGATE no
listener_arns List of ALB Listener ARNs for the ECS service. list - yes
listener_arns_count Number of elements in list of ALB Listener ARNs for the ECS service. string - yes
name Name (unique identifier for app or service) string - yes
namespace Namespace (e.g. cp or cloudposse) string - yes
poll_source_changes Periodically check the location of your source content and run the pipeline if changes are detected string 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. list <list> no
protocol The protocol used for the port mapping. Options: tcp or udp. string tcp no
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
stage Stage (e.g. prod, dev, staging) string - yes
tags Map of key-value pairs to use for tags. map <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 string 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

Outputs

Name Description
badge_url The URL of the build badge when badge_enabled is enabled
scale_down_policy_arn Autoscaling scale up policy ARN
scale_up_policy_arn Autoscaling scale up policy ARN
service_name ECS Service Name
service_security_group_id Security Group id of the ECS task
task_role_arn ECS Task role ARN
task_role_name ECS Task role name
webhook_id The CodePipeline webhook's ARN.
webhook_url The CodePipeline webhook's URL. POST events to this endpoint to trigger the target.

Share the Love

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. =)

Related Projects

Check out these related projects.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

Commercial Support

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.

E-Mail

  • 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.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

Slack Community

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.

Newsletter

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.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

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.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. 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

Copyright © 2017-2019 Cloud Posse, LLC

License

License

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

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.

Contributors

Erik Osterman
Erik Osterman
Igor Rodionov
Igor Rodionov
Andriy Knysh
Andriy Knysh
Sarkis Varozian
Sarkis Varozian

README Footer Beacon

About

Terraform module that implements a web app on ECS and supports autoscaling, CI/CD, monitoring, ALB integration, and much more.

https://cloudposse.com


Languages

Language:HCL 98.6%Language:Makefile 1.4%