Skip to content

Commit 8c5eed8

Browse files
authored
chore: update documentation based on latest terraform-docs which includes module and resource sections (#33)
1 parent 1079f89 commit 8c5eed8

File tree

4 files changed

+60
-8
lines changed

4 files changed

+60
-8
lines changed

.gitignore

+28-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
1-
.terraform
2-
terraform.tfstate
3-
*.tfstate*
4-
terraform.tfvars
1+
# Local .terraform directories
2+
**/.terraform/*
3+
4+
# Terraform lockfile
55
.terraform.lock.hcl
6+
7+
# .tfstate files
8+
*.tfstate
9+
*.tfstate.*
10+
11+
# Crash log files
12+
crash.log
13+
14+
# Exclude all .tfvars files, which are likely to contain sentitive data, such as
15+
# password, private keys, and other secrets. These should not be part of version
16+
# control as they are data points which are potentially sensitive and subject
17+
# to change depending on the environment.
18+
*.tfvars
19+
20+
# Ignore override files as they are usually used to override resources locally and so
21+
# are not checked in
22+
override.tf
23+
override.tf.json
24+
*_override.tf
25+
*_override.tf.json
26+
27+
# Ignore CLI configuration files
28+
.terraformrc
29+
terraform.rc

.pre-commit-config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.44.0
3+
rev: v1.46.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate
@@ -21,6 +21,6 @@ repos:
2121
- '--args=--only=terraform_standard_module_structure'
2222
- '--args=--only=terraform_workspace_remote'
2323
- repo: git://github.com/pre-commit/pre-commit-hooks
24-
rev: v3.3.0
24+
rev: v3.4.0
2525
hooks:
2626
- id: check-merge-conflict

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,16 @@ module "ecs" {
7272
|------|---------|
7373
| aws | >= 2.48 |
7474

75+
## Modules
76+
77+
No Modules.
78+
79+
## Resources
80+
81+
| Name |
82+
|------|
83+
| [aws_ecs_cluster](https://registry.terraform.io/providers/hashicorp/aws/2.48/docs/resources/ecs_cluster) |
84+
7585
## Inputs
7686

7787
| Name | Description | Type | Default | Required |
@@ -90,7 +100,6 @@ module "ecs" {
90100
| this\_ecs\_cluster\_arn | ARN of the ECS Cluster |
91101
| this\_ecs\_cluster\_id | ID of the ECS Cluster |
92102
| this\_ecs\_cluster\_name | The name of the ECS cluster |
93-
94103
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
95104

96105
## Authors

examples/complete-ecs/README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,31 @@ Current version creates an high-available VPC with instances that are attached t
5454
| aws | >= 2.48 |
5555
| template | >= 2.0 |
5656

57+
## Modules
58+
59+
| Name | Source | Version |
60+
|------|--------|---------|
61+
| asg | terraform-aws-modules/autoscaling/aws | ~> 3.0 |
62+
| disabled_ecs | ../../ | |
63+
| ec2_profile | ../../modules/ecs-instance-profile | |
64+
| ecs | ../../ | |
65+
| hello_world | ./service-hello-world | |
66+
| vpc | terraform-aws-modules/vpc/aws | ~> 2.0 |
67+
68+
## Resources
69+
70+
| Name |
71+
|------|
72+
| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/2.48/docs/data-sources/ami) |
73+
| [aws_availability_zones](https://registry.terraform.io/providers/hashicorp/aws/2.48/docs/data-sources/availability_zones) |
74+
| [aws_ecs_capacity_provider](https://registry.terraform.io/providers/hashicorp/aws/2.48/docs/resources/ecs_capacity_provider) |
75+
| [template_file](https://registry.terraform.io/providers/hashicorp/template/2.0/docs/data-sources/file) |
76+
5777
## Inputs
5878

5979
No input.
6080

6181
## Outputs
6282

6383
No output.
64-
6584
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)