Merge pull request #28 from HENNGE/placement-constraints

Placement constraints

.pre-commit-config.yaml

@@ -1,26 +1,29 @@
 repos:
   - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.77.2
+    rev: v1.86.0
     hooks:
       - id: terraform_fmt
-      - id: terraform_docs
       - id: terraform_validate
+      - id: terraform_docs
+        args:
+          - '--args=--lockfile=false'
       - id: terraform_tflint
         args:
-          - "--args=--only=terraform_deprecated_interpolation"
-          - "--args=--only=terraform_deprecated_index"
-          - "--args=--only=terraform_unused_declarations"
-          - "--args=--only=terraform_comment_syntax"
-          - "--args=--only=terraform_documented_outputs"
-          - "--args=--only=terraform_documented_variables"
-          - "--args=--only=terraform_typed_variables"
-          - "--args=--only=terraform_module_pinned_source"
-          - "--args=--only=terraform_naming_convention"
-          - "--args=--only=terraform_required_version"
-          - "--args=--only=terraform_required_providers"
-          - "--args=--only=terraform_standard_module_structure"
-          - "--args=--only=terraform_workspace_remote"
+          - '--args=--only=terraform_deprecated_interpolation'
+          - '--args=--only=terraform_deprecated_index'
+          - '--args=--only=terraform_unused_declarations'
+          - '--args=--only=terraform_comment_syntax'
+          - '--args=--only=terraform_documented_outputs'
+          - '--args=--only=terraform_documented_variables'
+          - '--args=--only=terraform_typed_variables'
+          - '--args=--only=terraform_module_pinned_source'
+          - '--args=--only=terraform_naming_convention'
+          - '--args=--only=terraform_required_version'
+          - '--args=--only=terraform_required_providers'
+          - '--args=--only=terraform_standard_module_structure'
+          - '--args=--only=terraform_workspace_remote'
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.5.0
     hooks:
       - id: check-merge-conflict
+      - id: end-of-file-fixer

examples/complete-ecs/README.md

