cloudposse / terraform-aws-ec2-autoscale-group Goto Github PK

View Code? Open in Web Editor NEW

129.0 22.0 143.0 259 KB

Terraform module to provision Auto Scaling Group and Launch Template on AWS

Home Page: https://cloudposse.com/accelerate

License: Apache License 2.0

Makefile 4.85% HCL 90.87% Go 4.28%

autoscaling launch template aws autoscaling-policies cloudwatch-metric autoscaling-group ec2 ami amazon-web-services

terraform-aws-ec2-autoscale-group's Introduction

Terraform module to provision Auto Scaling Group and Launch Template on AWS.

The module also creates AutoScaling Policies and CloudWatch Metric Alarms to monitor CPU utilization on the EC2 instances and scale the number of instance in the AutoScaling Group up or down. If you don't want to use the provided functionality, or want to provide your own policies, disable it by setting the variable autoscaling_policies_enabled to false.

At present, although you can set the created AutoScaling Policy type to any legal value, in practice only SimpleScaling is supported. To use a StepScaling or TargetTrackingScaling policy, create it yourself and then pass it in the alarm_actions field of custom_alarms.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

locals {
  userdata = <<-USERDATA
    #!/bin/bash
    cat <<"__EOF__" > /home/ec2-user/.ssh/config
    Host *
      StrictHostKeyChecking no
    __EOF__
    chmod 600 /home/ec2-user/.ssh/config
    chown ec2-user:ec2-user /home/ec2-user/.ssh/config
  USERDATA
}

module "autoscale_group" {
  source = "cloudposse/ec2-autoscale-group/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  namespace   = var.namespace
  stage       = var.stage
  environment = var.environment
  name        = var.name

  image_id                    = "ami-08cab282f9979fc7a"
  instance_type               = "t2.small"
  security_group_ids          = ["sg-xxxxxxxx"]
  subnet_ids                  = ["subnet-xxxxxxxx", "subnet-yyyyyyyy", "subnet-zzzzzzzz"]
  health_check_type           = "EC2"
  min_size                    = 2
  max_size                    = 3
  wait_for_capacity_timeout   = "5m"
  associate_public_ip_address = true
  user_data_base64            = base64encode(local.userdata)

  # All inputs to `block_device_mappings` have to be defined
  block_device_mappings = [
    {
      device_name  = "/dev/sda1"
      no_device    = "false"
      virtual_name = "root"
      ebs = {
        encrypted             = true
        volume_size           = 200
        delete_on_termination = true
        iops                  = null
        kms_key_id            = null
        snapshot_id           = null
        volume_type           = "standard"
      }
    }
  ]

  tags = {
    Tier              = "1"
    KubernetesCluster = "us-west-2.testing.cloudposse.co"
  }

  # Auto-scaling policies and CloudWatch metric alarms
  autoscaling_policies_enabled           = true
  cpu_utilization_high_threshold_percent = "70"
  cpu_utilization_low_threshold_percent  = "20"
}

To enable custom_alerts the map needs to be defined like so :

alarms = {
    alb_scale_up = {
      alarm_name                = "${module.default_label.id}-alb-target-response-time-for-scale-up"
      comparison_operator       = "GreaterThanThreshold"
      evaluation_periods        = var.alb_target_group_alarms_evaluation_periods
      metric_name               = "TargetResponseTime"
      namespace                 = "AWS/ApplicationELB"
      period                    = var.alb_target_group_alarms_period
      statistic                 = "Average"
      threshold                 = var.alb_target_group_alarms_response_time_max_threshold
      dimensions_name           = "LoadBalancer"
      dimensions_target         = data.alb.arn_suffix
      treat_missing_data        = "missing"
      ok_actions                = var.alb_target_group_alarms_ok_actions
      insufficient_data_actions = var.alb_target_group_alarms_insufficient_data_actions
      alarm_description         = "ALB Target response time is over ${var.alb_target_group_alarms_response_time_max_threshold} for more than ${var.alb_target_group_alarms_period}"
      alarm_actions             = [module.autoscaling.scale_up_policy_arn]
    }
}

All those keys are required to be there so if the alarm you are setting does not requiere one or more keys you can just set to empty but do not remove the keys otherwise you could get a weird merge error due to the maps being of different sizes.

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.3
aws	>= 5.16

Providers

