Skip to content

Commit

Permalink
Updates from generating docs with terraform-docs 0.6.0
Browse files Browse the repository at this point in the history
These changes came about from running `make` and regenerating the
`README.md` files with version 0.6.0 of `terraform-docs`
  • Loading branch information
glarizza committed Mar 13, 2019
1 parent 6fa1b88 commit 79a24cc
Show file tree
Hide file tree
Showing 7 changed files with 82 additions and 83 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,34 +75,33 @@ Then perform the following commands on the root folder:

[^]: (autogen_docs_start)


## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| 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 |
| network_name | The name of the network being created | string | - | yes |
| project_id | The ID of the project where this VPC will be created | string | - | yes |
| 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 |
| network\_name | The name of the network being created | string | n/a | yes |
| project\_id | The ID of the project where this VPC will be created | string | n/a | yes |
| routes | List of routes being created in this VPC | list | `<list>` | no |
| routing_mode | The network routing mode (default 'GLOBAL') | string | `GLOBAL` | no |
| secondary_ranges | Secondary ranges that will be used in some of the subnets | map | - | yes |
| shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | string | `false` | no |
| subnets | The list of subnets being created | list | - | yes |
| routing\_mode | The network routing mode (default 'GLOBAL') | string | `"GLOBAL"` | no |
| secondary\_ranges | Secondary ranges that will be used in some of the subnets | map | n/a | yes |
| shared\_vpc\_host | Makes this project a Shared VPC host if 'true' (default 'false') | string | `"false"` | no |
| subnets | The list of subnets being created | list | n/a | yes |

## Outputs

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

[^]: (autogen_docs_end)

Expand Down
20 changes: 10 additions & 10 deletions examples/delete_default_gateway_routes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ This VPC has a single subnet with no secondary ranges, and ensures the default i

[^]: (autogen_docs_start)


## Inputs

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

## Outputs

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

[^]: (autogen_docs_end)
41 changes: 21 additions & 20 deletions examples/multi_vpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,35 @@ This example configures a host network project with two separate networks.

[^]: (autogen_docs_start)


## Inputs

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

## Outputs

| Name | Description |
|------|-------------|
| network_01_name | The name of the VPC network-01 |
| network_01_routes | The routes associated with network-01 |
| network_01_self_link | The URI of the VPC network-01 |
| network_01_subnets | The names of the subnets being created on network-01 |
| network_01_subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
| network_01_subnets_ips | The IP and cidrs of the subnets being created on network-01 |
| network_01_subnets_private_access | Whether the subnets will have access to Google API's without a public IP on network-01 |
| network_01_subnets_regions | The region where the subnets will be created on network-01 |
| network_01_subnets_secondary_ranges | The secondary ranges associated with these subnets on network-01 |
| network_02_name | The name of the VPC network-02 |
| network_02_routes | The routes associated with network-02 |
| network_02_self_link | The URI of the VPC network-02 |
| network_02_subnets | The names of the subnets being created on network-02 |
| network_02_subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
| network_02_subnets_ips | The IP and cidrs of the subnets being created on network-02 |
| network_02_subnets_private_access | Whether the subnets will have access to Google API's without a public IP on network-02 |
| network_02_subnets_regions | The region where the subnets will be created on network-02 |
| network_02_subnets_secondary_ranges | The secondary ranges associated with these subnets on network-02 |
| network\_01\_name | The name of the VPC network-01 |
| network\_01\_routes | The routes associated with network-01 |
| network\_01\_self\_link | The URI of the VPC network-01 |
| network\_01\_subnets | The names of the subnets being created on network-01 |
| network\_01\_subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
| network\_01\_subnets\_ips | The IP and cidrs of the subnets being created on network-01 |
| network\_01\_subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP on network-01 |
| network\_01\_subnets\_regions | The region where the subnets will be created on network-01 |
| network\_01\_subnets\_secondary\_ranges | The secondary ranges associated with these subnets on network-01 |
| network\_02\_name | The name of the VPC network-02 |
| network\_02\_routes | The routes associated with network-02 |
| network\_02\_self\_link | The URI of the VPC network-02 |
| network\_02\_subnets | The names of the subnets being created on network-02 |
| network\_02\_subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
| network\_02\_subnets\_ips | The IP and cidrs of the subnets being created on network-02 |
| network\_02\_subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP on network-02 |
| network\_02\_subnets\_regions | The region where the subnets will be created on network-02 |
| network\_02\_subnets\_secondary\_ranges | The secondary ranges associated with these subnets on network-02 |

[^]: (autogen_docs_end)
20 changes: 10 additions & 10 deletions examples/secondary_ranges/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ ranges and the third being given a single secondary range.

[^]: (autogen_docs_start)


## Inputs

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

## Outputs

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

[^]: (autogen_docs_end)
20 changes: 10 additions & 10 deletions examples/simple_project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ This VPC has two subnets, with no secondary ranges.

[^]: (autogen_docs_start)


## Inputs

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

## Outputs

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

[^]: (autogen_docs_end)
20 changes: 10 additions & 10 deletions examples/simple_project_with_regional_network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ This VPC has two subnets, with no secondary ranges.

[^]: (autogen_docs_start)


## Inputs

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

## Outputs

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

[^]: (autogen_docs_end)
11 changes: 5 additions & 6 deletions test/fixtures/simulated_ci_environment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,19 @@ run the `make test_integration_docker` target

[^]: (autogen_docs_start)


## Inputs

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

## Outputs

| Name | Description |
|------|-------------|
| service_account_private_key | The SA KEY JSON content. Store in GOOGLE_CREDENTIALS. |
| service\_account\_private\_key | The SA KEY JSON content. Store in GOOGLE_CREDENTIALS. |

[^]: (autogen_docs_end)

0 comments on commit 79a24cc

Please sign in to comment.