@@ -81,5 +81,3 @@ $ terraform apply
 |------|-------------|
 | <a name="output_load_balancer_dns"></a> [load\_balancer\_dns](#output\_load\_balancer\_dns) | Accessible load balancer DNS |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-

examples/easy/ec2-alb/README.md

@@ -66,5 +66,3 @@ To test that it's working:
 |------|-------------|
 | <a name="output_load_balancer_dns"></a> [load\_balancer\_dns](#output\_load\_balancer\_dns) | Accessible load balancer DNS |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-

examples/easy/ec2-alb/main.tf

@@ -28,6 +28,8 @@ module "vpc" {
   enable_dhcp_options              = true
   dhcp_options_domain_name_servers = ["AmazonProvidedDNS"]
 
+  map_public_ip_on_launch = true
+
   enable_ipv6                                   = var.enable_ipv6
   public_subnet_assign_ipv6_address_on_creation = var.enable_ipv6
   public_subnet_ipv6_prefixes                   = range(length(local.vpc_azs))
@@ -118,9 +120,9 @@ module "asg" {
   max_size            = 2
   desired_capacity    = 1
   health_check_type   = "EC2"
-  user_data = templatefile("../../templates/ec2_userdata.tpl", {
+  user_data = base64encode(templatefile("../../templates/ec2_userdata.tpl", {
     ecs_cluster = module.ecs_cluster.name
-  })
+  }))
   iam_instance_profile_arn = var.instance_profile_arn
 }
 

examples/easy/ec2-distinct/README.md

@@ -0,0 +1,70 @@
+# examples/easy/ec2-distinct
+
+In this example we'll instantiate a simple nginx webserver running in **3 distinct instances**.
+
+Task networking mode in this example is `host` so that the port specified in `templates/container_definitions.tpl` will be bind.
+Means there cannot be more than 1 task in an instance. Do experiment with dynamic port mapping with `bridge` network mode.
+
+This example will also create `vpc` and `security_group` and `autoscaling group`.
+
+Note: Instance profile is required for EC2 to connect to ECS Cluster. See [`modules/iam/ecs-instance-profile`](https://github.com/HENNGE/terraform-aws-ecs/tree/main/modules/iam/ecs-instance-profile).
+
+To test that it's working:
+1. Go to EC2 console
+1. Find the EC2 instance started by this example. (Search the name)
+1. Go to the IP Address, you should see nginx hello world screen
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.74.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.74.0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_asg"></a> [asg](#module\_asg) | terraform-aws-modules/autoscaling/aws | ~> 7.0 |
+| <a name="module_easy_ec2_distinct_instance_mode"></a> [easy\_ec2\_distinct\_instance\_mode](#module\_easy\_ec2\_distinct\_instance\_mode) | ../../../modules/simple/ec2 | n/a |
+| <a name="module_ec2_security_group"></a> [ec2\_security\_group](#module\_ec2\_security\_group) | terraform-aws-modules/security-group/aws | ~> 4.0 |
+| <a name="module_ecs_cluster"></a> [ecs\_cluster](#module\_ecs\_cluster) | ../../.. | n/a |
+| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 5.0 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
+| [aws_ssm_parameter.ami_image](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_availability_zones"></a> [availability\_zones](#input\_availability\_zones) | Override automatic detection of availability zones | `list(string)` | `[]` | no |
+| <a name="input_enable_ipv6"></a> [enable\_ipv6](#input\_enable\_ipv6) | Enable IPv6? | `bool` | `true` | no |
+| <a name="input_instance_profile_arn"></a> [instance\_profile\_arn](#input\_instance\_profile\_arn) | Instance Profile to use for EC2 to join to ECS Cluster. See `modules/iam/ecs-instance-profile` | `string` | n/a | yes |
+
+## Outputs
+
+No outputs.
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/easy/ec2-distinct/main.tf

@@ -0,0 +1,103 @@
+# Just Supporting Infrastructures
+
+data "aws_availability_zones" "available" {}
+
+data "aws_ssm_parameter" "ami_image" {
+  name = "/aws/service/ecs/optimized-ami/amazon-linux-2/recommended/image_id"
+}
+
+locals {
+  prefix = "easy-ec2"
+
+  vpc_cidr       = "10.0.0.0/16"
+  discovered_azs = data.aws_availability_zones.available.names
+  vpc_azs        = length(var.availability_zones) == 0 ? local.discovered_azs : var.availability_zones
+}
+
+module "vpc" {
+  source  = "terraform-aws-modules/vpc/aws"
+  version = "~> 5.0"
+
+  name = "${local.prefix}-vpc"
+  cidr = local.vpc_cidr
+  azs  = local.vpc_azs
+
+  public_subnets = [for i in range(length(local.vpc_azs)) : cidrsubnet(local.vpc_cidr, 8, i)]
+
+  enable_nat_gateway               = false
+  enable_dhcp_options              = true
+  dhcp_options_domain_name_servers = ["AmazonProvidedDNS"]
+
+  map_public_ip_on_launch = true
+
+  enable_ipv6                                   = var.enable_ipv6
+  public_subnet_assign_ipv6_address_on_creation = var.enable_ipv6
+  public_subnet_ipv6_prefixes                   = range(length(local.vpc_azs))
+}
+
+module "ec2_security_group" {
+  source  = "terraform-aws-modules/security-group/aws"
+  version = "~> 4.0"
+
+  name   = "${local.prefix}-ec2-sg"
+  vpc_id = module.vpc.vpc_id
+
+
+  # Ingress for HTTP
+  ingress_cidr_blocks      = ["0.0.0.0/0"]
+  ingress_ipv6_cidr_blocks = ["::/0"]
+  ingress_rules            = ["http-80-tcp"]
+
+  # Allow all egress
+  egress_cidr_blocks      = ["0.0.0.0/0"]
+  egress_ipv6_cidr_blocks = ["::/0"]
+  egress_rules            = ["all-all"]
+}
+
+module "asg" {
+  source  = "terraform-aws-modules/autoscaling/aws"
+  version = "~> 7.0"
+
+  name = "${local.prefix}-asg"
+
+  image_id            = data.aws_ssm_parameter.ami_image.value
+  instance_type       = "t2.micro"
+  security_groups     = [module.ec2_security_group.security_group_id]
+  vpc_zone_identifier = module.vpc.public_subnets
+  min_size            = 1
+  max_size            = 5
+  desired_capacity    = 3
+  health_check_type   = "EC2"
+  user_data = base64encode(templatefile("../../templates/ec2_userdata.tpl", {
+    ecs_cluster = module.ecs_cluster.name
+  }))
+  iam_instance_profile_arn = var.instance_profile_arn
+}
+
+# This module usage starts here
+module "ecs_cluster" {
+  source = "../../.."
+
+  name = "${local.prefix}-cluster"
+}
+
+module "easy_ec2_distinct_instance_mode" {
+  source = "../../../modules/simple/ec2"
+
+  name                         = "${local.prefix}-service"
+  cluster                      = module.ecs_cluster.name
+  cpu                          = 256
+  memory                       = 512
+  desired_count                = 3
+  ignore_desired_count_changes = false
+
+  network_mode = "host"
+
+  distinct_instance = true
+
+  container_definitions = templatefile("../../templates/container_definitions.tpl", {
+    name   = "${local.prefix}-cont"
+    cpu    = 256
+    memory = 512
+  })
+}

examples/easy/ec2-distinct/variables.tf

@@ -0,0 +1,16 @@
+variable "instance_profile_arn" {
+  description = "Instance Profile to use for EC2 to join to ECS Cluster. See `modules/iam/ecs-instance-profile`"
+  type        = string
+}
+
+variable "availability_zones" {
+  description = "Override automatic detection of availability zones"
+  default     = []
+  type        = list(string)
+}
+
+variable "enable_ipv6" {
+  description = "Enable IPv6?"
+  default     = true
+  type        = bool
+}

examples/easy/ec2-distinct/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.74.0"
+    }
+  }
+}

examples/easy/ec2/README.md

@@ -68,5 +68,3 @@ $ terraform apply
 
 No outputs.
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-

examples/easy/ec2/main.tf

@@ -28,6 +28,8 @@ module "vpc" {
   enable_dhcp_options              = true
   dhcp_options_domain_name_servers = ["AmazonProvidedDNS"]
 
+  map_public_ip_on_launch = true
+
   enable_ipv6                                   = var.enable_ipv6
   public_subnet_assign_ipv6_address_on_creation = var.enable_ipv6
   public_subnet_ipv6_prefixes                   = range(length(local.vpc_azs))
@@ -66,9 +68,9 @@ module "asg" {
   max_size            = 2
   desired_capacity    = 1
   health_check_type   = "EC2"
-  user_data = templatefile("../../templates/ec2_userdata.tpl", {
+  user_data = base64encode(templatefile("../../templates/ec2_userdata.tpl", {
     ecs_cluster = module.ecs_cluster.name
-  })
+  }))
   iam_instance_profile_arn = var.instance_profile_arn
 }
 

examples/templates/container_definitions.tpl

@@ -12,4 +12,4 @@
       }
     ]
   }
-]
+]

examples/templates/container_definitions_ec2_dynamic.tpl

@@ -13,4 +13,4 @@
       }
     ]
   }
