Skip to content

Latest commit

 

History

History
140 lines (103 loc) · 5.31 KB

README.md

File metadata and controls

140 lines (103 loc) · 5.31 KB
Raw

GitHub release (latest SemVer)

terraform-aws-ecs-service-autoscaling-cloudwatch

Terraform module to configure ECS Service autoscaling using CloudWatch metrics

Terraform versions

Terraform 0.12. Pin module version to ~> v2.0. Submit pull-requests to master branch.

Usage

module "ecs-service-autoscaling-cloudwatch" {
  source = "umotif-public/ecs-service-autoscaling-cloudwatch/aws"
  version = "~> 2.0.0"

  enabled = true

  name_prefix = "test-sqs-scalling"

  min_capacity = 1
  max_capacity = 20

  cluster_name = "dev-ecs"
  service_name = "dev-actions"

  scale_up_step_adjustment = [
    {
      scaling_adjustment          = 2
      metric_interval_lower_bound = 0
      metric_interval_upper_bound = "" # indicates inifinity
    }
  ]

  scale_down_step_adjustment = [
    {
      scaling_adjustment          = -4
      metric_interval_upper_bound = 0
      metric_interval_lower_bound = ""
    }
  ]

  metric_query = [
    {
      id = "visible"
      metric = [
        {
          namespace   = "AWS/SQS"
          metric_name = "ApproximateNumberOfMessagesVisible"
          period      = 60
          stat        = "Maximum"

          dimensions = {
            QueueName = "dev-actions-queue-name"
          }
        }
      ]
    }
  ]
}

Assumptions

Module is to be used with Terraform > 0.12.

Examples

Authors

Module managed by Marcin Cuber LinkedIn.

Requirements

Name Version
terraform >= 0.12.6
aws >= 2.45

Providers

Name Version
aws >= 2.45

Inputs

Name Description Type Default Required
adjustment_type_down Autoscaling policy down adjustment type (ExactCapacity, ChangeInCapacity, PercentChangeInCapacity) string "ChangeInCapacity" no
adjustment_type_up Autoscaling policy up adjustment type (ExactCapacity, ChangeInCapacity, PercentChangeInCapacity) string "ChangeInCapacity" no
cluster_name Name of ECS cluster that service is in string n/a yes
enabled Whether to create the resources. Set to false to prevent the module from creating any resources bool true no
high_evaluation_periods The number of periods over which data is compared to the high threshold string "1" no
high_threshold The value against which the high statistic is compared string "10" no
low_evaluation_periods The number of periods over which data is compared to the low threshold string "1" no
low_threshold The value against which the low statistic is compared string "10" no
max_capacity Maximum number of tasks to scale to string "5" no
metric_query Enables you to create an alarm based on a metric math expression. You may specify at most 20. any [] no
min_capacity Minimum number of tasks to scale to string "2" no
name_prefix A prefix used for naming resources. string n/a yes
scale_down_cooldown The amount of time, in seconds, after a scaling down completes and before the next scaling activity can start string "60" no
scale_down_min_adjustment_magnitude Minimum number of tasks to scale down at a time string "0" no
scale_down_step_adjustment A set of adjustments that manage scaling. Requires at least one object inside the list containing: metric_interval_lower_bound, metric_interval_upper_bound, scaling_adjustment. list(object({ metric_interval_lower_bound = string, metric_interval_upper_bound = string, scaling_adjustment = string })) [] no
scale_up_cooldown The amount of time, in seconds, after a scaling up completes and before the next scaling up can start string "60" no
scale_up_min_adjustment_magnitude Minimum number of tasks to scale up at a time string "0" no
scale_up_step_adjustment A set of adjustments that manage scaling. Requires at least one object inside the list containing: metric_interval_lower_bound, metric_interval_upper_bound, scaling_adjustment. list(object({ metric_interval_lower_bound = string, metric_interval_upper_bound = string, scaling_adjustment = string })) [] no
service_name Name of ECS service to autoscale string n/a yes
tags A mapping of tags to assign to all resources map(string) {} no

Outputs

No output.

License

See LICENSE for full details.

Pre-commit hooks

Install dependencies

MacOS

brew install pre-commit terraform-docs tflint

brew tap git-chglog/git-chglog
brew install git-chglog