tf-aws-module_collection-ecs_app

Overview

This module is a reference architecture terraform module that will provision a ECS service with all its dependencies in a provided ECS Cluster.

Note: Currently because of a bug with the provider, it is not possible to use terraform to perform redeploy on the ECS Service. The bug https://github.com/hashicorp/terraform-provider-aws/issues/28070 restricts users to enable the flag force_new_deployement on the terraform module. Hence, for now we can use this module to deploy the application to ECS Service for the first time but all the subsequent deployments needs to be performed some other way (using AWS CLI is one option).

Usage

A sample variable file example.tfvars is available in the root directory which can be used to test this module. User needs to follow the below steps to execute this module

1. Update the example.tfvars to manually enter values for all fields marked within <> to make the variable file usable
2. Create a file provider.tf with the below contents

    provider "aws" {
      profile = "<profile_name>"
      region  = "<region_name>"
    }
   

   If using SSO, make sure you are logged in aws sso login --profile <profile_name>
3. Make sure terraform binary is installed on your local. Use command type terraform to find the installation location. If you are using asdf, you can run asfd install and it will install the correct terraform version for you. .tool-version contains all the dependencies.
4. Run the terraform to provision infrastructure on AWS

   # Initialize
   terraform init
   # Plan
   terraform plan -var-file example.tfvars
   # Apply (this is create the actual infrastructure)
   terraform apply -var-file example.tfvars -auto-approve
   

Known Issues

1. When force_new_deployment=true, we get this error: https://github.com/hashicorp/terraform-provider-aws/issues/28070
2. Access Logs in ALB: https://github.com/hashicorp/terraform-provider-aws/issues/16674

Pre-Commit hooks

.pre-commit-config.yaml file defines certain pre-commit hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.

commitlint hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:

• fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
• feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
• BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
• build: a commit of the type build adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• chore: a commit of the type chore adds changes that don't modify src or test files
• ci: a commit of the type ci adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: a commit of the type docs adds documentation only changes
• perf: a commit of the type perf adds code change that improves performance
• refactor: a commit of the type refactor adds code change that neither fixes a bug nor adds a feature
• revert: a commit of the type revert reverts a previous commit
• style: a commit of the type style adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: a commit of the type test adds missing tests or correcting existing tests

Base configuration used for this project is commitlint-config-conventional (based on the Angular convention)

If you are a developer using vscode, this plugin may be helpful.

detect-secrets-hook prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS

In order for pre-commit hooks to work properly

• You need to have the pre-commit package manager installed. Here are the installation instructions.
• pre-commit would install all the hooks when commit message is added by default except for commitlint hook. commitlint hook would need to be installed manually using the command below

pre-commit install --hook-type commit-msg

To test the resource group module locally

1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the configure target in the project's Makefile. Before you can run configure, familiarize yourself with the variables in the Makefile and ensure they're pointing to the right places.

make configure

This adds in several files and directories that are ignored by git. They expose many new Make targets.

2. The first target you care about is env. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.

make configure command will bring down aws_env.sh file on local workstation. Developer would need to modify this file, replace the environment variable values with relevant values.

These environment variables are used by terratest integration suit.

Then run this make target to set the environment variables on developer workstation.

make env

3. The first target you care about is check.

Pre-requisites Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are aws specific. If primitive/segment under development uses any other cloud provider than AWS, this section may not be relevant.

• A file named provider.tf with contents below

provider "aws" {
  profile = "<profile_name>"
  region  = "<region_name>"
}

• A file named terraform.tfvars which contains key value pairs of variables used.

Note that since these files are added in gitignore they would not be checked in into primitive/segment's git repo.

After creating these files, for running tests associated with the primitive/segment, run

make check

If make check target is successful, developer is good to commit the code to primitive/segment's git repo.

make check target

• runs terraform commands to lint,validate and plan terraform code.
• runs conftests. conftests make sure policy checks are successful.
• runs terratest. This is integration test suit.
• runs opa tests

Requirements

Providers

Modules

Resources

