Skip to content

Commit 79a24cc

Browse files
glarizzaglarizza
committed
Updates from generating docs with terraform-docs 0.6.0
These changes came about from running `make` and regenerating the `README.md` files with version 0.6.0 of `terraform-docs`
1 parent 6fa1b88 commit 79a24cc

File tree

7 files changed

+82
-83
lines changed

7 files changed

+82
-83
lines changed

‎README.md‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -75,34 +75,33 @@ Then perform the following commands on the root folder:
7575

7676
[^]: (autogen_docs_start)
7777

78-
7978
## Inputs
8079

8180
| Name | Description | Type | Default | Required |
8281
|------|-------------|:----:|:-----:|:-----:|
83-
| delete_default_internet_gateway_routes | If set, ensure that all routes within the network specified whose names begin with 'default-route' and with a next hop of 'default-internet-gateway' are deleted | string | `false` | no |
84-
| network_name | The name of the network being created | string | - | yes |
85-
| project_id | The ID of the project where this VPC will be created | string | - | yes |
82+
| delete\_default\_internet\_gateway\_routes | If set, ensure that all routes within the network specified whose names begin with 'default-route' and with a next hop of 'default-internet-gateway' are deleted | string | `"false"` | no |
83+
| network\_name | The name of the network being created | string | n/a | yes |
84+
| project\_id | The ID of the project where this VPC will be created | string | n/a | yes |
8685
| routes | List of routes being created in this VPC | list | `<list>` | no |
87-
| routing_mode | The network routing mode (default 'GLOBAL') | string | `GLOBAL` | no |
88-
| secondary_ranges | Secondary ranges that will be used in some of the subnets | map | - | yes |
89-
| shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | string | `false` | no |
90-
| subnets | The list of subnets being created | list | - | yes |
86+
| routing\_mode | The network routing mode (default 'GLOBAL') | string | `"GLOBAL"` | no |
87+
| secondary\_ranges | Secondary ranges that will be used in some of the subnets | map | n/a | yes |
88+
| shared\_vpc\_host | Makes this project a Shared VPC host if 'true' (default 'false') | string | `"false"` | no |
89+
| subnets | The list of subnets being created | list | n/a | yes |
9190

9291
## Outputs
9392

9493
| Name | Description |
9594
|------|-------------|
96-
| network_name | The name of the VPC being created |
97-
| network_self_link | The URI of the VPC being created |
95+
| network\_name | The name of the VPC being created |
96+
| network\_self\_link | The URI of the VPC being created |
9897
| routes | The routes associated with this VPC |
99-
| subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
100-
| subnets_ips | The IPs and CIDRs of the subnets being created |
101-
| subnets_names | The names of the subnets being created |
102-
| subnets_private_access | Whether the subnets will have access to Google API's without a public IP |
103-
| subnets_regions | The region where the subnets will be created |
104-
| subnets_secondary_ranges | The secondary ranges associated with these subnets |
105-
| subnets_self_links | The self-links of subnets being created |
98+
| subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
99+
| subnets\_ips | The IPs and CIDRs of the subnets being created |
100+
| subnets\_names | The names of the subnets being created |
101+
| subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP |
102+
| subnets\_regions | The region where the subnets will be created |
103+
| subnets\_secondary\_ranges | The secondary ranges associated with these subnets |
104+
| subnets\_self\_links | The self-links of subnets being created |
106105

107106
[^]: (autogen_docs_end)
108107

‎examples/delete_default_gateway_routes/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ This VPC has a single subnet with no secondary ranges, and ensures the default i
66

77
[^]: (autogen_docs_start)
88

9-
109
## Inputs
1110

1211
| Name | Description | Type | Default | Required |
1312
|------|-------------|:----:|:-----:|:-----:|
14-
| project_id | The project ID to host the network in | string | - | yes |
13+
| network\_name | The name of the VPC network being created | string | n/a | yes |
14+
| project\_id | The project ID to host the network in | string | n/a | yes |
1515

1616
## Outputs
1717

1818
| Name | Description |
1919
|------|-------------|
20-
| network_name | The name of the VPC being created |
21-
| network_self_link | The URI of the VPC being created |
20+
| network\_name | The name of the VPC being created |
21+
| network\_self\_link | The URI of the VPC being created |
2222
| routes | The routes associated with this VPC |
23-
| subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
24-
| subnets_ips | The IP and cidrs of the subnets being created |
25-
| subnets_names | The names of the subnets being created |
26-
| subnets_private_access | Whether the subnets will have access to Google API's without a public IP |
27-
| subnets_regions | The region where subnets will be created |
28-
| subnets_secondary_ranges | The secondary ranges associated with these subnets |
23+
| subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
24+
| subnets\_ips | The IP and cidrs of the subnets being created |
25+
| subnets\_names | The names of the subnets being created |
26+
| subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP |
27+
| subnets\_regions | The region where subnets will be created |
28+
| subnets\_secondary\_ranges | The secondary ranges associated with these subnets |
2929

