Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Automated Preview][terraform-aws-service-catalog] [WIP] SME-548: Tailscale Module to Support Exit Node Configuration #2298

Closed
wants to merge 2 commits into from
Closed

[Automated Preview][terraform-aws-service-catalog] [WIP] SME-548: Tailscale Module to Support Exit Node Configuration #2298

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3ee84e
Updated with the [latest changes](https://github.com/gruntwork-io/ter…
docs-sourcer[bot] Jan 7, 2025
0a35a9d
Updated with the [latest changes](https://github.com/gruntwork-io/ter…
docs-sourcer[bot] Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 40 additions & 89 deletions docs/reference/services/app-orchestration/amazon-ecs-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,6 @@ module "ecs_cluster" {
# ECS instances.
allow_ssh_from_security_group_ids = []

# Enables or disables a graceful shutdown of instances without disturbing
# workloads.
autoscaling_managed_draining = true

# Protect EC2 instances running ECS tasks from being terminated due to scale
# in (spot instances do not support lifecycle modifications). Note that the
# behavior of termination protection differs between clusters with capacity
Expand Down Expand Up @@ -275,18 +271,10 @@ module "ecs_cluster" {
# Whether to associate a public IP address with an instance in a VPC
cluster_instance_associate_public_ip_address = false

# Whether the volume should be destroyed on instance termination. Defaults to
# false
cluster_instance_ebs_delete_on_termination = false

# The name of the Key Pair that can be used to SSH to each instance in the ECS
# cluster
cluster_instance_keypair_name = null

# The volume type for the root volume for each of the ECS Cluster's EC2
# Instances. Can be one of standard, gp2, gp3, io1, io2, sc1 or st1.
cluster_instance_root_volume_type = "gp2"

# A list of custom tags to apply to the EC2 Instances in this ASG. Each item
# in this list should be a map with the parameters key, value, and
# propagate_at_launch.
Expand Down Expand Up @@ -364,9 +352,14 @@ module "ecs_cluster" {
# this threshold. Only used if var.enable_ecs_cloudwatch_alarms is set to true
high_cpu_utilization_threshold = 90

# Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Must
# be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
high_cpu_utilization_treat_missing_data = "missing"
# The period, in seconds, over which to measure the disk utilization
# percentage. Only used if var.enable_ecs_cloudwatch_alarms is set to true
high_disk_utilization_period = 300

# Trigger an alarm if the EC2 instances in the ECS Cluster have a disk
# utilization percentage above this threshold. Only used if
# var.enable_ecs_cloudwatch_alarms is set to true
high_disk_utilization_threshold = 90

# The number of periods over which data is compared to the specified threshold
high_memory_utilization_evaluation_periods = 2
Expand All @@ -384,10 +377,6 @@ module "ecs_cluster" {
# to true
high_memory_utilization_threshold = 90

# Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Must
# be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
high_memory_utilization_treat_missing_data = "missing"

# The desired HTTP PUT response hop limit for instance metadata requests for
# the workers.
http_put_response_hop_limit = null
Expand Down Expand Up @@ -423,10 +412,10 @@ module "ecs_cluster" {
tenancy = "default"

# Set this variable to true to enable the use of Instance Metadata Service
# Version 1 in this module's aws_launch_template. Note that while IMDsv2 is
# preferred due to its special security hardening, we allow this in order to
# support the use case of AMIs built outside of these modules that depend on
# IMDSv1.
# Version 1 in this module's aws_launch_configuration. Note that while IMDsv2
# is preferred due to its special security hardening, we allow this in order
# to support the use case of AMIs built outside of these modules that depend
# on IMDSv1.
use_imdsv1 = true

# When true, all IAM policies will be managed as dedicated policies rather
Expand Down Expand Up @@ -512,10 +501,6 @@ inputs = {
# ECS instances.
allow_ssh_from_security_group_ids = []

# Enables or disables a graceful shutdown of instances without disturbing
# workloads.
autoscaling_managed_draining = true

# Protect EC2 instances running ECS tasks from being terminated due to scale
# in (spot instances do not support lifecycle modifications). Note that the
# behavior of termination protection differs between clusters with capacity
Expand Down Expand Up @@ -576,18 +561,10 @@ inputs = {
# Whether to associate a public IP address with an instance in a VPC
cluster_instance_associate_public_ip_address = false

# Whether the volume should be destroyed on instance termination. Defaults to
# false
cluster_instance_ebs_delete_on_termination = false

# The name of the Key Pair that can be used to SSH to each instance in the ECS
# cluster
cluster_instance_keypair_name = null

# The volume type for the root volume for each of the ECS Cluster's EC2
# Instances. Can be one of standard, gp2, gp3, io1, io2, sc1 or st1.
cluster_instance_root_volume_type = "gp2"

# A list of custom tags to apply to the EC2 Instances in this ASG. Each item
# in this list should be a map with the parameters key, value, and
# propagate_at_launch.
Expand Down Expand Up @@ -665,9 +642,14 @@ inputs = {
# this threshold. Only used if var.enable_ecs_cloudwatch_alarms is set to true
high_cpu_utilization_threshold = 90

# Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Must
# be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
high_cpu_utilization_treat_missing_data = "missing"
# The period, in seconds, over which to measure the disk utilization
# percentage. Only used if var.enable_ecs_cloudwatch_alarms is set to true
high_disk_utilization_period = 300

# Trigger an alarm if the EC2 instances in the ECS Cluster have a disk
# utilization percentage above this threshold. Only used if
# var.enable_ecs_cloudwatch_alarms is set to true
high_disk_utilization_threshold = 90

# The number of periods over which data is compared to the specified threshold
high_memory_utilization_evaluation_periods = 2
Expand All @@ -685,10 +667,6 @@ inputs = {
# to true
high_memory_utilization_threshold = 90

# Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Must
# be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
high_memory_utilization_treat_missing_data = "missing"

# The desired HTTP PUT response hop limit for instance metadata requests for
# the workers.
http_put_response_hop_limit = null
Expand Down Expand Up @@ -724,10 +702,10 @@ inputs = {
tenancy = "default"

# Set this variable to true to enable the use of Instance Metadata Service
# Version 1 in this module's aws_launch_template. Note that while IMDsv2 is
# preferred due to its special security hardening, we allow this in order to
# support the use case of AMIs built outside of these modules that depend on
# IMDSv1.
# Version 1 in this module's aws_launch_configuration. Note that while IMDsv2
# is preferred due to its special security hardening, we allow this in order
# to support the use case of AMIs built outside of these modules that depend
# on IMDSv1.
use_imdsv1 = true

# When true, all IAM policies will be managed as dedicated policies rather
Expand Down Expand Up @@ -880,15 +858,6 @@ The IDs of security groups from which to allow incoming SSH requests to the ECS
<HclListItemDefaultValue defaultValue="[]"/>
</HclListItem>

<HclListItem name="autoscaling_managed_draining" requirement="optional" type="bool">
<HclListItemDescription>

Enables or disables a graceful shutdown of instances without disturbing workloads.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="true"/>
</HclListItem>

<HclListItem name="autoscaling_termination_protection" requirement="optional" type="bool">
<HclListItemDescription>

Expand Down Expand Up @@ -1015,15 +984,6 @@ Whether to associate a public IP address with an instance in a VPC
<HclListItemDefaultValue defaultValue="false"/>
</HclListItem>

<HclListItem name="cluster_instance_ebs_delete_on_termination" requirement="optional" type="bool">
<HclListItemDescription>

Whether the volume should be destroyed on instance termination. Defaults to false

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="false"/>
</HclListItem>

<HclListItem name="cluster_instance_keypair_name" requirement="optional" type="string">
<HclListItemDescription>

Expand All @@ -1033,15 +993,6 @@ The name of the Key Pair that can be used to SSH to each instance in the ECS clu
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="cluster_instance_root_volume_type" requirement="optional" type="string">
<HclListItemDescription>

The volume type for the root volume for each of the ECS Cluster's EC2 Instances. Can be one of standard, gp2, gp3, io1, io2, sc1 or st1.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="&quot;gp2&quot;"/>
</HclListItem>

<HclListItem name="custom_tags_ec2_instances" requirement="optional" type="list">
<HclListItemDescription>

Expand Down Expand Up @@ -1211,13 +1162,22 @@ Trigger an alarm if the ECS Cluster has a CPU utilization percentage above this
<HclListItemDefaultValue defaultValue="90"/>
</HclListItem>

<HclListItem name="high_cpu_utilization_treat_missing_data" requirement="optional" type="string">
<HclListItem name="high_disk_utilization_period" requirement="optional" type="number">
<HclListItemDescription>

Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Must be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
The period, in seconds, over which to measure the disk utilization percentage. Only used if <a href="#enable_ecs_cloudwatch_alarms"><code>enable_ecs_cloudwatch_alarms</code></a> is set to true

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="&quot;missing&quot;"/>
<HclListItemDefaultValue defaultValue="300"/>
</HclListItem>

<HclListItem name="high_disk_utilization_threshold" requirement="optional" type="number">
<HclListItemDescription>

Trigger an alarm if the EC2 instances in the ECS Cluster have a disk utilization percentage above this threshold. Only used if <a href="#enable_ecs_cloudwatch_alarms"><code>enable_ecs_cloudwatch_alarms</code></a> is set to true

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="90"/>
</HclListItem>

<HclListItem name="high_memory_utilization_evaluation_periods" requirement="optional" type="number">
Expand Down Expand Up @@ -1256,15 +1216,6 @@ Trigger an alarm if the ECS Cluster has a memory utilization percentage above th
<HclListItemDefaultValue defaultValue="90"/>
</HclListItem>

<HclListItem name="high_memory_utilization_treat_missing_data" requirement="optional" type="string">
<HclListItemDescription>

Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Must be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="&quot;missing&quot;"/>
</HclListItem>

<HclListItem name="http_put_response_hop_limit" requirement="optional" type="number">
<HclListItemDescription>

Expand Down Expand Up @@ -1340,7 +1291,7 @@ The tenancy of this server. Must be one of: default, dedicated, or host.
<HclListItem name="use_imdsv1" requirement="optional" type="bool">
<HclListItemDescription>

Set this variable to true to enable the use of Instance Metadata Service Version 1 in this module's aws_launch_template. Note that while IMDsv2 is preferred due to its special security hardening, we allow this in order to support the use case of AMIs built outside of these modules that depend on IMDSv1.
Set this variable to true to enable the use of Instance Metadata Service Version 1 in this module's aws_launch_configuration. Note that while IMDsv2 is preferred due to its special security hardening, we allow this in order to support the use case of AMIs built outside of these modules that depend on IMDSv1.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="true"/>
Expand Down Expand Up @@ -1398,10 +1349,10 @@ For configurations with multiple capacity providers, this contains a list of all
</HclListItemDescription>
</HclListItem>

<HclListItem name="ecs_cluster_launch_template_id">
<HclListItem name="ecs_cluster_launch_configuration_id">
<HclListItemDescription>

The ID of the launch template used by the ECS cluster's auto scaling group (ASG)
The ID of the launch configuration used by the ECS cluster's auto scaling group (ASG)

</HclListItemDescription>
</HclListItem>
Expand Down Expand Up @@ -1489,6 +1440,6 @@ The CloudWatch Dashboard metric widget for the ECS cluster workers' Memory utili
"https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v0.118.6/modules/services/ecs-cluster/outputs.tf"
],
"sourcePlugin": "service-catalog-api",
"hash": "af9d25811f9eba31131d366fbf0b0595"
"hash": "fd7b4b0c50c7cd7dddb2c233ca2a816d"
}
##DOCS-SOURCER-END -->
Loading