Name	Version
aws	>= 5.16

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_autoscaling_group.default	resource
aws_autoscaling_policy.scale_down	resource
aws_autoscaling_policy.scale_up	resource
aws_cloudwatch_metric_alarm.all_alarms	resource
aws_launch_template.default	resource
aws_subnet.this	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
associate_public_ip_address	Associate a public IP address with an instance in a VPC. If `network_interface_id` is specified, this can only be `false` (see here for more info: https://stackoverflow.com/a/76808361).	`bool`	`false`	no
attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the `delimiter` and treated as a single ID element.	`list(string)`	`[]`	no
autoscaling_policies_enabled	Whether to create `aws_autoscaling_policy` and `aws_cloudwatch_metric_alarm` resources to control Auto Scaling	`bool`	`true`	no
block_device_mappings	Specify volumes to attach to the instance besides the volumes specified by the AMI	list(object({ device_name = optional(string) no_device = optional(bool) virtual_name = optional(string) ebs = object({ delete_on_termination = optional(bool) encrypted = optional(bool) iops = optional(number) throughput = optional(number) kms_key_id = optional(string) snapshot_id = optional(string) volume_size = optional(number) volume_type = optional(string) }) }))	`[]`	no
capacity_rebalance	Indicates whether capacity rebalance is enabled. Otherwise, capacity rebalance is disabled.	`bool`	`false`	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as `null` to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	`any`	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
cpu_utilization_high_evaluation_periods	The number of periods over which data is compared to the specified threshold	`number`	`2`	no
cpu_utilization_high_period_seconds	The period in seconds over which the specified statistic is applied	`number`	`300`	no
cpu_utilization_high_statistic	The statistic to apply to the alarm's associated metric. Either of the following is supported: `SampleCount`, `Average`, `Sum`, `Minimum`, `Maximum`	`string`	`"Average"`	no
cpu_utilization_high_threshold_percent	The value against which the specified statistic is compared	`number`	`90`	no
cpu_utilization_low_evaluation_periods	The number of periods over which data is compared to the specified threshold	`number`	`2`	no
cpu_utilization_low_period_seconds	The period in seconds over which the specified statistic is applied	`number`	`300`	no
cpu_utilization_low_statistic	The statistic to apply to the alarm's associated metric. Either of the following is supported: `SampleCount`, `Average`, `Sum`, `Minimum`, `Maximum`	`string`	`"Average"`	no
cpu_utilization_low_threshold_percent	The value against which the specified statistic is compared	`number`	`10`	no
credit_specification	Customize the credit specification of the instances	object({ cpu_credits = string })	`null`	no
custom_alarms	Map of custom CloudWatch alarms configurations	map(object({ alarm_name = string comparison_operator = string evaluation_periods = string metric_name = string namespace = string period = string statistic = string extended_statistic = string threshold = string treat_missing_data = string ok_actions = list(string) insufficient_data_actions = list(string) dimensions_name = string dimensions_target = string alarm_description = string alarm_actions = list(string) }))	`{}`	no
default_alarms_enabled	Enable or disable cpu and memory Cloudwatch alarms	`bool`	`true`	no
default_cooldown	The amount of time, in seconds, after a scaling activity completes before another scaling activity can start	`number`	`300`	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map. Map of maps. Keys are names of descriptors. Values are maps of the form `{<br> format = string<br> labels = list(string)<br>}` (Type is `any` so the map values can later be enhanced to provide additional options.) `format` is a Terraform format string to be passed to the `format()` function. `labels` is a list of labels, in order, to pass to `format()` function. Label values will be normalized before being passed to `format()` so they will be identical to how they appear in `id`. Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
desired_capacity	The number of Amazon EC2 instances that should be running in the group, if not set will use `min_size` as value	`number`	`null`	no
disable_api_termination	If `true`, enables EC2 Instance Termination Protection	`bool`	`false`	no
ebs_optimized	If true, the launched EC2 instance will be EBS-optimized	`bool`	`false`	no
elastic_gpu_specifications	Specifications of Elastic GPU to attach to the instances	object({ type = string })	`null`	no
enable_monitoring	Enable/disable detailed monitoring	`bool`	`true`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
enabled_metrics	A list of metrics to collect. The allowed values are `GroupMinSize`, `GroupMaxSize`, `GroupDesiredCapacity`, `GroupInServiceInstances`, `GroupPendingInstances`, `GroupStandbyInstances`, `GroupTerminatingInstances`, `GroupTotalInstances`	`list(string)`	[ "GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances" ]	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
force_delete	Allows deleting the autoscaling group without waiting for all instances in the pool to terminate. You can force an autoscaling group to delete even if it's in the process of scaling a resource. Normally, Terraform drains all the instances before deleting the group. This bypasses that behavior and potentially leaves resources dangling	`bool`	`false`	no
health_check_grace_period	Time (in seconds) after instance comes into service before checking health	`number`	`300`	no
health_check_type	Controls how health checking is done. Valid values are `EC2` or `ELB`	`string`	`"EC2"`	no
iam_instance_profile_name	The IAM instance profile name to associate with launched instances	`string`	`""`	no
id_length_limit	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. Set to `null` for keep the existing setting, which defaults to `0`. Does not affect `id_full`.	`number`	`null`	no
image_id	The EC2 image ID to launch	`string`	`""`	no
instance_initiated_shutdown_behavior	Shutdown behavior for the instances. Can be `stop` or `terminate`	`string`	`"terminate"`	no
instance_market_options	The market (purchasing) option for the instances	object({ market_type = string spot_options = optional(object({ block_duration_minutes = optional(number) instance_interruption_behavior = optional(string) max_price = optional(number) spot_instance_type = optional(string) valid_until = optional(string) })) })	`null`	no
instance_refresh	The instance refresh definition	object({ strategy = string preferences = optional(object({ instance_warmup = optional(number, null) min_healthy_percentage = optional(number, null) skip_matching = optional(bool, null) auto_rollback = optional(bool, null) scale_in_protected_instances = optional(string, null) standby_instances = optional(string, null) }), null) triggers = optional(list(string), []) })	`null`	no
instance_reuse_policy	If warm pool and this block are configured, instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.	object({ reuse_on_scale_in = bool })	`null`	no
instance_type	Instance type to launch	`string`	n/a	yes
key_name	The SSH key name that should be used for the instance	`string`	`""`	no
label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper`. Default value: `title`.	`string`	`null`	no
label_order	The order in which the labels (ID elements) appear in the `id`. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
label_value_case	Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually. Does not affect values of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper` and `none` (no transformation). Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. Default value: `lower`.	`string`	`null`	no
labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output. Default is to include all labels. Tags with empty values will not be included in the `tags` output. Set to `[]` to suppress all generated tags. Notes: The value of the `name` tag, if included, will be the `id`, not the `name`. Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ "default" ]	no
launch_template_version	Launch template version. Can be version number, `$Latest` or `$Default`	`string`	`"$Latest"`	no
load_balancers	A list of elastic load balancer names to add to the autoscaling group names. Only valid for classic load balancers. For ALBs, use `target_group_arns` instead	`list(string)`	`[]`	no
max_instance_lifetime	The maximum amount of time, in seconds, that an instance can be in service, values must be either equal to 0 or between 604800 and 31536000 seconds	`number`	`null`	no
max_size	The maximum size of the autoscale group	`number`	n/a	yes
metadata_http_endpoint_enabled	Set false to disable the Instance Metadata Service.	`bool`	`true`	no
metadata_http_protocol_ipv6_enabled	Set true to enable IPv6 in the launch template.	`bool`	`false`	no
metadata_http_put_response_hop_limit	The desired HTTP PUT response hop limit (between 1 and 64) for Instance Metadata Service requests. The default is `2` to support containerized workloads.	`number`	`2`	no
metadata_http_tokens_required	Set true to require IMDS session tokens, disabling Instance Metadata Service Version 1.	`bool`	`true`	no
metadata_instance_metadata_tags_enabled	Set true to enable metadata tags in the launch template.	`bool`	`false`	no
metrics_granularity	The granularity to associate with the metrics to collect. The only valid value is 1Minute	`string`	`"1Minute"`	no
min_elb_capacity	Setting this causes Terraform to wait for this number of instances to show up healthy in the ELB only on creation. Updates will not wait on ELB instance number changes	`number`	`0`	no
min_size	The minimum size of the autoscale group	`number`	n/a	yes
mixed_instances_policy	policy to used mixed group of on demand/spot of differing types. Launch template is automatically generated. https://www.terraform.io/docs/providers/aws/r/autoscaling_group.html#mixed_instances_policy-1	object({ instances_distribution = optional(object({ on_demand_allocation_strategy = string on_demand_base_capacity = number on_demand_percentage_above_base_capacity = number spot_allocation_strategy = string spot_instance_pools = number spot_max_price = string })) override = optional(list(object({ instance_type = string weighted_capacity = number }))) })	`null`	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a `tag`. The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
network_interface_id	The ID of the network interface to attach. If specified, all the other network_interface block arguments are ignored.	`string`	`null`	no
placement	The placement specifications of the instances	object({ affinity = string availability_zone = string group_name = string host_id = string tenancy = string })	`null`	no
placement_group	The name of the placement group into which you'll launch your instances, if any	`string`	`""`	no
protect_from_scale_in	Allows setting instance protection. The autoscaling group will not select instances with this setting for terminination during scale in events	`bool`	`false`	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
scale_down_adjustment_type	Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity` and `PercentChangeInCapacity`	`string`	`"ChangeInCapacity"`	no
scale_down_cooldown_seconds	The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start	`number`	`300`	no
scale_down_policy_type	The scaling policy type. Currently only `SimpleScaling` is supported	`string`	`"SimpleScaling"`	no
scale_down_scaling_adjustment	The number of instances by which to scale. `scale_down_scaling_adjustment` determines the interpretation of this number (e.g. as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity	`number`	`-1`	no
scale_up_adjustment_type	Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity` and `PercentChangeInCapacity`	`string`	`"ChangeInCapacity"`	no
scale_up_cooldown_seconds	The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start	`number`	`300`	no
scale_up_policy_type	The scaling policy type. Currently only `SimpleScaling` is supported	`string`	`"SimpleScaling"`	no
scale_up_scaling_adjustment	The number of instances by which to scale. `scale_up_adjustment_type` determines the interpretation of this number (e.g. as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity	`number`	`1`	no
security_group_ids	A list of associated security group IDs	`list(string)`	`[]`	no
service_linked_role_arn	The ARN of the service-linked role that the ASG will use to call other AWS services	`string`	`""`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
subnet_ids	A list of subnet IDs to launch resources in	`list(string)`	n/a	yes
suspended_processes	A list of processes to suspend for the AutoScaling Group. The allowed values are `Launch`, `Terminate`, `HealthCheck`, `ReplaceUnhealthy`, `AZRebalance`, `AlarmNotification`, `ScheduledActions`, `AddToLoadBalancer`. Note that if you suspend either the `Launch` or `Terminate` process types, it can prevent your autoscaling group from functioning properly.	`list(string)`	`[]`	no
tag_specifications_resource_types	List of tag specification resource types to tag. Valid values are instance, volume, elastic-gpu and spot-instances-request.	`set(string)`	[ "instance", "volume" ]	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
target_group_arns	A list of aws_alb_target_group ARNs, for use with Application Load Balancing	`list(string)`	`[]`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
termination_policies	A list of policies to decide how the instances in the auto scale group should be terminated. The allowed values are `OldestInstance`, `NewestInstance`, `OldestLaunchConfiguration`, `ClosestToNextInstanceHour`, `Default`	`list(string)`	[ "Default" ]	no
update_default_version	Whether to update Default version of Launch template each update	`bool`	`false`	no
user_data_base64	The Base64-encoded user data to provide when launching the instances	`string`	`""`	no
wait_for_capacity_timeout	A maximum duration that Terraform should wait for ASG instances to be healthy before timing out. Setting this to '0' causes Terraform to skip all Capacity Waiting behavior	`string`	`"10m"`	no
wait_for_elb_capacity	Setting this will cause Terraform to wait for exactly this number of healthy instances in all attached load balancers on both create and update operations. Takes precedence over `min_elb_capacity` behavior	`number`	`0`	no
warm_pool	If this block is configured, add a Warm Pool to the specified Auto Scaling group. See warm_pool.	object({ pool_state = string min_size = number max_group_prepared_capacity = number })	`null`	no

Outputs

Name	Description
autoscaling_group_arn	ARN of the AutoScaling Group
autoscaling_group_default_cooldown	Time between a scaling activity and the succeeding scaling activity
autoscaling_group_desired_capacity	The number of Amazon EC2 instances that should be running in the group
autoscaling_group_health_check_grace_period	Time after instance comes into service before checking health
autoscaling_group_health_check_type	`EC2` or `ELB`. Controls how health checking is done
autoscaling_group_id	The AutoScaling Group id
autoscaling_group_max_size	The maximum size of the autoscale group
autoscaling_group_min_size	The minimum size of the autoscale group
autoscaling_group_name	The AutoScaling Group name
autoscaling_group_tags	A list of tag settings associated with the AutoScaling Group
autoscaling_policy_scale_down_arn	ARN of the AutoScaling policy scale down
autoscaling_policy_scale_up_arn	ARN of the AutoScaling policy scale up
launch_template_arn	The ARN of the launch template
launch_template_id	The ID of the launch template

Related Projects

Check out these related projects.

terraform-aws-ec2-instance - Terraform module for providing a general purpose EC2 instance
terraform-aws-ec2-bastion-server - Terraform module to define a generic bastion host with parameterized user data
terraform-aws-ec2-admin-server - Terraform module for providing an EC2 instance capable of running admin tasks
terraform-aws-ec2-instance-group - Terraform module for provisioning multiple general purpose EC2 hosts for stateful applications
terraform-aws-ec2-ami-snapshot - Terraform module to easily generate AMI snapshots to create replica instances

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it with you.
✅ You own everything.
✅ Your team wins.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

terraform-aws-ec2-autoscale-group's People

Contributors

Stargazers

Watchers

Forkers

rohityadav225 wintergren tunein kudaz28 krisinampudi changwuf31 victorcuascut nagarameshreddy aric-h rverma-nikiai rei-devopsplatform docebo-legacy tnielsen2 ozbillwang formunauts jessie00chen instructure blackbookusa rlewkowicz fedemzcor ssprasad100 andreazorzetto chandruk1991 chrismckee joshmyers shaunc amitganvir23 avantageusa measurabl nandkishore2009 shnarwal123 adamcrews vkhatri srinivas-yatirajula ronaldkonjer dmkonst rah44 aleriera11 maheshdte lablabs cogentwebworks ibawany65 dtanhv1704 harana-oss abcbharath dotcipher scalyr td-vijay santhoshpog zhengc1 tthayer kanukollunaren davidjeddy continix damav zackzackzackzack oblatespheroid marcusjack ndanl jwjones2 k-hasan-19 dmitriy-lukyanchikov azec-pdx alexandr-its intelliflo admirationmr arun9theja msmagoo87 letfn iliabuleh robertoua byjacob apulijala franklinharry ramanjireddyvempalli cdwbrad jdoshi110 linhkikuchi tanujd11 ramu143-cpu cdobbyn maxkavun leonardomn pidikiti1149 sahotay objecttechnica bernyfr yemisi broadstonestech shmileee davidjameshowell pxsushil thuo-thuo ryanoatz99 kevcube cythergithub karim7262 getzgkg zen niazhussain

terraform-aws-ec2-autoscale-group's Issues

Error your example.

I tested your samples.
But I encountered "terraform crash"
I upload crash log.
Could you check it please?
https://gist.github.com/sanggiChoi/e25d85fbf5dfc85bd04c6e0ff945fdbf

Thanks.

Expose metadata_options {instance_metadata_tags}

Describe the Feature

For some time AWS allows to enable instance tags in metadata through:

  metadata_options {
    instance_metadata_tags = "enabled"
  }

See: https://aws.amazon.com/about-aws/whats-new/2022/01/instance-tags-amazon-ec2-instance-metadata-service/

Expected Behavior

Ability to enable instance_metadata_tags

Use Case

This is very hand for setting up a hostname from "Tag:Name" and other useful automations without AWS SDK installed e.g. following cloud init example old way:

set -x
r=$(exec curl -s http://169.254.169.254/latest/dynamic/instance-identity/document/ | jq -r .region)
i=$(exec curl -s http://169.254.169.254/latest/dynamic/instance-identity/document/ | jq -r .instanceId)
n=$(aws ec2 --region "$r" describe-instances --instance-ids "$i" | jq -r '.Reservations[].Instances[].Tags[] | select(.Key=="Name") | .Value')
if [[ -n "$n" ]]; then
    hostnamectl set-hostname --static "$n" 
fi

Simpler way:

set -x

n=$(curl http://169.254.169.254/latest/meta-data/tags/instance)
if [[ -n "$n" ]]; then
    hostnamectl set-hostname --static "$n" 
fi

Describe Ideal Solution

Just add it to the TF ;)

Alternatives Considered

There are no alternatives.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Scaling policy type does not support all its possible values

Describe the Bug

Module has variables scale_up_policy_type and scale_down_policy_type. According to documentation they support all values allowed in autoscaling_policy tf resource namely SimpleScaling, StepScaling and TargetTrackingScaling. On the other hand implementation of scaling policies does not contain blocks step_adjustments and target_tracking_configuration which are necessary to use StepScaling or TargetTrackingScaling respectively. This means that effectively only SimpleScaling is available.

Expected Behavior

Option A - support SimpleScaling

Drop variables scale_*_policy_type and replace them with hardcoded SimpleScaling
Explicit description of this in readme

Option B - full support for all three policies

instance_market_options example

Would you please give an example for instance_market_options ?

According to https://www.terraform.io/docs/providers/aws/r/launch_template.html#market-options

  instance_market_options {
    market_type = "spot"
  }

should it be list or map?

Support terraform 0.15

The error I get when using terraform 0.15.0

│ Error: Error in function call
│
│   on .terraform/modules/redacted.ecs.autoscale_group/main.tf line 14, in resource "aws_launch_template" "default":
│   14:         for_each = flatten(list(lookup(block_device_mappings.value, "ebs", [])))
│     ├────────────────
│     │ block_device_mappings.value will be known only after apply
│
│ Call to function "list" failed: the "list" function was deprecated in Terraform v0.12 and is no longer available; use tolist([ ... ]) syntax to write a literal list.
╵

Support AWS provider 3.x

Describe the Feature

AWS Provider 3.x has been released.

Expected Behavior

This module supports the new provider version.

Terraform AWS Provider Version 3 Upgrade Guide

Remove deprecated provider `hashicorp/template`

Describe the Bug

I got the error attached below in the logs section, when using this module because it requires hashicorp/template. I checked and it doesn't seem like you use it anymore.

Expected Behavior

Initializing the module without any errors.

Steps to Reproduce

Steps to reproduce the behavior:

Create the file with the module at its newest version using the darwin_arm64 platform.
Try to run terraform init.

Logs

Error: Incompatible provider version
Provider registry.terraform.io/hashicorp/template v2.2.0 does not
have a package available for your current platform, darwin_arm64.

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: macOS Big Sur
Version: 11.6

Mark object type attributes as optional if they're optional in aws provider

Found a bug? Maybe our Slack Community can help.

Describe the Bug

Object type attributes are not marked as optional when they are. It requires to set them to null explicitly.
For instance:

  mixed_instances_policy = {
    instances_distribution = {
      on_demand_allocation_strategy            = null
      on_demand_base_capacity                  = null
      spot_allocation_strategy                 = null
      spot_instance_pools                      = null
      spot_max_price                           = null
      on_demand_percentage_above_base_capacity = 20
    }
    override = [{
      instance_type     = var.ec2_instance_type
      weighted_capacity = null
    }]
  }

Expected Behavior

It should be possible to set it like this

  mixed_instances_policy = {
    instances_distribution = {
      on_demand_percentage_above_base_capacity = 20
    }
    override = [{
      instance_type     = var.ec2_instance_type
    }]
  }

Should be possible with TF starting 0.14 https://www.terraform.io/docs/language/expressions/type-constraints.html

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: Linux
Version 0.28.1

Add aws_autoscaling_group arguments - desired_capacity, max_instance_lifetime

Describe the Bug

Module terraform-aws-ec2-autoscale-group resource aws_autoscaling_group does not support
below arguments.

Expected Behavior

Module terraform-aws-ec2-autoscale-group resource aws_autoscaling_group should support below arguments via variables desired_capacity and max_instance_lifetime respectively.

I will be happy to submit a PR to support mentioned arguments unless they are left out intentionally.

The variable `instance_initiated_shutdown_behavior` not allowed in the Launch Template when used for an EC2 Auto Scaling group

Describe the Bug

What

The variable instance_initiated_shutdown_behavior should be set to null as it's also not allowed in the Launch Template when used for an EC2 Auto Scaling group

References

#117

Expected Behavior

Probably we need to remove instance_initiated_shutdown_behavior

Steps to Reproduce

Screenshots

No response

Environment

No response

Additional Context

No response

use the cleaner Terraform 0.12 syntax

IOPS is not currently working with EBS block mapping

Found a bug? Maybe our Slack Community can help.

Describe the Bug

    {
      device_name  = "/dev/sda1"
      no_device    = "false"
      virtual_name = "root"
      ebs = {
        encrypted             = true
        volume_size           = 200
        delete_on_termination = true
        iops                  = null
        kms_key_id            = null
        snapshot_id           = null
        volume_type           = "standard"
      }
    }
  ]

When you run this, you get a

│ Error: creating Auto Scaling Group (moomoo-20220804165621917300000002): ValidationError: You must use a valid fully-formed launch template. The parameter iops is not supported for standard volumes.
│ 	status code: 400, request id: 529d3cad-0c92-4cbc-9d8e-a34d8e864ba8
│
│   with aws_autoscaling_group.default[0],
│   on main.tf line 143, in resource "aws_autoscaling_group" "default":
│  143: resource "aws_autoscaling_group" "default" {
│

Expected Behavior

I dont know if this is supported with gp2 as well, as when i swap out "standard" for "gp2" and set iops to null, I still get the same error. If I omit the IOPS flag, this module says it is required.

iam_instance_profile_name tends to always update when doing a terraform apply

Found a bug? Maybe our Slack Community can help.

Describe the Bug

When iam_instance_profile_name is set to an empty variable. The terraform apply always results in new changes to be applied.

Expected Behavior

If the iam_instance_profile_name is set to empty it should not result in any new terraform changes.

Steps to Reproduce

Steps to reproduce the behavior:

Specify empty iam_instance_profile_name as {}
Do a terraform apply

Screenshots

  ~ resource "aws_launch_template" "default" {
        id                                   = "xxx-sd"
      ~ latest_version                       = 2 -> (known after apply)
        name                                 = "test"
        tags                                 = {
            "Environment" = "us-west-2"
            "Name"        = "test"
            "Namespace"   = "test"
        }

      + iam_instance_profile {} <--
    }

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: [e.g. Linux, OSX, WSL, etc]
Version [e.g. 10.15]

Additional Context

Add any other context about the problem here.

Add option to create ECS cluster with ASG

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Describe the Feature

I'll be using this module to create an ASG where the instances will be joining an ECS cluster.
It would be nice to have the ability to create a cluster within this module, and if that option is used, then to add to the user_data and join the ECS cluster from there

Expected Behavior

A flag var.create_ecs_cluster which will then also create an ECS cluster with the same naming as the ASG, and will also add lines to the user_data of the instances in this ASG that joins them to the ECS cluster.

Alternatives Considered

I can wrap this module with a parent module that adds the resource for ECS cluster and adds to the user_data.
I can use a separate module which just creates the single resource ECS cluster.

Additional Context

I am using Terragrunt so my infrastructure is based on modules, it is somewhat painful to create single resources in my architecture pattern. That's why ideally it could be done in this module.

Missing `throughput` in block_device_mappings.

Found a bug? Maybe our Slack Community can help.

Describe the Bug

Missing throughput in block_device_mappings. https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#throughput

Expected Behavior

A clear and concise description of what you expected to happen.

Steps to Reproduce

Steps to reproduce the behavior:

Go to '...'
Run '....'
Enter '....'
See error

Screenshots

If applicable, add screenshots or logs to help explain your problem.

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: [e.g. Linux, OSX, WSL, etc]
Version [e.g. 10.15]

Additional Context

Add any other context about the problem here.

Deprecated `tags` attribute on aws v4 provider

Describe the Bug

Use of deprecated tags attribute on the aws_autoscaling_group.default resource.

│ Warning: Argument is deprecated
│ 
│   with module.consul_server_fleet.aws_autoscaling_group.default,
│   on .terraform/modules/server_fleet/main.tf line 244, in resource "aws_autoscaling_group" "default":
│  244:   tags = flatten([
│  245:     for key in keys(module.this.tags) :
│  246:     {
│  247:       key                 = key
│  248:       value               = module.this.tags[key]
│  249:       propagate_at_launch = true
│  250:     }
│  251:   ])
│ 
│ Use tag instead

Expected Behavior

Code should be adjusted to the new provider version.

Environment:

Anything that will help us triage the bug will help. Here are some ideas:

$ uname -a: Linux 5.15.23-2-lts #1 SMP Tue, 15 Feb 2022 12:04:53 +0000 x86_64 GNU/Linux
Version: 0.30.0
AWS provider: 4.2.0

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group#tag

Remove deprecated output tags - alter to tag

The resource aws_autoscaling_group can have either a tags or tag value set.

tags is deprecated.

output.tf is currently outputing tags and it produces this error:

PR has been raised for this:

#105

Use non deprecated tag keys PR causes bug

Found a bug? Maybe our Slack Community can help.

Describe the Bug

Existing ASG with tags have this error The argument "tag.4.value" is required, but no definition was found. after upgrading to version 0.31.1. Can only do terraform apply if tags are removed.
(Changes from this PR #95)

Expected Behavior

Expected existing resources to have no change when upgrading from 0.31.0 to 0.31.1

Steps to Reproduce

Steps to reproduce the behavior:

Create ASG resources from module cloudposse/ec2-autoscale-group/aws version 0.31.0
Updating module version to 0.31.1
Run terraform plan
See error

Error: Missing required argument
│ 
│   with module.go_translate.module.autoscale_group.aws_autoscaling_group.default[0],
│   on .terraform/modules/go_translate.autoscale_group/main.tf line 144, in resource "aws_autoscaling_group" "default":
│  144: resource "aws_autoscaling_group" "default" {
│ 
│ The argument "tag.4.value" is required, but no definition was found.
╵

Anything that will help us triage the bug will help. Here are some ideas:

OS: [e.g. Linux, OSX, WSL, etc] OSX
Version [e.g. 10.15] 12.2

desired_capacity should be optional

Found a bug? Maybe our Slack Community can help.

Describe the Bug

When the automatic scaling increases the number of instances and we execute the code from desired_capacity, the number of instances will be set according to the value of desired_capacity, ignoring the current alarm state. If we do not specify desired_capacity, it will be set to the minimum value anyway.

Expected Behavior

When the current number of instances is 2 and we execute the code without desired_capacity , 2 instances will still work.

Steps to Reproduce

Steps to reproduce the behavior:

Setup ASG with alarm
Trigger allarb (now asg should have 2 insatnce)
Apply changes (example change ami)
See error

Screenshots

If applicable, add screenshots or logs to help explain your problem.

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: linux
Version 0.22.0

Additional Context

https://github.com/cloudposse/terraform-aws-ec2-autoscale-group/blob/master/main.tf#L141

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group#desired_capacity

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group#waiting-for-capacity

Initial Implementation

My general thoughts are that it should include the following resources:

launch config
autoscaling group
security group
dns record
iam instance profile
iam role
elb (w/ variable for enabled)
eip (w/ variable for enabled)

Variables:

min/max size
enabled
volume size
vpc id
user data script var (this would need to be a path using ${path.module} syntax in local module)
elb enabled/disabled
eip enabled/disabled
dns zone id
security groups

Provide desired_capacity for asg

Would be nice to set a min and max but also set a desired_capacity in between.

https://www.terraform.io/docs/providers/aws/r/autoscaling_group.html#desired_capacity

Provide launch template and asg name instead of prefix

It would be nice if we can provide a launch template name using the name argument instead of just the name_prefix.

https://www.terraform.io/docs/providers/aws/r/launch_template.html#name

Instance refresh missing properties (scale_in_protected_instances and standby_instances)

Describe the Bug

There is no current way to configure scale_in_protected_instances and standby_instances behavior from the instance_refresh stanza.

Expected Behavior

When setting scale_in_protected_instances and standby_instances values in the instance refresh properties this should change the value applied at the end to this properties.

Steps to Reproduce

Add scale_in_protected_instances and standby_instances values different than Ignore to the instance refresh stanza. This will not modified the desire outcome.

Screenshots

No response

Environment

No response

Additional Context

No response

launch_template_version $Latest does not trigger instance refresh when user-data or launch_tempate is updated.

Describe the Bug

launch_template_version $Latest does not trigger instance refresh when user-data or launch_tempate is updated.

Expected Behavior

When launch_template is updated , the latest version should be picked up by Autoscaling group and it should trigger instance refresh

Steps to Reproduce

Steps to reproduce the behavior:

Update the user-data or instance type or AMI
run terraform apply
it should show the launchtemplate update
it updates the launch template but, does not trigger instance refresh

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: Amazon Linux2

Add Example Usage

what

Add example invocation

why

We need this so we can soon enable automated continuous integration testing of module

Support for `instance_requrirements` in launch_template to create EC2 instances

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Describe the Feature (Use Case)

I would like to fire EC2 instances based on instance requirements rather than having to specify a given instance type. For example, I want a bare minimum of 4 vCPU with 16 GiBs of RAM across my EC2 instance fleet.

Expected Behavior

I don't mind if we implemented it in a non-backwards compatible way. Although, I believe it's doable. THe instance_requirements variable would clash if configured alongside the instance_type

Describe Ideal Solution

The TF provider has support for all of these elements:

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#instance-requirements

In fact, the OSS Terraform-modules equivalent leverages a similar approach

https://github.com/terraform-aws-modules/terraform-aws-autoscaling/blob/master/main.tf#L160

Alternatives Considered

Stop using this module to create ASGs and rely on other partners or a self-baked one.

Additional Context

N/A

Support for lifecycle hooks

Describe the Feature

I'd like to be able to use https://github.com/meltwater/terraform-aws-asg-dns-handler and this requires being able to specify lifecycle hooks to the autoscale group.

Expected Behavior

I can add this module, define the hooks, and generate hostnames for my autoscale groups.

Use Case

I need hostnames or predictable networking for my autoscale groups.

Describe Ideal Solution

I can add a few lines to my main.tf and this will work.

Alternatives Considered

I've been experimenting with this all yesterday and haven't gotten anything working.

Additional Context

Recipe I'm working on is here: https://github.com/converged-computing/flux-terraform-ami/pull/1/files#diff-6e45d26e502f88302f69c4c196babd8939186d9cd298f94caca283c128a2d186

block_device_mappings doesn't function as expected

The type definition in the variables.tf file seems to stop you being able to use simple setups

  block_device_mappings = [
    {
      device_name = "/dev/sda1"
      no_device    = false
      virtual_name = "root"
      ebs = {
        delete_on_termination = true
        volume_size           = 22
      }
    }
  ]

Fails with

Error: Invalid value for module argument

  on main.tf line 133, in module "autoscale_group":
 133:   block_device_mappings = [
 134:     {
 135:       device_name = "/dev/sda1"
 136:       no_device    = false
 137:       virtual_name = "root"
 138:       ebs = {
 139:         delete_on_termination = true
 140:         volume_size           = 22
 141:       }
 142:     }
 143:   ]

The given value is not suitable for child module variable
"block_device_mappings" defined at
.terraform/modules/autoscale_group/variables.tf:108,1-33: element 0: attribute
"ebs": attributes "encrypted", "iops", "kms_key_id", "snapshot_id", and
"volume_type" are required.

Which was after adding

      no_device    = false
      virtual_name = "root"

as it wouldnt work without those either.

Removing the type restrictions from the vars allows it to work as expected

  type = list(object({
    device_name  = string
    no_device    = bool
    virtual_name = string
    ebs = object({
      delete_on_termination = bool
      encrypted             = bool
      iops                  = number
      kms_key_id            = string
      snapshot_id           = string
      volume_size           = number
      volume_type           = string
    })
  }))

launch_template_version is not being used

launch_template_version is not being used anywhere

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update terraform cloudposse/dynamic-subnets/aws to v2.4.2

Detected dependencies

terraform

examples/complete/main.tf

cloudposse/dynamic-subnets/aws 2.4.1

cloudposse/vpc/aws 2.2.0

examples/complete/versions.tf

aws >= 4.0

hashicorp/terraform >= 1.0

versions.tf

aws >= 5.16

hashicorp/terraform >= 1.3

Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.