3030
[^]: (autogen_docs_end)

‎examples/multi_vpc/README.md‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,35 @@ This example configures a host network project with two separate networks.
44

55
[^]: (autogen_docs_start)
66

7-
87
## Inputs
98

109
| Name | Description | Type | Default | Required |
1110
|------|-------------|:----:|:-----:|:-----:|
12-
| project_id | The project ID to host the network in | string | - | yes |
11+
| network\_01\_name | The name of the first VPC network being created | string | n/a | yes |
12+
| network\_02\_name | The name of the second VPC network being created | string | n/a | yes |
13+
| project\_id | The project ID to host the network in | string | n/a | yes |
1314

1415
## Outputs
1516

1617
| Name | Description |
1718
|------|-------------|
18-
| network_01_name | The name of the VPC network-01 |
19-
| network_01_routes | The routes associated with network-01 |
20-
| network_01_self_link | The URI of the VPC network-01 |
21-
| network_01_subnets | The names of the subnets being created on network-01 |
22-
| network_01_subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
23-
| network_01_subnets_ips | The IP and cidrs of the subnets being created on network-01 |
24-
| network_01_subnets_private_access | Whether the subnets will have access to Google API's without a public IP on network-01 |
25-
| network_01_subnets_regions | The region where the subnets will be created on network-01 |
26-
| network_01_subnets_secondary_ranges | The secondary ranges associated with these subnets on network-01 |
27-
| network_02_name | The name of the VPC network-02 |
28-
| network_02_routes | The routes associated with network-02 |
29-
| network_02_self_link | The URI of the VPC network-02 |
30-
| network_02_subnets | The names of the subnets being created on network-02 |
31-
| network_02_subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
32-
| network_02_subnets_ips | The IP and cidrs of the subnets being created on network-02 |
33-
| network_02_subnets_private_access | Whether the subnets will have access to Google API's without a public IP on network-02 |
34-
| network_02_subnets_regions | The region where the subnets will be created on network-02 |
35-
| network_02_subnets_secondary_ranges | The secondary ranges associated with these subnets on network-02 |
19+
| network\_01\_name | The name of the VPC network-01 |
20+
| network\_01\_routes | The routes associated with network-01 |
21+
| network\_01\_self\_link | The URI of the VPC network-01 |
22+
| network\_01\_subnets | The names of the subnets being created on network-01 |
23+
| network\_01\_subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
24+
| network\_01\_subnets\_ips | The IP and cidrs of the subnets being created on network-01 |
25+
| network\_01\_subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP on network-01 |
26+
| network\_01\_subnets\_regions | The region where the subnets will be created on network-01 |
27+
| network\_01\_subnets\_secondary\_ranges | The secondary ranges associated with these subnets on network-01 |
28+
| network\_02\_name | The name of the VPC network-02 |
29+
| network\_02\_routes | The routes associated with network-02 |
30+
| network\_02\_self\_link | The URI of the VPC network-02 |
31+
| network\_02\_subnets | The names of the subnets being created on network-02 |
32+
| network\_02\_subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
33+
| network\_02\_subnets\_ips | The IP and cidrs of the subnets being created on network-02 |
34+
| network\_02\_subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP on network-02 |
35+
| network\_02\_subnets\_regions | The region where the subnets will be created on network-02 |
36+
| network\_02\_subnets\_secondary\_ranges | The secondary ranges associated with these subnets on network-02 |
3637

3738
[^]: (autogen_docs_end)

‎examples/secondary_ranges/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@ ranges and the third being given a single secondary range.
77

88
[^]: (autogen_docs_start)
99

10-
1110
## Inputs
1211

1312
| Name | Description | Type | Default | Required |
1413
|------|-------------|:----:|:-----:|:-----:|
15-
| project_id | The project ID to host the network in | string | - | yes |
14+
| network\_name | The name of the VPC network being created | string | n/a | yes |
15+
| project\_id | The project ID to host the network in | string | n/a | yes |
1616

1717
## Outputs
1818

1919
| Name | Description |
2020
|------|-------------|
21-
| network_name | The name of the VPC being created |
22-
| network_self_link | The URI of the VPC being created |
21+
| network\_name | The name of the VPC being created |
22+
| network\_self\_link | The URI of the VPC being created |
2323
| routes | The routes associated with this VPC |
24-
| subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
25-
| subnets_ips | The IP and cidrs of the subnets being created |
26-
| subnets_names | The names of the subnets being created |
27-
| subnets_private_access | Whether the subnets will have access to Google API's without a public IP |
28-
| subnets_regions | The region where subnets will be created |
29-
| subnets_secondary_ranges | The secondary ranges associated with these subnets |
24+
| subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
25+
| subnets\_ips | The IP and cidrs of the subnets being created |
26+
| subnets\_names | The names of the subnets being created |
27+
| subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP |
28+
| subnets\_regions | The region where subnets will be created |
29+
| subnets\_secondary\_ranges | The secondary ranges associated with these subnets |
3030

