Skip to content

Commit 8c7c218

Browse files
terraform-docs: automated action
1 parent 35632b0 commit 8c7c218

File tree

1 file changed

+69
-1
lines changed

1 file changed

+69
-1
lines changed

examples/complete/README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,56 @@ Configuration in this directory creates:
66
- ECS Cluster using self-managed EC2
77
- Autoscaling Group with self-managed EC2 for the created ECS Cluster
88

9+
## Example tfvars file
10+
11+
```text
12+
cluster_name = "cluster"
13+
cluster_setting = [
14+
{
15+
name = "containerInsights"
16+
value = "enabled"
17+
}
18+
]
19+
cluster_tags = {
20+
Project = "project"
21+
}
22+
23+
# Autoscaling Group Variables
24+
asg_name = "my-asg"
25+
asg_vpc_zone_identifier = ["subnet-1341324123", "subnet-13241234123"]
26+
asg_desired_capacity = 2
27+
asg_min_size = 1
28+
asg_max_size = 3
29+
asg_instances_tags = {
30+
Name = "instance"
31+
}
32+
asg_tags = {
33+
Project = "project"
34+
}
35+
36+
# Launch Template Variables
37+
asg_create_launch_template = true
38+
asg_launch_template = {
39+
image_id = "ami-068e0f1a600cd311c"
40+
instance_type = "t2.micro"
41+
key_name = "<actual-key-name>"
42+
security_group_ids = []
43+
}
44+
asg_launch_template_version = "<actual-version>"
45+
46+
# IAM Role Variables
47+
asg_iam_role_name = "asg-role"
48+
asg_iam_role_tags = {
49+
Project = "project"
50+
}
51+
52+
# IAM Instance Profile Variables
53+
asg_iam_instance_profile_name = "asg-instance-profile"
54+
asg_iam_instance_profile_tags = {
55+
Project = "project"
56+
}
57+
```
58+
959
## Usage
1060

1161
To run this example, you will need to execute the commands:
@@ -41,7 +91,25 @@ No resources.
4191

4292
## Inputs
4393

44-
No inputs.
94+
| Name | Description | Type | Default | Required |
95+
|------|-------------|------|---------|:--------:|
96+
| <a name="input_asg_create_launch_template"></a> [asg\_create\_launch\_template](#input\_asg\_create\_launch\_template) | Whether to create a launch template. | `bool` | n/a | yes |
97+
| <a name="input_asg_desired_capacity"></a> [asg\_desired\_capacity](#input\_asg\_desired\_capacity) | The number of Amazon EC2 instances that should be running in the Auto Scaling Group. | `number` | n/a | yes |
98+
| <a name="input_asg_iam_instance_profile_name"></a> [asg\_iam\_instance\_profile\_name](#input\_asg\_iam\_instance\_profile\_name) | The name of the IAM instance profile for the Auto Scaling Group. | `string` | n/a | yes |
99+
| <a name="input_asg_iam_instance_profile_tags"></a> [asg\_iam\_instance\_profile\_tags](#input\_asg\_iam\_instance\_profile\_tags) | A map of tags to assign to the IAM instance profile. | `map(string)` | n/a | yes |
100+
| <a name="input_asg_iam_role_name"></a> [asg\_iam\_role\_name](#input\_asg\_iam\_role\_name) | The name of the IAM role for the Auto Scaling Group. | `string` | n/a | yes |
101+
| <a name="input_asg_iam_role_tags"></a> [asg\_iam\_role\_tags](#input\_asg\_iam\_role\_tags) | A map of tags to assign to the IAM role. | `map(string)` | n/a | yes |
102+
| <a name="input_asg_instances_tags"></a> [asg\_instances\_tags](#input\_asg\_instances\_tags) | A map of tags to assign to the instances within the Auto Scaling Group. | `map(string)` | n/a | yes |
103+
| <a name="input_asg_launch_template"></a> [asg\_launch\_template](#input\_asg\_launch\_template) | The configuration of the launch template. | <pre>object({<br> image_id = string<br> instance_type = string<br> key_name = string<br> security_group_ids = list(string)<br> })</pre> | n/a | yes |
104+
| <a name="input_asg_launch_template_version"></a> [asg\_launch\_template\_version](#input\_asg\_launch\_template\_version) | The version of the launch template to use. | `string` | n/a | yes |
105+
| <a name="input_asg_max_size"></a> [asg\_max\_size](#input\_asg\_max\_size) | The maximum size of the Auto Scaling Group. | `number` | n/a | yes |
106+
| <a name="input_asg_min_size"></a> [asg\_min\_size](#input\_asg\_min\_size) | The minimum size of the Auto Scaling Group. | `number` | n/a | yes |
107+
| <a name="input_asg_name"></a> [asg\_name](#input\_asg\_name) | The name of the Auto Scaling Group. | `string` | n/a | yes |
108+
| <a name="input_asg_tags"></a> [asg\_tags](#input\_asg\_tags) | A map of tags to assign to the Auto Scaling Group. | `map(string)` | n/a | yes |
109+
| <a name="input_asg_vpc_zone_identifier"></a> [asg\_vpc\_zone\_identifier](#input\_asg\_vpc\_zone\_identifier) | A list of subnet IDs to launch resources in. | `list(string)` | n/a | yes |
110+
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | The name of the ECS cluster. | `string` | n/a | yes |
111+
| <a name="input_cluster_setting"></a> [cluster\_setting](#input\_cluster\_setting) | The settings to use when creating the cluster. | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | n/a | yes |
112+
| <a name="input_cluster_tags"></a> [cluster\_tags](#input\_cluster\_tags) | A map of tags to assign to the cluster. | `map(string)` | n/a | yes |
45113

46114
## Outputs
47115

0 commit comments

Comments
 (0)