Skip to content

Commit cc8f7d1

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation based on latest terraform-docs which includes module and resource sections (#594)
1 parent 115e736 commit cc8f7d1

File tree

14 files changed

+195
-18
lines changed

14 files changed

+195
-18
lines changed

‎.gitignore

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
1-
.terraform
2-
terraform.tfstate
3-
*.tfstate*
4-
terraform.tfvars
1+
# Local .terraform directories
2+
**/.terraform/*
53

4+
# Terraform lockfile
65
.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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,48 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway
237237
|------|---------|
238238
| aws | >= 3.10 |
239239

240+
## Modules
241+
242+
No Modules.
243+
244+
## Resources
245+
246+
| Name |
247+
|------|
248+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/cloudwatch_log_group) |
249+
| [aws_customer_gateway](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/customer_gateway) |
250+
| [aws_db_subnet_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/db_subnet_group) |
251+
| [aws_default_network_acl](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/default_network_acl) |
252+
| [aws_default_security_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/default_security_group) |
253+
| [aws_default_vpc](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/default_vpc) |
254+
| [aws_egress_only_internet_gateway](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/egress_only_internet_gateway) |
255+
| [aws_eip](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/eip) |
256+
| [aws_elasticache_subnet_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/elasticache_subnet_group) |
257+
| [aws_flow_log](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/flow_log) |
258+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/data-sources/iam_policy_document) |
259+
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/iam_policy) |
260+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/iam_role_policy_attachment) |
261+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/iam_role) |
262+
| [aws_internet_gateway](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/internet_gateway) |
263+
| [aws_nat_gateway](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/nat_gateway) |
264+
| [aws_network_acl_rule](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/network_acl_rule) |
265+
| [aws_network_acl](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/network_acl) |
266+
| [aws_redshift_subnet_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/redshift_subnet_group) |
267+
| [aws_route_table_association](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/route_table_association) |
268+
| [aws_route_table](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/route_table) |
269+
| [aws_route](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/route) |
270+
| [aws_subnet](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/subnet) |
271+
| [aws_vpc_dhcp_options_association](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpc_dhcp_options_association) |
272+
| [aws_vpc_dhcp_options](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpc_dhcp_options) |
273+
| [aws_vpc_endpoint_route_table_association](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpc_endpoint_route_table_association) |
274+
| [aws_vpc_endpoint_service](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/data-sources/vpc_endpoint_service) |
275+
| [aws_vpc_endpoint](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpc_endpoint) |
276+
| [aws_vpc_ipv4_cidr_block_association](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpc_ipv4_cidr_block_association) |
277+
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpc) |
278+
| [aws_vpn_gateway_attachment](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpn_gateway_attachment) |
279+
| [aws_vpn_gateway_route_propagation](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpn_gateway_route_propagation) |
280+
| [aws_vpn_gateway](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/vpn_gateway) |
281+
240282
## Inputs
241283

242284
| Name | Description | Type | Default | Required |
@@ -955,7 +997,6 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway
955997
| vpc\_main\_route\_table\_id | The ID of the main route table associated with this VPC |
956998
| vpc\_owner\_id | The ID of the AWS account that owns the VPC |
957999
| vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
958-
9591000
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
9601001

9611002
## Authors

‎examples/complete-vpc/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,18 @@ Note that this example may create resources which can cost money (AWS Elastic IP
3030
|------|---------|
3131
| aws | >= 3.10 |
3232

33+
## Modules
34+
35+
| Name | Source | Version |
36+
|------|--------|---------|
37+
| vpc | ../../ | |
38+
39+
## Resources
40+
41+
| Name |
42+
|------|
43+
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/data-sources/security_group) |
44+
3345
## Inputs
3446

3547
No input.
@@ -54,5 +66,4 @@ No input.
5466
| vpc\_endpoint\_ssm\_id | The ID of VPC endpoint for SSM |
5567
| vpc\_endpoint\_ssm\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for SSM. |
5668
| vpc\_id | The ID of the VPC |
57-
5869
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/ipv6/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2828
|------|---------|
2929
| aws | >= 3.10 |
3030

31+
## Modules
32+
33+
| Name | Source | Version |
34+
|------|--------|---------|
35+
| vpc | ../.. | |
36+
37+
## Resources
38+
39+
| Name |
40+
|------|
41+
| [aws_availability_zones](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/data-sources/availability_zones) |
42+
3143
## Inputs
3244

3345
No input.
@@ -39,5 +51,4 @@ No input.
3951
| ipv6\_association\_id | The association ID for the IPv6 CIDR block |
4052
| ipv6\_cidr\_block | The IPv6 CIDR block |
4153
| vpc\_id | The ID of the VPC |
42-
4354
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/issue-108-route-already-exists/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
3030

3131
No provider.
3232

33+
## Modules
34+
35+
| Name | Source | Version |
36+
|------|--------|---------|
37+
| vpc | ../../ | |
38+
39+
## Resources
40+
41+
No resources.
42+
3343
## Inputs
3444

3545
No input.
@@ -44,5 +54,4 @@ No input.
4454
| private\_subnets | List of IDs of private subnets |
4555
| public\_subnets | List of IDs of public subnets |
4656
| vpc\_id | The ID of the VPC |
47-
4857
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/issue-44-asymmetric-private-subnets/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2828

2929
No provider.
3030

31+
## Modules
32+
33+
| Name | Source | Version |
34+
|------|--------|---------|
35+
| vpc | ../../ | |
36+
37+
## Resources
38+
39+
No resources.
40+
3141
## Inputs
3242

3343
No input.
@@ -42,5 +52,4 @@ No input.
4252
| private\_subnets | List of IDs of private subnets |
4353
| public\_subnets | List of IDs of public subnets |
4454
| vpc\_id | The ID of the VPC |
45-
4655
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/issue-46-no-private-subnets/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2828

2929
No provider.
3030

31+
## Modules
32+
33+
| Name | Source | Version |
34+
|------|--------|---------|
35+
| vpc | ../../ | |
36+
37+
## Resources
38+
39+
No resources.
40+
3141
## Inputs
3242

3343
No input.
@@ -42,5 +52,4 @@ No input.
4252
| private\_subnets | List of IDs of private subnets |
4353
| public\_subnets | List of IDs of public subnets |
4454
| vpc\_id | The ID of the VPC |
45-
4655
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/manage-default-vpc/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ Run `terraform destroy` when you don't need these resources.
2828

2929
No provider.
3030

31+
## Modules
32+
33+
| Name | Source | Version |
34+
|------|--------|---------|
35+
| vpc | ../../ | |
36+
37+
## Resources
38+
39+
No resources.
40+
3141
## Inputs
3242

3343
No input.
@@ -38,5 +48,4 @@ No input.
3848
|------|-------------|
3949
| default\_vpc\_cidr\_block | The CIDR block of the VPC |
4050
| default\_vpc\_id | The ID of the Default VPC |
41-
4251
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/network-acls/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
3030

3131
No provider.
3232

33+
## Modules
34+
35+
| Name | Source | Version |
36+
|------|--------|---------|
37+
| vpc | ../../ | |
38+
39+
## Resources
40+
41+
No resources.
42+
3343
## Inputs
3444

3545
No input.
@@ -51,5 +61,4 @@ No input.
5161
| public\_subnets | List of IDs of public subnets |
5262
| vpc\_cidr\_block | The CIDR block of the VPC |
5363
| vpc\_id | The ID of the VPC |
54-
5564
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/secondary-cidr-blocks/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2828

2929
No provider.
3030

31+
## Modules
32+
33+
| Name | Source | Version |
34+
|------|--------|---------|
35+
| vpc | ../../ | |
36+
37+
## Resources
38+
39+
No resources.
40+
3141
## Inputs
3242

3343
No input.
@@ -42,5 +52,4 @@ No input.
4252
| vpc\_cidr\_block | The CIDR block of the VPC |
4353
| vpc\_id | The ID of the VPC |
4454
| vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
45-
4655
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/simple-vpc/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
3232

3333
No provider.
3434

35+
## Modules
36+
37+
| Name | Source | Version |
38+
|------|--------|---------|
39+
| vpc | ../../ | |
40+
41+
## Resources
42+
43+
No resources.
44+
3545
## Inputs
3646

3747
No input.
@@ -46,5 +56,4 @@ No input.
4656
| public\_subnets | List of IDs of public subnets |
4757
| vpc\_cidr\_block | The CIDR block of the VPC |
4858
| vpc\_id | The ID of the VPC |
49-
5059
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/vpc-flow-logs/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,26 @@ Note that this example may create resources which can cost money (AWS Elastic IP
3434
| aws | >= 3.10 |
3535
| random | >= 2 |
3636

37+
## Modules
38+
39+
| Name | Source | Version |
40+
|------|--------|---------|
41+
| s3_bucket | terraform-aws-modules/s3-bucket/aws | ~> 1.0 |
42+
| vpc_with_flow_logs_cloudwatch_logs | ../../ | |
43+
| vpc_with_flow_logs_cloudwatch_logs_default | ../../ | |
44+
| vpc_with_flow_logs_s3_bucket | ../../ | |
45+
46+
## Resources
47+
48+
| Name |
49+
|------|
50+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/cloudwatch_log_group) |
51+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/data-sources/iam_policy_document) |
52+
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/iam_policy) |
53+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/iam_role_policy_attachment) |
54+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/3.10/docs/resources/iam_role) |
55+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
56+
3757
## Inputs
3858

3959
No input.
@@ -53,5 +73,4 @@ No input.
5373
| vpc\_with\_flow\_logs\_cloudwatch\_logs\_vpc\_flow\_log\_destination\_arn | The ARN of the destination for VPC Flow Logs |
5474
| vpc\_with\_flow\_logs\_cloudwatch\_logs\_vpc\_flow\_log\_destination\_type | The type of the destination for VPC Flow Logs |
5575
| vpc\_with\_flow\_logs\_cloudwatch\_logs\_vpc\_flow\_log\_id | The ID of the Flow Log resource |
56-
5776
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/vpc-separate-private-route-tables/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2828

2929
No provider.
3030

31+
## Modules
32+
33+
| Name | Source | Version |
34+
|------|--------|---------|
35+
| vpc | ../../ | |
36+
37+
## Resources
38+
39+
No resources.
40+
3141
## Inputs
3242

3343
No input.
@@ -43,5 +53,4 @@ No input.
4353
| public\_subnets | List of IDs of public subnets |
4454
| redshift\_subnets | List of IDs of elasticache subnets |
4555
| vpc\_id | The ID of the VPC |
46-
4756
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)