Skip to content

Commit 2c877b0

Browse files
author
Premdeep Saini
committed
docs: add resources used in the module
1 parent b7920e8 commit 2c877b0

File tree

1 file changed

+54
-37
lines changed

1 file changed

+54
-37
lines changed

‎README.md

Lines changed: 54 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -106,48 +106,65 @@ This is needed if you plan to use capacity provider strategy for ECS service.
106106
`asg` and `launch_config` are required for the capacity provider.
107107

108108

109-
### Requirements
109+
## Requirements
110110

111-
| Name | Version |
112-
|----------- |---------- |
113-
| terraform | \>= 1.2.0 |
111+
| Name | Version |
112+
|------|---------|
113+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | \>= 1.2.0 |
114+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.16 |
115+
| <a name="requirement_cloudinit"></a> [cloudinit](#requirement\_cloudinit) | \>=2.2.0 |
114116

115-
### Providers
116-
| Name | Version |
117-
|----------- |--------- |
118-
| aws | ~> 4.16 |
119-
| cloudinit | \>=2.2.0 |
117+
## Providers
118+
119+
| Name | Version |
120+
|------|---------|
121+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.16 |
122+
123+
## Modules
124+
125+
No modules.
126+
127+
## Resources
128+
129+
| Name | Type |
130+
|------|------|
131+
| [aws_autoscaling_group.ecs_cluster_asg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group) | resource |
132+
| [aws_ecs_capacity_provider.capacity_providers](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_capacity_provider) | resource |
133+
| [aws_ecs_cluster.ecs_cluster](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_cluster) | resource |
134+
| [aws_ecs_cluster_capacity_providers.ecs_cluster_capacity_provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_cluster_capacity_providers) | resource |
135+
| [aws_launch_configuration.ecs_launch_config](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_configuration) | resource |
120136

121137
### Inputs
122138

123-
| Name | Description |
124-
|--------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------- |
125-
| environment | The cluster deployment environment. environment is added as prefix to the resources generated by this module. |
126-
| cluster_name | Name of ECS cluster. environment is not added to the cluster name. |
127-
| capacity_providers | List of capacity provider configuration. |
128-
| capacity_providers.name | Capacity provider name. This is used by the module to link auto-scaling group, launch configuration and capacity provider. |
129-
| capacity_providers.target_capacity | Target utilisation for the capacity provider. A value between 1 and 100. |
130-
| capacity_providers.managed_scaling_status | Whether auto-scaling is managed by ECS. Valid values are `ENABLED` and `DISABLED`. |
131-
| capacity_providers.managed_termination_protection | Manage container-aware termination of instances in the auto scaling group when scale-in happens. Valid values are `ENABLED` and `DISABLED`. |
132-
| asg | List of auto-scaling group configuration. |
133-
| asg.name | Name of auto-scaling group. |
134-
| asg.vpc_zone_identifier | List of subnet Ids to launch resources in. |
135-
| asg.health_check_type | Controls how health check is done. Valid values are `EC2` and `ELB`. |
136-
| asg.health_check_grace_period | Time in seconds after instance comes up and health check first kicks in. |
137-
| asg.max_size | The maximum capacity auto-scaling group can scale-out to. |
138-
| asg.min_size | The minimum capacity auto-scaling group can scale-in to. |
139-
| asg.protect_from_scale_in | Indicates whether newly launched instances are automatically protected from termination by auto-scaling group when scaling in. |
140-
| asg.additional_tags | List of additional tags. |
141-
| asg.additional_tags.key | Key of the tag. |
142-
| asg.additional_tags.value | Value of the tag. |
143-
| asg.additional_tags.propagate_at_launch | Indicates whether to propagate the tag to the newly launched EC2 instances. |
144-
| launch_configs | List of launch configurations for auto-scaling groups. |
145-
| launch_configs.name | Name of the launch configuration. Should be same as corresponding auto-scaling group name. |
146-
| launch_configs.image_id | AMI Id of the image to use. |
147-
| launch_configs.instance_type | The type of EC2 instance to use. Eg: t3.small |
148-
| launch_configs.user_data_base64 | Base64 encoded userdata. |
149-
| launch_configs.iam_instance_profile_name | Name of the IAM instance profile to attach to the EC2 instance. |
150-
| launch_configs.security_group_ids | List of security group ids to attach to the EC2 instance. | |
139+
| Name | Description | Type | Default | Required |
140+
|--------------------------------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------- |---------------- |--------- |---------- |
141+
| environment | The cluster deployment environment. environment is added as prefix to the resources generated by this module. | `string` | n/a | yes |
142+
| cluster_name | Name of ECS cluster. environment is not added to the cluster name. | `string` | n/a | yes |
143+
| capacity_providers | List of capacity provider configuration. | `list(object)` | n/a | yes |
144+
| capacity_providers.name | Capacity provider name. This is used by the module to link auto-scaling group, launch configuration and capacity provider. | `string` | n/a | yes |
145+
| capacity_providers.target_capacity | Target utilisation for the capacity provider. A value between 1 and 100. | `number` | n/a | yes |
146+
| capacity_providers.managed_scaling_status | Whether auto-scaling is managed by ECS. Valid values are `ENABLED` and `DISABLED`. | `string` | n/a | yes |
147+
| capacity_providers.managed_termination_protection | Manage container-aware termination of instances in the auto scaling group when scale-in happens. Valid values are `ENABLED` and `DISABLED`. | `string` | n/a | yes |
148+
| asg | List of auto-scaling group configuration. | `list(object)` | n/a | yes |
149+
| asg.name | Name of auto-scaling group. | `string` | n/a | yes |
150+
| asg.vpc_zone_identifier | List of subnet Ids to launch resources in. | `list(string)` | n/a | yes |
151+
| asg.health_check_type | Controls how health check is done. Valid values are `EC2` and `ELB`. | `string` | n/a | yes |
152+
| asg.health_check_grace_period | Time in seconds after instance comes up and health check first kicks in. | `number` | n/a | yes |
153+
| asg.max_size | The maximum capacity auto-scaling group can scale-out to. | `number` | n/a | yes |
154+
| asg.min_size | The minimum capacity auto-scaling group can scale-in to. | `number` | n/a | yes |
155+
| asg.protect_from_scale_in | Indicates whether newly launched instances are automatically protected from termination by auto-scaling group when scaling in. | `bool` | n/a | yes |
156+
| asg.additional_tags | List of additional tags. | `list(object)` | n/a | yes |
157+
| asg.additional_tags.key | Key of the tag. | `string` | n/a | yes |
158+
| asg.additional_tags.value | Value of the tag. | `string` | n/a | yes |
159+
| asg.additional_tags.propagate_at_launch | Indicates whether to propagate the tag to the newly launched EC2 instances. | `bool` | n/a | yes |
160+
| launch_configs | List of launch configurations for auto-scaling groups. | `list(object)` | n/a | yes |
161+
| launch_configs.name | Name of the launch configuration. Should be same as corresponding auto-scaling group name. | `string` | n/a | yes |
162+
| launch_configs.image_id | AMI Id of the image to use. | `string` | n/a | yes |
163+
| launch_configs.instance_type | The type of EC2 instance to use. Eg: t3.small | `string` | n/a | yes |
164+
| launch_configs.user_data_base64 | Base64 encoded userdata. | `string` | n/a | yes |
165+
| launch_configs.iam_instance_profile_name | Name of the IAM instance profile to attach to the EC2 instance. | `string` | n/a | yes |
166+
| launch_configs.security_group_ids | List of security group ids to attach to the EC2 instance. | `list(string)` | n/a | yes |
167+
151168

152169
### Outputs
153170
No outputs.

0 commit comments

Comments
 (0)