Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ovotech/terraform-module-fargate-app

A terraform module that builds a great Fargate Application
https://github.com/ovotech/terraform-module-fargate-app

Last synced: 12 days ago
JSON representation

A terraform module that builds a great Fargate Application

Awesome Lists containing this project

README 

        
Terraform module to provision a Fargate application.



This module includes DataDog integration and requires a Datadog API key. It also contains definition to allow datadog log forwarding if enabled.



This module creates a Fargate applicaiton with a CI/CD user, load balancer, alerts, dashboards and logs.



This module supports using SSM secrets



## Examples



See `/examples/`



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|:----:|:-----:|:-----:|

| app | The application's name | string | - | yes |

| certificate_arn | The ARN for the SSL certificate | string | - | yes |

| container_cpu | The number of cpu units to reserve for the container | number | 246 | no |

| container_memory | The amount of memory to allow the application container to use | number | 256 | no |

| container_memory_reservation | The amount of memory to reserve for the application container, it can exceed this | number | 128 | no |

| container_name | The name of the container to run | string | `app` | no |

| container_port | The port the container will listen on, used for load balancer health check Best practice is that this value is higher than 1024 so the container processes isn't running at root. | string | - | yes |

string | `quay.io/turner/turner-defaultbackend:0.2.0` | no |

| datadog_api_key_from | The SSM pointer to the datadog api key | string | - | no |

| kms_key_aliases | The Key aliases the app is allowed to decrypt with | list(string) | "alias/aws/ssm" | no |

| secrets | The secrets SSM ARNs | list(name,valueFrom) | - | no |

| deregistration_delay | The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused | string | `30` | no |

| ecs_as_cpu_high_threshold_per | If the average CPU utilization over a minute rises to this threshold, the number of containers will be increased (but not above ecs_autoscale_max_instances). | string | `80` | no |

| ecs_as_cpu_low_threshold_per | If the average CPU utilization over a minute drops to this threshold, the number of containers will be reduced (but not below ecs_autoscale_min_instances). | string | `20` | no |

| ecs_autoscale_max_instances | The maximum number of containers that should be running. used by both autoscale-perf.tf and autoscale.time.tf | string | `8` | no |

| ecs_autoscale_min_instances | The minimum number of containers that should be running. Must be at least 1. used by both autoscale-perf.tf and autoscale.time.tf For production, consider using at least "2". | string | `1` | no |

| environment | The environment that is being built | string | - | yes |

| health_check | The path to the health check for the load balancer to know if the container(s) are ready | string | - | yes |

| health_check_interval | How often to check the liveliness of the container | string | `30` | no |

| health_check_matcher | What HTTP response code to listen for | string | `200` | no |

| health_check_timeout | How long to wait for the response on the health check path | string | `10` | no |

| https_port | The port to listen on for HTTPS, always use 443 | string | `443` | no |

| lb_port | The port the load balancer will listen on | string | `80` | no |

| lb_protocol | The load balancer protocol | string | `HTTP` | no |

| lb_internal | Whether the load balancer should be internal. | boolean | `false` | no |

| lb_subnets | The subnets, minimum of 2, that are a part of the VPC(s), that the LB is deployed into (often public) | string | - | yes |

| lb_ingress_cidr_blocks | Ingress IP ranges that are allowed on the load balancer | string list | `["0.0.0.0/0"]` | no |

| lb_drop_invalid_header_fields | Indicates whether invalid header fields are dropped in application load balancers. | boolean | false | no |

| lb_logs_bucket_policy_override | A policy document to add to the load balancer logs bucket policy | string | `""` | no |

| lb_tls_policy | The [security policy](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) to use for the HTTPS load balancer's SSL configuration | string | `"ELBSecurityPolicy-2016-08"` | no |

| lb_http_redirect | Whether to redirect from HTTP to HTTPS or not. | boolean | `true` | no |

| task_all_egress_allowed | Whether the task's security group allows all egress traffic or not | bool | true | no | 

| ecs_task_subnets | The subnets, minimum of 2, that are a part of the VPC(s), that the task is deployed into (should be private) | string | - | yes |

| region | The AWS region to use for the dev environment's infrastructure Currently, Fargate is only available in `us-east-1`. | string | `us-east-1` | no |

| replicas | How many containers to run | string | `1` | no |

| tags | Tags for the infrastructure | map | - | yes |

| datadog_tags | Tags for datadog agent container. (1) Please add `team:team-name` to datadog tags | string | - | yes(1) |

| vpc | The VPC to use for the Fargate cluster | string | - | yes |

| fluent_bit_version | Fluent bit version to use | string | - | no |

| alb_access_log_bucket | The bucket to use for sending alb access logs to. | string | - | no |

| additional_user_groups | Any additional groups the user should belong to that's used for deploying your fargate app. | list(string) | [] | no |

| enable_datadog_log_forwarding| Should enable data dog log forwarding. datadog_api_key_from must also be set for this to be enabled. You may need to modify task_memory, task_cpu, container_memory, container_cpu to account for this new container being added. | bool | false | no

| HTTPCode_ELB_5XX_threshold | Threshold for ELB 5XX alert | string | 25 | no

## Outputs



| Name | Description |

|------|-------------|

| lb_dns | The load balancer DNS name |



### Docker instructions



From the `docker` directory



```sh

make terraform

```



### Developing



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!