-]
+]

modules/autoscaling/ecs-target-tracking/service-utilization/variables.tf

@@ -48,4 +48,4 @@ variable "disable_scale_in" {
   description = "Disable scale-in action, defaults to false"
   default     = false
   type        = bool
-}
+}

modules/core/README.md

@@ -4,4 +4,3 @@ This module contains core module to create `ECS Service` `ECS Task` and `ECS Aut
 
 Closest to the original `resources` with the streamlining of input.
 No more confusion on which should be terraform block or assignment, everything becomes assignments by map or list of maps.
-

modules/core/ecs-autoscaling-target/README.md

@@ -94,5 +94,3 @@ No modules.
 | <a name="output_scalable_dimension"></a> [scalable\_dimension](#output\_scalable\_dimension) | Scalable dimension for autoscaling target. Always ecs:service:DesiredCount. |
 | <a name="output_service_namespace"></a> [service\_namespace](#output\_service\_namespace) | Service namespace for autoscaling target. Always ecs |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-

modules/core/service/README.md

@@ -64,10 +64,10 @@ Since this module is the closest to the `resources` form, there are a lot of cus
 | <a name="input_name"></a> [name](#input\_name) | The service name. | `string` | n/a | yes |
 | <a name="input_network_configuration"></a> [network\_configuration](#input\_network\_configuration) | Map of a network configuration for the service. 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. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#network_configuration) | `any` | `null` | no |
 | <a name="input_ordered_placement_strategy"></a> [ordered\_placement\_strategy](#input\_ordered\_placement\_strategy) | List of map of service level strategy rules that are taken into consideration during task placement. List from top to bottom in order of precedence. Max 5. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#ordered_placement_strategy) | `list(any)` | `[]` | no |
-| <a name="input_placement_constraints"></a> [placement\_constraints](#input\_placement\_constraints) | List of map of placement constraints for Task Definition. Max 10. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#placement_constraints) | `list(any)` | `[]` | no |
 | <a name="input_platform_version"></a> [platform\_version](#input\_platform\_version) | The platform version on which to run your service. Only applicable for `launch_type` set to `FARGATE`. Defaults to `LATEST`. [AWS Docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) | `string` | `null` | no |
 | <a name="input_propagate_tags"></a> [propagate\_tags](#input\_propagate\_tags) | Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are `SERVICE` and `TASK_DEFINITION`. | `string` | `null` | no |
 | <a name="input_scheduling_strategy"></a> [scheduling\_strategy](#input\_scheduling\_strategy) | The scheduling strategy to use for the service. The valid values are `REPLICA` and `DAEMON`. Fargate Tasks do not support `DAEMON` scheduling strategy. | `string` | `null` | no |
+| <a name="input_service_placement_constraints"></a> [service\_placement\_constraints](#input\_service\_placement\_constraints) | List of map of placement constraints for Service. Max 10. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#placement_constraints) | `list(any)` | `[]` | no |
 | <a name="input_service_registry"></a> [service\_registry](#input\_service\_registry) | Map of a service discovery registries for the service. Consists of `registry_arn`, `port`(optional), `container_port`(optional), `container_port`(optional). [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#service_registries) | `any` | `null` | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | Key-value mapping of resource tags | `map(string)` | `{}` | no |
 | <a name="input_task_cpu"></a> [task\_cpu](#input\_task\_cpu) | Task level CPU units. | `number` | `null` | no |
@@ -77,6 +77,7 @@ Since this module is the closest to the `resources` form, there are a lot of cus
 | <a name="input_task_memory"></a> [task\_memory](#input\_task\_memory) | Task level Memory units. | `number` | `null` | no |
 | <a name="input_task_network_mode"></a> [task\_network\_mode](#input\_task\_network\_mode) | The network mode for container. | `string` | `"bridge"` | no |
 | <a name="input_task_pid_mode"></a> [task\_pid\_mode](#input\_task\_pid\_mode) | The process namespace to use for the containers in the task. The valid values are `host` and `task`. | `string` | `null` | no |
+| <a name="input_task_placement_constraints"></a> [task\_placement\_constraints](#input\_task\_placement\_constraints) | Placement constraints for Task Definition. List of map. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition#placement_constraints) | `list(any)` | `[]` | no |
 | <a name="input_task_proxy_configuration"></a> [task\_proxy\_configuration](#input\_task\_proxy\_configuration) | The proxy configuration details for the App Mesh proxy. Defined as map argument. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition#proxy_configuration) | `any` | `null` | no |
 | <a name="input_task_requires_compatibilites"></a> [task\_requires\_compatibilites](#input\_task\_requires\_compatibilites) | A set of launch types required by the task. The valid values are `EC2` and `FARGATE`. | `list(string)` | <pre>[<br>  "EC2"<br>]</pre> | no |
 | <a name="input_task_runtime_platform"></a> [task\_runtime\_platform](#input\_task\_runtime\_platform) | Runtime platform (operating system and CPU architecture) that containers may use. Defined as map argument. [Terraform Docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition#runtime_platform) | `any` | `null` | no |
@@ -95,5 +96,3 @@ Since this module is the closest to the `resources` form, there are a lot of cus
 | <a name="output_task_definition_name"></a> [task\_definition\_name](#output\_task\_definition\_name) | The name (family) of created Task Definition. |
 | <a name="output_task_definition_revision"></a> [task\_definition\_revision](#output\_task\_definition\_revision) | The revision of the task in a particular family |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
-

modules/core/service/main.tf

@@ -71,7 +71,7 @@ resource "aws_ecs_service" "main" {
   }
 
   dynamic "placement_constraints" {
-    for_each = var.placement_constraints
+    for_each = var.service_placement_constraints
     content {
       type       = lookup(placement_constraints.value, "type", null)
       expression = lookup(placement_constraints.value, "expression", null)
@@ -171,7 +171,7 @@ resource "aws_ecs_service" "main_ignore_desired_count_changes" {
   }
 
   dynamic "placement_constraints" {
-    for_each = var.placement_constraints
+    for_each = var.service_placement_constraints
     content {
       type       = lookup(placement_constraints.value, "type", null)
       expression = lookup(placement_constraints.value, "expression", null)
@@ -205,7 +205,7 @@ module "task" {
   memory                  = var.task_memory
   requires_compatibilites = var.task_requires_compatibilites
   volume_configurations   = var.task_volume_configurations
-  placement_constraints   = var.placement_constraints
+  placement_constraints   = var.task_placement_constraints
   inference_accelerator   = var.task_inference_accelerator
   proxy_configuration     = var.task_proxy_configuration
   runtime_platform        = var.task_runtime_platform