module-base-ecs-cluster

This terraform module allow creates an ECS Cluster with necessary configuration how Container Insight, Capacity Provider, Log Group and Discovery Namespace

This module is prepared to create a log group and configure it in the ECS cluster with the default configuration, to do this you must set the create_log_group variable to true.
If you do not want to create the log group and perform the configuration you must inform the cluster_configuration variable and this variable admits the following fields or parameters: 
execute_command_configuration - (Optional) The details of the execute command configuration. Detailed below.

 execute_command_configuration:
     kms_key_id - (Optional) The AWS Key Management Service key ID to encrypt the data between the local client and the container.
     log_configuration - (Optional) The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
     logging - (Optional) The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.

 log_configuration:
     cloud_watch_encryption_enabled - (Optional) Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
     cloud_watch_log_group_name - (Optional) The name of the CloudWatch log group to send logs to.
     s3_bucket_name - (Optional) The name of the S3 bucket to send logs to.
     s3_bucket_encryption_enabled - (Optional) Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
     s3_key_prefix - (Optional) An optional folder in the S3 bucket to place logs in.
This module is prepared to create a Dicovery Namespace and configure it in the ECS cluster with the default configuration, to do this you must set the create_discovery_namespace variable to true.

Usage example

Basic

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  tags = local.tags
}

Basic with containerInsights enabled

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  container_insights = true

  tags = local.tags
}

Complete with default_capacity_provider_strategy

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  default_capacity_provider_strategy = [
    {
      capacity_provider = "FARGATE_SPOT"
      weight            = 1
      base              = 0
    }
  ]

  tags = local.tags
}

Complete with default_capacity_provider_strategy and extra_capacity_providers

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  default_capacity_provider_strategy = [
    {
      capacity_provider = "FARGATE"
      weight            = 1
      base              = 0
    },
    {
      capacity_provider = "FARGATE_SPOT"
      weight            = 1
      base              = 0
    }
  ]
  extra_capacity_providers = ["TEST"]

  tags = local.tags
}

Complete with default_capacity_provider_strategy, extra_capacity_providers, create log group with default and basic configuration and discovery namespace

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  create_discovery_namespace = true
  create_log_group           = true

  default_capacity_provider_strategy = [
    {
      capacity_provider = "FARGATE"
      weight            = 1
      base              = 0
    },
    {
      capacity_provider = "FARGATE_SPOT"
      weight            = 1
      base              = 0
    }
  ]
  extra_capacity_providers = ["TEST"]

  tags = local.tags
}

Complete with default_capacity_provider_strategy, extra_capacity_providers, create log group with custom configuration

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  create_log_group = true

  cluster_configuration = {
   execute_command_configuration = {
     logging = "OVERRIDE"
     log_configuration = {
       cloud_watch_encryption_enabled = true
       s3_bucket_name                 = "s3-bucket-name"
       s3_bucket_encryption_enabled   = true
     }
   }
 }

  default_capacity_provider_strategy = [
    {
      capacity_provider = "FARGATE"
      weight            = 1
      base              = 0
    },
    {
      capacity_provider = "FARGATE_SPOT"
      weight            = 1
      base              = 0
    }
  ]
  extra_capacity_providers = ["TEST"]

  tags = local.tags
}

Complete with default_capacity_provider_strategy, extra_capacity_providers, custom configuration to execute_command_configuration without create log group and create discovery namespace and with containerInsights enabled

module "cluster" {
  source = "git::https://gitlab.vectoritcgroup.com/vectordigital/iac/terraform/modules/aws/compute/module-base-ecs-cluster.git?ref=vX.Y.Z"

  prefix     = var.prefix
  aws_region = var.aws_region
  name       = var.name

  container_insights = true

  create_discovery_namespace = true

  cluster_configuration = {
    execute_command_configuration = {
      logging = "OVERRIDE"
      log_configuration = {
        cloud_watch_encryption_enabled = true
        cloud_watch_log_group_name     = "/aws/ecs/aws-ec2"
        s3_bucket_name                 = "mmm"
        s3_bucket_encryption_enabled   = true
      }
    }
  }

  default_capacity_provider_strategy = [
    {
      capacity_provider = "FARGATE"
      weight            = 1
      base              = 0
    },
    {
      capacity_provider = "FARGATE_SPOT"
      weight            = 1
      base              = 0
    }
  ]
  extra_capacity_providers = ["TEST"]

  tags = local.tags
}

Module argument reference

Modules

No modules.

Resources

Name Type

aws_cloudwatch_log_group.this

resource

aws_ecs_cluster.this

resource

aws_ecs_cluster_capacity_providers.example

resource

aws_service_discovery_http_namespace.this

resource

Inputs

Name Description Type Default Required

aws_region

AWS Region name where the ECS cluster will be deployed

string

n/a

yes

cluster_configuration

The execute command configuration for the cluster

any

{}

no

create_discovery_namespace

Determines whether a service_discovery_namespace is created by this module for the cluster service_connect_defaults

bool

false

no

create_log_group

Determines whether a log group is created by this module for the cluster logs. If not, AWS will automatically create one if logging is enabled

bool

false

no

custom_log_group_name

Custom name of CloudWatch Log Group for ECS cluster

string

""

no

default_capacity_provider_strategy

The capacity provider strategy to use by default for the cluster. Can be one or more

 
list(object({
    capacity_provider = string
    weight            = number
    base              = number
  }))

[]

no

enabled_container_insights

If is true you enabled container_insights for ECS cluster. By default is false

bool

false

no

extra_capacity_providers

Allow attach to Cluster an existing capacity providers

list(string)

[]

no

log_group_kms_key_id

If a KMS Key ARN is set, this key will be used to encrypt the corresponding log group. Please be sure that the KMS Key has an appropriate key policy (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)

string

""

no

log_group_retention_in_days

Number of days to retain log events

number

90

no

name

The name of the ECS cluster (up to 255 letters, numbers, hyphens, and underscores)

string

n/a

yes

prefix

The prefix to be attached to every resource name

string

n/a

yes

tags

Specific tags for all module resources

map(string)

n/a

yes

Outputs

Name Description

cloudwatch_log_group_arn

ARN of CloudWatch log group created

cloudwatch_log_group_name

Name of CloudWatch log group created

cluster_arn

The Amazon Resource Name (ARN) that identifies this ECS cluster

cluster_id

The ECS cluster identifier

cluster_name

The ECS cluster name

default_capacity_providers

n/a

service_discovery_http_namespace_arn

ARN of CloudWatch log group created