Inputs

map(object({
    name       = string
    max_length = optional(number, 60)
  }))

{
  "acm": {
    "max_length": 60,
    "name": "acm"
  },
  "alb": {
    "max_length": 31,
    "name": "alb"
  },
  "alb_http_listener": {
    "max_length": 60,
    "name": "http"
  },
  "alb_https_listener": {
    "max_length": 60,
    "name": "https"
  },
  "alb_sg": {
    "max_length": 60,
    "name": "albsg"
  },
  "alb_tg": {
    "max_length": 31,
    "name": "albtg"
  },
  "ecr": {
    "max_length": 60,
    "name": "ecr"
  },
  "ecs_service": {
    "max_length": 60,
    "name": "svc"
  },
  "ecs_sg": {
    "max_length": 60,
    "name": "ecssg"
  },
  "ecs_task": {
    "max_length": 60,
    "name": "td"
  },
  "s3_config": {
    "max_length": 63,
    "name": "conf"
  },
  "s3_logs": {
    "max_length": 63,
    "name": "logs"
  },
  "task_exec_policy": {
    "max_length": 60,
    "name": "execplcy"
  },
  "task_exec_role": {
    "max_length": 60,
    "name": "execrole"
  },
  "task_policy": {
    "max_length": 60,
    "name": "taskplcy"
  },
  "task_role": {
    "max_length": 60,
    "name": "taskrole"
  },
  "vpc": {
    "max_length": 60,
    "name": "vpc"
  }
}

object({
    ingress_rules            = optional(list(string))
    ingress_cidr_blocks      = optional(list(string))
    ingress_with_cidr_blocks = optional(list(map(string)))
    egress_rules             = optional(list(string))
    egress_cidr_blocks       = optional(list(string))
    egress_with_cidr_blocks  = optional(list(map(string)))
    ingress_with_sg          = optional(list(map(string)))
    egress_with_sg           = optional(list(map(string)))
  })

object({
    description              = optional(string)
    ingress_rules            = optional(list(string))
    ingress_cidr_blocks      = optional(list(string))
    egress_rules             = optional(list(string))
    egress_cidr_blocks       = optional(list(string))
    ingress_with_cidr_blocks = optional(list(map(string)))
    egress_with_cidr_blocks  = optional(list(map(string)))
  })

list(object({
    # Need to use name_prefix instead of name as the lifecycle property create_before_destroy is set
    name_prefix      = optional(string, "albtg")
    backend_protocol = optional(string, "HTTP")
    backend_port     = optional(number, 80)
    target_type      = optional(string, "ip")
    health_check     = optional(map(string), {})
  }))

list(object({
    port        = number
    protocol    = string
    action_type = string
    redirect    = any
  }))

list(object({
    port     = number
    protocol = string
    #certificate_arn = string
  }))

list(object({
    name                     = string
    command                  = optional(list(string), [])
    essential                = optional(bool, false)
    cpu                      = optional(number, 0)
    memory                   = optional(number, null)
    memory_reservation       = optional(number, null)
    readonly_root_filesystem = optional(bool, false)
    environment              = optional(map(string), null)
    secrets                  = optional(map(string), null)
    mount_points = optional(list(object({
      containerPath = optional(string)
      readOnly      = optional(bool, false)
      sourceVolume  = optional(string)
    })), [])
    port_mappings = optional(list(object({
      containerPort = number
      hostPort      = optional(number)
      protocol      = optional(string, "tcp")
    })), [])
    healthcheck = optional(object({
      retries     = number
      command     = list(string)
      timeout     = number
      interval    = number
      startPeriod = number
    }), null)
    user = optional(string, null)
    container_depends_on = optional(list(object({
      containerName = string
      condition     = string
    })), [])
    log_configuration = optional(object({
      logDriver = optional(string, "awslogs")
      options = object({
        awslogs-group         = string
        awslogs-region        = string
        awslogs-create-group  = optional(string, "true")
        awslogs-stream-prefix = string
      })
    }), null)
  }))

Outputs