Skip to content

Commit 0c2db00

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation and pin terraform_docs version to avoid future changes (#619)
1 parent 997cba4 commit 0c2db00

File tree

14 files changed

+1137
-954
lines changed

14 files changed

+1137
-954
lines changed

‎.github/workflows/pre-commit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ jobs:
9494
- name: Install pre-commit dependencies
9595
run: |
9696
pip install pre-commit
97-
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
97+
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12.0-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
9898
curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
9999
- name: Execute pre-commit
100100
# Run all pre-commit checks on max version supported

‎.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
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.47.0
3+
rev: v1.48.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate

‎README.md

Lines changed: 974 additions & 794 deletions
Large diffs are not rendered by default.

‎examples/complete-vpc/README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,51 +21,52 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2121

2222
| Name | Version |
2323
|------|---------|
24-
| terraform | >= 0.12.21 |
25-
| aws | >= 3.10 |
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.10 |
2626

2727
## Providers
2828

2929
| Name | Version |
3030
|------|---------|
31-
| aws | >= 3.10 |
31+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.10 |
3232

3333
## Modules
3434

3535
| Name | Source | Version |
3636
|------|--------|---------|
37-
| vpc | ../../ | |
37+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | |
3838

3939
## Resources
4040

41-
| Name |
42-
|------|
43-
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
44-
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) |
45-
| [aws_vpc_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc_endpoint) |
41+
| Name | Type |
42+
|------|------|
43+
| [aws_iam_policy_document.dynamodb_endpoint_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
44+
| [aws_iam_policy_document.generic_endpoint_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
45+
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) | data source |
46+
| [aws_vpc_endpoint.dynamodb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc_endpoint) | data source |
4647

4748
## Inputs
4849

49-
No input.
50+
No inputs.
5051

5152
## Outputs
5253

5354
| Name | Description |
5455
|------|-------------|
55-
| cgw\_ids | List of IDs of Customer Gateway |
56-
| database\_subnets | List of IDs of database subnets |
57-
| elasticache\_subnets | List of IDs of elasticache subnets |
58-
| intra\_subnets | List of IDs of intra subnets |
59-
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
60-
| private\_subnets | List of IDs of private subnets |
61-
| public\_subnets | List of IDs of public subnets |
62-
| redshift\_subnets | List of IDs of redshift subnets |
63-
| this\_customer\_gateway | Map of Customer Gateway attributes |
64-
| vpc\_endpoint\_lambda\_dns\_entry | The DNS entries for the VPC Endpoint for Lambda. |
65-
| vpc\_endpoint\_lambda\_id | The ID of VPC endpoint for Lambda |
66-
| vpc\_endpoint\_lambda\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for Lambda. |
67-
| vpc\_endpoint\_ssm\_dns\_entry | The DNS entries for the VPC Endpoint for SSM. |
68-
| vpc\_endpoint\_ssm\_id | The ID of VPC endpoint for SSM |
69-
| vpc\_endpoint\_ssm\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for SSM. |
70-
| vpc\_id | The ID of the VPC |
56+
| <a name="output_cgw_ids"></a> [cgw\_ids](#output\_cgw\_ids) | List of IDs of Customer Gateway |
57+
| <a name="output_database_subnets"></a> [database\_subnets](#output\_database\_subnets) | List of IDs of database subnets |
58+
| <a name="output_elasticache_subnets"></a> [elasticache\_subnets](#output\_elasticache\_subnets) | List of IDs of elasticache subnets |
59+
| <a name="output_intra_subnets"></a> [intra\_subnets](#output\_intra\_subnets) | List of IDs of intra subnets |
60+
| <a name="output_nat_public_ips"></a> [nat\_public\_ips](#output\_nat\_public\_ips) | List of public Elastic IPs created for AWS NAT Gateway |
61+
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
62+
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
63+
| <a name="output_redshift_subnets"></a> [redshift\_subnets](#output\_redshift\_subnets) | List of IDs of redshift subnets |
64+
| <a name="output_this_customer_gateway"></a> [this\_customer\_gateway](#output\_this\_customer\_gateway) | Map of Customer Gateway attributes |
65+
| <a name="output_vpc_endpoint_lambda_dns_entry"></a> [vpc\_endpoint\_lambda\_dns\_entry](#output\_vpc\_endpoint\_lambda\_dns\_entry) | The DNS entries for the VPC Endpoint for Lambda. |
66+
| <a name="output_vpc_endpoint_lambda_id"></a> [vpc\_endpoint\_lambda\_id](#output\_vpc\_endpoint\_lambda\_id) | The ID of VPC endpoint for Lambda |
67+
| <a name="output_vpc_endpoint_lambda_network_interface_ids"></a> [vpc\_endpoint\_lambda\_network\_interface\_ids](#output\_vpc\_endpoint\_lambda\_network\_interface\_ids) | One or more network interfaces for the VPC Endpoint for Lambda. |
68+
| <a name="output_vpc_endpoint_ssm_dns_entry"></a> [vpc\_endpoint\_ssm\_dns\_entry](#output\_vpc\_endpoint\_ssm\_dns\_entry) | The DNS entries for the VPC Endpoint for SSM. |
69+
| <a name="output_vpc_endpoint_ssm_id"></a> [vpc\_endpoint\_ssm\_id](#output\_vpc\_endpoint\_ssm\_id) | The ID of VPC endpoint for SSM |
70+
| <a name="output_vpc_endpoint_ssm_network_interface_ids"></a> [vpc\_endpoint\_ssm\_network\_interface\_ids](#output\_vpc\_endpoint\_ssm\_network\_interface\_ids) | One or more network interfaces for the VPC Endpoint for SSM. |
71+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
7172
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/ipv6/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,36 @@ Note that this example may create resources which can cost money (AWS Elastic IP
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.21 |
23-
| aws | >= 2.70 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.70 |
2424

2525
## Providers
2626

2727
| Name | Version |
2828
|------|---------|
29-
| aws | >= 2.70 |
29+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.70 |
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| vpc | ../.. | |
35+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../.. | |
3636

3737
## Resources
3838

39-
| Name |
40-
|------|
41-
| [aws_availability_zones](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) |
39+
| Name | Type |
40+
|------|------|
41+
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
4242

4343
## Inputs
4444

45-
No input.
45+
No inputs.
4646

4747
## Outputs
4848

4949
| Name | Description |
5050
|------|-------------|
51-
| ipv6\_association\_id | The association ID for the IPv6 CIDR block |
52-
| ipv6\_cidr\_block | The IPv6 CIDR block |
53-
| vpc\_id | The ID of the VPC |
51+
| <a name="output_ipv6_association_id"></a> [ipv6\_association\_id](#output\_ipv6\_association\_id) | The association ID for the IPv6 CIDR block |
52+
| <a name="output_ipv6_cidr_block"></a> [ipv6\_cidr\_block](#output\_ipv6\_cidr\_block) | The IPv6 CIDR block |
53+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
5454
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,35 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2323

2424
| Name | Version |
2525
|------|---------|
26-
| terraform | >= 0.12.21 |
27-
| aws | >= 2.70 |
26+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
27+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.70 |
2828

2929
## Providers
3030

31-
No provider.
31+
No providers.
3232

3333
## Modules
3434

3535
| Name | Source | Version |
3636
|------|--------|---------|
37-
| vpc | ../../ | |
37+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | |
3838

3939
## Resources
4040

4141
No resources.
4242

4343
## Inputs
4444

45-
No input.
45+
No inputs.
4646

4747
## Outputs
4848

4949
| Name | Description |
5050
|------|-------------|
51-
| database\_subnets | List of IDs of database subnets |
52-
| elasticache\_subnets | List of IDs of elasticache subnets |
53-
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
54-
| private\_subnets | List of IDs of private subnets |
55-
| public\_subnets | List of IDs of public subnets |
56-
| vpc\_id | The ID of the VPC |
51+
| <a name="output_database_subnets"></a> [database\_subnets](#output\_database\_subnets) | List of IDs of database subnets |
52+
| <a name="output_elasticache_subnets"></a> [elasticache\_subnets](#output\_elasticache\_subnets) | List of IDs of elasticache subnets |
53+
| <a name="output_nat_public_ips"></a> [nat\_public\_ips](#output\_nat\_public\_ips) | List of public Elastic IPs created for AWS NAT Gateway |
54+
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
55+
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
56+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
5757
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,35 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2121

2222
| Name | Version |
2323
|------|---------|
24-
| terraform | >= 0.12.21 |
25-
| aws | >= 2.70 |
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.70 |
2626

2727
## Providers
2828

29-
No provider.
29+
No providers.
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| vpc | ../../ | |
35+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | |
3636

3737
## Resources
3838

3939
No resources.
4040

4141
## Inputs
4242

43-
No input.
43+
No inputs.
4444

4545
## Outputs
4646

4747
| Name | Description |
4848
|------|-------------|
49-
| database\_subnets | List of IDs of database subnets |
50-
| elasticache\_subnets | List of IDs of elasticache subnets |
51-
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
52-
| private\_subnets | List of IDs of private subnets |
53-
| public\_subnets | List of IDs of public subnets |
54-
| vpc\_id | The ID of the VPC |
49+
| <a name="output_database_subnets"></a> [database\_subnets](#output\_database\_subnets) | List of IDs of database subnets |
50+
| <a name="output_elasticache_subnets"></a> [elasticache\_subnets](#output\_elasticache\_subnets) | List of IDs of elasticache subnets |
51+
| <a name="output_nat_public_ips"></a> [nat\_public\_ips](#output\_nat\_public\_ips) | List of public Elastic IPs created for AWS NAT Gateway |
52+
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
53+
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
54+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
5555
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,35 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2121

2222
| Name | Version |
2323
|------|---------|
24-
| terraform | >= 0.12.21 |
25-
| aws | >= 2.70 |
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.70 |
2626

2727
## Providers
2828

29-
No provider.
29+
No providers.
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| vpc | ../../ | |
35+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | |
3636

3737
## Resources
3838

3939
No resources.
4040

4141
## Inputs
4242

43-
No input.
43+
No inputs.
4444

4545
## Outputs
4646

4747
| Name | Description |
4848
|------|-------------|
49-
| database\_subnets | List of IDs of database subnets |
50-
| elasticache\_subnets | List of IDs of elasticache subnets |
51-
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
52-
| private\_subnets | List of IDs of private subnets |
53-
| public\_subnets | List of IDs of public subnets |
54-
| vpc\_id | The ID of the VPC |
49+
| <a name="output_database_subnets"></a> [database\_subnets](#output\_database\_subnets) | List of IDs of database subnets |
50+
| <a name="output_elasticache_subnets"></a> [elasticache\_subnets](#output\_elasticache\_subnets) | List of IDs of elasticache subnets |
51+
| <a name="output_nat_public_ips"></a> [nat\_public\_ips](#output\_nat\_public\_ips) | List of public Elastic IPs created for AWS NAT Gateway |
52+
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
53+
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
54+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
5555
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,31 @@ Run `terraform destroy` when you don't need these resources.
2121

2222
| Name | Version |
2323
|------|---------|
24-
| terraform | >= 0.12.21 |
25-
| aws | >= 2.70 |
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.70 |
2626

2727
## Providers
2828

29-
No provider.
29+
No providers.
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| vpc | ../../ | |
35+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | |
3636

3737
## Resources
3838

3939
No resources.
4040

4141
## Inputs
4242

43-
No input.
43+
No inputs.
4444

4545
## Outputs
4646

4747
| Name | Description |
4848
|------|-------------|
49-
| default\_vpc\_cidr\_block | The CIDR block of the VPC |
50-
| default\_vpc\_id | The ID of the Default VPC |
49+
| <a name="output_default_vpc_cidr_block"></a> [default\_vpc\_cidr\_block](#output\_default\_vpc\_cidr\_block) | The CIDR block of the VPC |
50+
| <a name="output_default_vpc_id"></a> [default\_vpc\_id](#output\_default\_vpc\_id) | The ID of the Default VPC |
5151
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/network-acls/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,42 +23,42 @@ Note that this example may create resources which can cost money (AWS Elastic IP
2323

2424
| Name | Version |
2525
|------|---------|
26-
| terraform | >= 0.12.21 |
27-
| aws | >= 2.70 |
26+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.21 |
27+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.70 |
2828

2929
## Providers
3030

31-
No provider.
31+
No providers.
3232

3333
## Modules
3434

3535
| Name | Source | Version |
3636
|------|--------|---------|
37-
| vpc | ../../ | |
37+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../../ | |
3838

3939
## Resources
4040

4141
No resources.
4242

4343
## Inputs
4444

45-
No input.
45+
No inputs.
4646

4747
## Outputs
4848

4949
| Name | Description |
5050
|------|-------------|
51-
| default\_network\_acl\_id | The ID of the default network ACL |
52-
| elasticache\_network\_acl\_arn | ARN of the elasticache network ACL |
53-
| elasticache\_network\_acl\_id | ID of the elasticache network ACL |
54-
| module\_vpc | Module VPC |
55-
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
56-
| private\_network\_acl\_arn | ARN of the private network ACL |
57-
| private\_network\_acl\_id | ID of the private network ACL |
58-
| private\_subnets | List of IDs of private subnets |
59-
| public\_network\_acl\_arn | ARN of the public network ACL |
60-
| public\_network\_acl\_id | ID of the public network ACL |
61-
| public\_subnets | List of IDs of public subnets |
62-
| vpc\_cidr\_block | The CIDR block of the VPC |
63-
| vpc\_id | The ID of the VPC |
51+
| <a name="output_default_network_acl_id"></a> [default\_network\_acl\_id](#output\_default\_network\_acl\_id) | The ID of the default network ACL |
52+
| <a name="output_elasticache_network_acl_arn"></a> [elasticache\_network\_acl\_arn](#output\_elasticache\_network\_acl\_arn) | ARN of the elasticache network ACL |
53+
| <a name="output_elasticache_network_acl_id"></a> [elasticache\_network\_acl\_id](#output\_elasticache\_network\_acl\_id) | ID of the elasticache network ACL |
54+
| <a name="output_module_vpc"></a> [module\_vpc](#output\_module\_vpc) | Module VPC |
55+
| <a name="output_nat_public_ips"></a> [nat\_public\_ips](#output\_nat\_public\_ips) | List of public Elastic IPs created for AWS NAT Gateway |
56+
| <a name="output_private_network_acl_arn"></a> [private\_network\_acl\_arn](#output\_private\_network\_acl\_arn) | ARN of the private network ACL |
57+
| <a name="output_private_network_acl_id"></a> [private\_network\_acl\_id](#output\_private\_network\_acl\_id) | ID of the private network ACL |
58+
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of IDs of private subnets |
59+
| <a name="output_public_network_acl_arn"></a> [public\_network\_acl\_arn](#output\_public\_network\_acl\_arn) | ARN of the public network ACL |
60+
| <a name="output_public_network_acl_id"></a> [public\_network\_acl\_id](#output\_public\_network\_acl\_id) | ID of the public network ACL |
61+
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of IDs of public subnets |
62+
| <a name="output_vpc_cidr_block"></a> [vpc\_cidr\_block](#output\_vpc\_cidr\_block) | The CIDR block of the VPC |
63+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
6464
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)