Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rishang/terraform-aws-fargate
Terraform module to deploy AWS ECS Fargate
https://github.com/rishang/terraform-aws-fargate
aws ecs fargate route53 terraform terraform-module
Last synced: about 15 hours ago
JSON representation
Terraform module to deploy AWS ECS Fargate
- Host: GitHub
- URL: https://github.com/rishang/terraform-aws-fargate
- Owner: Rishang
- License: gpl-3.0
- Created: 2022-01-19T08:01:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T09:32:52.000Z (6 months ago)
- Last Synced: 2024-05-22T10:44:54.438Z (6 months ago)
- Topics: aws, ecs, fargate, route53, terraform, terraform-module
- Language: HCL
- Homepage: https://registry.terraform.io/modules/Rishang/fargate/aws/latest
- Size: 59.6 KB
- Stars: 10
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aws ecs fargate terraform module
### Usage
[For examples and refrences click here.](https://github.com/Rishang/terraform-aws-fargate/tree/main/examples)
```terraform
# quick usage look
# things to be created
# ecs service (memory scaling) >> TargetGroup >> Alb HTTPS rule >> Route53 >> app.example.com
module "fargate" {
source = "Rishang/fargate/aws"
version = "1.4.3"
EnvironmentName = "test"
# ecs fargate
cluster = aws_ecs_cluster.app.name
service = "whoami"
container_port = 80
task_definition_arn = module.fargate_task_definition.arn
scale_min_capacity = 3
scale_max_capacity = 10
# keep 1 FARGATE for each 5 FARGATE_SPOT
capacity_provider_strategy = [
{
base = 1
capacity_provider = "FARGATE"
weight = 1
},
{
base = 0
capacity_provider = "FARGATE_SPOT"
weight = 5
}
]
# networking
assign_public_ip = true
vpc_id = "vpc-demos7"
subnets = ["subnet-a2b3","subnet-c9da","subnet-0b23"]
security_groups = ["sg-f34d92"]
# load balancer (optional)
point_to_lb = true
listener_arn_https = aws_lb_listener.https.arn
subdomain = "app.example.com"
# route53 (optional)
point_to_r53 = true
# autoscale (optional)
create_autoscale_target = true
cpu_scale_target = 60
# memory_scale_target = 60
# scheduled scaling (optional)
scaling_schedule = [
{
# Scale count to zero every night at 19:00
schedule = "cron(0 19 * * ? *)"
min_capacity = 0
max_capacity = 0
},
{
# Scale count to 3 every morning at 7:00
schedule = "cron(0 7 * * ? *)"
min_capacity = 3
max_capacity = 3
}
]
# service discovery (optional)
enable_discovery = true
namespace_id = aws_service_discovery_private_dns_namespace.service.id
tags = {
Name = "whoami"
Version = "latest"
cluster_name = local.cluster_name
}
}
```
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | 4.8.0 |
## Outputs
| Name | Description |
|------|-------------|
| [cluster\_name](#output\_cluster\_name) | ecs fargate application cluster name. |
| [discovery\_arn](#output\_discovery\_arn) | application service discovery name. (if provided) |
| [discovery\_id](#output\_discovery\_id) | application service discovery name. (if provided) |
| [discovery\_name](#output\_discovery\_name) | application service discovery name. (if provided) |
| [domain\_id](#output\_domain\_id) | application route53 endpoint id. (if provided) |
| [domain\_name](#output\_domain\_name) | application service domain name. (if provided) |
| [domain\_type](#output\_domain\_type) | application route53 endpoint domain type eg. [A, CNAME]. (if provided) |
| [id](#output\_id) | ecs fargate application service id. |
| [name](#output\_name) | ecs fargate application service name. |
## available tfvar inputs
```hcl
# null are required inputs,
# others are optional default values
EnvironmentName = null
assign_public_ip = false
capacity_provider_strategy = [{
base = "1"
capacity_provider = "FARGATE"
weight = "1"
}, {
base = "0"
capacity_provider = "FARGATE_SPOT"
weight = "0"
}]
cluster = null
container_name = ""
container_port = -1
cpu_scale_target = -1
create_autoscale_target = false
deployment_maximum_percent = 200
deployment_minimum_healthy_percent = 100
enable_discovery = false
enable_ecs_managed_tags = false
force_new_deployment = false
health_check_interval = 20
health_check_matcher = "200,202"
health_check_path = "/"
lb_scale_target = -1
listener_arn_https = ""
memory_scale_target = -1
namespace_id = ""
path_pattern = ["/", "/*"]
point_to_lb = false
point_to_r53 = false
scale_in_cooldown = 250
scale_max_capacity = 20
scale_min_capacity = 1
scale_out_cooldown = 250
scaling_schedule = []
security_groups = []
service = null
subdomain = ""
subnets = null
tags = {}
task_definition_arn = null
vpc_id = ""
```
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [EnvironmentName](#input\_EnvironmentName) | The name of the infra environment to deploy to eg. dev, prod, test | `string` | n/a | yes |
| [cluster](#input\_cluster) | The name of the cluster that hosts the service | `any` | n/a | yes |
| [service](#input\_service) | Fargate service name | `any` | n/a | yes |
| [subnets](#input\_subnets) | List of subnets for ecs service | `list(string)` | n/a | yes |
| [task\_definition\_arn](#input\_task\_definition\_arn) | The ARN of the task definition to use for the ECS service | `string` | n/a | yes |
| [assign\_public\_ip](#input\_assign\_public\_ip) | Auto assign public ip for ecs containers | `bool` | `false` | no |
| [capacity\_provider\_strategy](#input\_capacity\_provider\_strategy) | Capacity provider strategy for ecs service here `base` parameter defines the minimum number of tasks that should be launched using the specified capacity provider before considering the weight. `weight` parameter defines the relative percentage of tasks to be launched using the specified capacity provider after the base tasks have been satisfied. | `list(map(any))` |
[
{
"base": 1,
"capacity_provider": "FARGATE",
"weight": 1
},
{
"base": 0,
"capacity_provider": "FARGATE_SPOT",
"weight": 0
}
]
| no |
| [container\_name](#input\_container\_name) | Required if service name is different than main application container\_name of task defination | `string` | `""` | no |
| [container\_port](#input\_container\_port) | container application port | `number` | `-1` | no |
| [cpu\_scale\_target](#input\_cpu\_scale\_target) | Treshold cpu target value for autoscaling ecs service | `number` | `-1` | no |
| [create\_autoscale\_target](#input\_create\_autoscale\_target) | Enable to create autoscale for ecs service | `bool` | `false` | no |
| [deployment\_maximum\_percent](#input\_deployment\_maximum\_percent) | Deployment max healthy percent of container count | `number` | `200` | no |
| [deployment\_minimum\_healthy\_percent](#input\_deployment\_minimum\_healthy\_percent) | Deployment min healthy percent of container count | `number` | `100` | no |
| [enable\_discovery](#input\_enable\_discovery) | Enable service discovery, requires `namespace_id` and `container_name` | `bool` | `false` | no |
| [enable\_ecs\_managed\_tags](#input\_enable\_ecs\_managed\_tags) | Specifies whether to enable Amazon ECS managed tags for the service. | `bool` | `false` | no |
| [force\_new\_deployment](#input\_force\_new\_deployment) | Enable to force a new task deployment of the service | `bool` | `false` | no |
| [health\_check\_interval](#input\_health\_check\_interval) | target group health check interval time in sec | `number` | `20` | no |
| [health\_check\_matcher](#input\_health\_check\_matcher) | Service health check response matcher | `string` | `"200,202"` | no |
| [health\_check\_path](#input\_health\_check\_path) | Health check path for ecs running containers | `string` | `"/"` | no |
| [lb\_scale\_target](#input\_lb\_scale\_target) | Treshold target requests traffic value from alb, for autoscaling ecs service | `number` | `-1` | no |
| [listener\_arn\_https](#input\_listener\_arn\_https) | HTTPS listner arn for Application Load Balencer (required if 'point\_to\_lb' is true) | `string` | `""` | no |
| [memory\_scale\_target](#input\_memory\_scale\_target) | Treshold memory target value for autoscaling ecs service | `number` | `-1` | no |
| [namespace\_id](#input\_namespace\_id) | Namespace id (private) for service discovery, Note: discovery endpoint's subdomain will be same as service name | `string` | `""` | no |
| [path\_pattern](#input\_path\_pattern) | List of paths for alb to route traffic at ecs target group | `list(string)` | [
"/",
"/*"
]
| no |
| [point\_to\_lb](#input\_point\_to\_lb) | Enable to point to ALB (load balancer) | `bool` | `false` | no |
| [point\_to\_r53](#input\_point\_to\_r53) | Enable to point to R53 | `bool` | `false` | no |
| [scale\_in\_cooldown](#input\_scale\_in\_cooldown) | The amount of time, in sec, after a scale in activity completes before another scale in activity can start. | `number` | `250` | no |
| [scale\_max\_capacity](#input\_scale\_max\_capacity) | Max count of containers | `number` | `20` | no |
| [scale\_min\_capacity](#input\_scale\_min\_capacity) | Min count of containers | `number` | `1` | no |
| [scale\_out\_cooldown](#input\_scale\_out\_cooldown) | The amount of time, in sec, after a scale out activity completes before another scale in activity can start. | `number` | `250` | no |
| [scaling\_schedule](#input\_scaling\_schedule) | Schedule scaling for ecs service [{"schedule":"cron(0 3 * * ? *)", "min\_capacity": 1, "max\_capacity": 1}] | `list(any)` | `[]` | no |
| [security\_groups](#input\_security\_groups) | Extra security groups to attach to ecs service | `list(string)` | `[]` | no |
| [subdomain](#input\_subdomain) | Subdomain name you want to give eg: test.example.com (required if 'point\_to\_r53' is true) | `string` | `""` | no |
| [tags](#input\_tags) | Tags to apply to the resources | `map(any)` | `{}` | no |
| [vpc\_id](#input\_vpc\_id) | aws vpc id | `string` | `""` | no |
---
README.md created by: `terraform-docs`