3131
[^]: (autogen_docs_end)

‎examples/simple_project/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ This VPC has two subnets, with no secondary ranges.
66

77
[^]: (autogen_docs_start)
88

9-
109
## Inputs
1110

1211
| Name | Description | Type | Default | Required |
1312
|------|-------------|:----:|:-----:|:-----:|
14-
| project_id | The project ID to host the network in | string | - | yes |
13+
| network\_name | The name of the VPC network being created | string | n/a | yes |
14+
| project\_id | The project ID to host the network in | string | n/a | yes |
1515

1616
## Outputs
1717

1818
| Name | Description |
1919
|------|-------------|
20-
| network_name | The name of the VPC being created |
21-
| network_self_link | The URI of the VPC being created |
20+
| network\_name | The name of the VPC being created |
21+
| network\_self\_link | The URI of the VPC being created |
2222
| routes | The routes associated with this VPC |
23-
| subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
24-
| subnets_ips | The IP and cidrs of the subnets being created |
25-
| subnets_names | The names of the subnets being created |
26-
| subnets_private_access | Whether the subnets will have access to Google API's without a public IP |
27-
| subnets_regions | The region where subnets will be created |
28-
| subnets_secondary_ranges | The secondary ranges associated with these subnets |
23+
| subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
24+
| subnets\_ips | The IP and cidrs of the subnets being created |
25+
| subnets\_names | The names of the subnets being created |
26+
| subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP |
27+
| subnets\_regions | The region where subnets will be created |
28+
| subnets\_secondary\_ranges | The secondary ranges associated with these subnets |
2929

3030
[^]: (autogen_docs_end)

‎examples/simple_project_with_regional_network/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ This VPC has two subnets, with no secondary ranges.
66

77
[^]: (autogen_docs_start)
88

9-
109
## Inputs
1110

1211
| Name | Description | Type | Default | Required |
1312
|------|-------------|:----:|:-----:|:-----:|
14-
| project_id | The project ID to host the network in | string | - | yes |
13+
| network\_name | The name of the VPC network being created | string | n/a | yes |
14+
| project\_id | The project ID to host the network in | string | n/a | yes |
1515

1616
## Outputs
1717

1818
| Name | Description |
1919
|------|-------------|
20-
| network_name | The name of the VPC being created |
21-
| network_self_link | The URI of the VPC being created |
20+
| network\_name | The name of the VPC being created |
21+
| network\_self\_link | The URI of the VPC being created |
2222
| routes | The routes associated with this VPC |
23-
| subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
24-
| subnets_ips | The IP and cidrs of the subnets being created |
25-
| subnets_names | The names of the subnets being created |
26-
| subnets_private_access | Whether the subnets will have access to Google API's without a public IP |
27-
| subnets_regions | The region where subnets will be created |
28-
| subnets_secondary_ranges | The secondary ranges associated with these subnets |
23+
| subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
24+
| subnets\_ips | The IP and cidrs of the subnets being created |
25+
| subnets\_names | The names of the subnets being created |
26+
| subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP |
27+
| subnets\_regions | The region where subnets will be created |
28+
| subnets\_secondary\_ranges | The secondary ranges associated with these subnets |
2929

3030
[^]: (autogen_docs_end)

‎test/fixtures/simulated_ci_environment/README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,19 @@ run the `make test_integration_docker` target
3636

3737
[^]: (autogen_docs_start)
3838

39-
4039
## Inputs
4140

4241
| Name | Description | Type | Default | Required |
4342
|------|-------------|:----:|:-----:|:-----:|
44-
| billing_account | The billing account id associated with the project, e.g. XXXXXX-YYYYYY-ZZZZZZ | string | - | yes |
45-
| folder_id | The numeric folder id to create resources | string | - | yes |
46-
| organization_id | The numeric organization id | string | - | yes |
47-
| region | The region to deploy to | string | `us-west1` | no |
43+
| billing\_account | The billing account id associated with the project, e.g. XXXXXX-YYYYYY-ZZZZZZ | string | n/a | yes |
44+
| folder\_id | The numeric folder id to create resources | string | n/a | yes |
45+
| organization\_id | The numeric organization id | string | n/a | yes |
46+
| region | The region to deploy to | string | `"us-west1"` | no |
4847

4948
## Outputs
5049

5150
| Name | Description |
5251
|------|-------------|
53-
| service_account_private_key | The SA KEY JSON content. Store in GOOGLE_CREDENTIALS. |
52+
| service\_account\_private\_key | The SA KEY JSON content. Store in GOOGLE_CREDENTIALS. |
5453

5554
[^]: (autogen_docs_end)

0 commit comments

Comments
 (0)