Skip to content

Commit 6556120

Browse files
tfhartmanntfhartmann
committed
docs: fixing whitespace in README
1 parent 8c8b54c commit 6556120

File tree

1 file changed

+61
-68
lines changed

1 file changed

+61
-68
lines changed

‎README.md‎

Lines changed: 61 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@ This modules makes it easy to set up a new VPC Network in GCP by defining your n
44

55
It supports creating:
66

7-
- A Google Virtual Private Network (VPC)
8-
- Subnets within the VPC
9-
- Secondary ranges for the subnets (if applicable)
7+
- A Google Virtual Private Network (VPC)
8+
- Subnets within the VPC
9+
- Secondary ranges for the subnets (if applicable)
1010

1111
## Compatibility
1212

1313
This module is meant for use with Terraform 0.12. If you haven't [upgraded](https://www.terraform.io/upgrade-guides/0-12.html) and need a Terraform 0.11.x-compatible version of this module, the last released version intended for Terraform 0.11.x is [0.8.0](https://registry.terraform.io/modules/terraform-google-modules/network/google/0.8.0).
1414

1515
## Usage
16-
1716
You can go to the examples folder, however the usage of the module could be like this in your own main.tf file:
1817

1918
```hcl
@@ -74,96 +73,90 @@ module "vpc" {
7473

7574
Then perform the following commands on the root folder:
7675

77-
- `terraform init` to get the plugins
78-
- `terraform plan` to see the infrastructure plan
79-
- `terraform apply` to apply the infrastructure build
80-
- `terraform destroy` to destroy the built infrastructure
76+
- `terraform init` to get the plugins
77+
- `terraform plan` to see the infrastructure plan
78+
- `terraform apply` to apply the infrastructure build
79+
- `terraform destroy` to destroy the built infrastructure
8180

8281
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
83-
8482
## Inputs
8583

86-
| Name | Description | Type | Default | Required |
87-
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------: | :--------: | :------: |
88-
| auto_create_subnetworks | When set to true, the network is created in 'auto subnet mode' and it will create a subnet for each region automatically across the 10.128.0.0/9 address range. When set to false, the network is created in 'custom subnet mode' so the user can explicitly connect subnetwork resources. | bool | `"false"` | no |
89-
| 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 |
90-
| description | An optional description of this resource. The resource must be recreated to modify this field. | string | `""` | no |
91-
| network_name | The name of the network being created | string | n/a | yes |
92-
| project_id | The ID of the project where this VPC will be created | string | n/a | yes |
93-
| routes | List of routes being created in this VPC | list(map(string)) | `<list>` | no |
94-
| routing_mode | The network routing mode (default 'GLOBAL') | string | `"GLOBAL"` | no |
95-
| secondary_ranges | Secondary ranges that will be used in some of the subnets | object | n/a | yes |
96-
| shared_vpc_host | Makes this project a Shared VPC host if 'true' (default 'false') | string | `"false"` | no |
97-
| subnets | The list of subnets being created | list(map(string)) | n/a | yes |
84+
| Name | Description | Type | Default | Required |
85+
|------|-------------|:----:|:-----:|:-----:|
86+
| auto\_create\_subnetworks | When set to true, the network is created in 'auto subnet mode' and it will create a subnet for each region automatically across the 10.128.0.0/9 address range. When set to false, the network is created in 'custom subnet mode' so the user can explicitly connect subnetwork resources. | bool | `"false"` | no |
87+
| 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 |
88+
| description | An optional description of this resource. The resource must be recreated to modify this field. | string | `""` | no |
89+
| network\_name | The name of the network being created | string | n/a | yes |
90+
| project\_id | The ID of the project where this VPC will be created | string | n/a | yes |
91+
| routes | List of routes being created in this VPC | list(map(string)) | `<list>` | no |
92+
| routing\_mode | The network routing mode (default 'GLOBAL') | string | `"GLOBAL"` | no |
93+
| secondary\_ranges | Secondary ranges that will be used in some of the subnets | object | n/a | yes |
94+
| shared\_vpc\_host | Makes this project a Shared VPC host if 'true' (default 'false') | string | `"false"` | no |
95+
| subnets | The list of subnets being created | list(map(string)) | n/a | yes |
9896

9997
## Outputs
10098

101-
| Name | Description |
102-
| ------------------------ | ------------------------------------------------------------------------ |
103-
| network_name | The name of the VPC being created |
104-
| network_self_link | The URI of the VPC being created |
105-
| routes | The routes associated with this VPC |
106-
| subnets_flow_logs | Whether the subnets will have VPC flow logs enabled |
107-
| subnets_ips | The IPs and CIDRs of the subnets being created |
108-
| subnets_names | The names of the subnets being created |
109-
| subnets_private_access | Whether the subnets will have access to Google API's without a public IP |
110-
| subnets_regions | The region where the subnets will be created |
111-
| subnets_secondary_ranges | The secondary ranges associated with these subnets |
112-
| subnets_self_links | The self-links of subnets being created |
113-
| svpc_host_project_id | Shared VPC host project id. |
99+
| Name | Description |
100+
|------|-------------|
101+
| network\_name | The name of the VPC being created |
102+
| network\_self\_link | The URI of the VPC being created |
103+
| routes | The routes associated with this VPC |
104+
| subnets\_flow\_logs | Whether the subnets will have VPC flow logs enabled |
105+
| subnets\_ips | The IPs and CIDRs of the subnets being created |
106+
| subnets\_names | The names of the subnets being created |
107+
| subnets\_private\_access | Whether the subnets will have access to Google API's without a public IP |
108+
| subnets\_regions | The region where the subnets will be created |
109+
| subnets\_secondary\_ranges | The secondary ranges associated with these subnets |
110+
| subnets\_self\_links | The self-links of subnets being created |
111+
| svpc\_host\_project\_id | Shared VPC host project id. |
114112

115113
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
116114

117115
### Subnet Inputs
118-
119116
The subnets list contains maps, where each object represents a subnet. Each map has the following inputs (please see examples folder for additional references):
120117

121-
| Name | Description | Type | Default | Required |
122-
| --------------------- | ---------------------------------------------------------------- | :----: | :-----: | :------: |
123-
| subnet_name | The name of the subnet being created | string | - | yes |
124-
| subnet_ip | The IP and CIDR range of the subnet being created | string | - | yes |
125-
| subnet_region | The region where the subnet will be created | string | - | yes |
126-
| subnet_private_access | Whether this subnet will have private Google access enabled | string | false | no |
127-
| subnet_flow_logs | Whether the subnet will record and send flow log data to logging | string | false | no |
118+
| Name | Description | Type | Default | Required |
119+
|------|-------------|:----:|:-----:|:-----:|
120+
| subnet_name | The name of the subnet being created | string | - | yes |
121+
| subnet_ip | The IP and CIDR range of the subnet being created | string | - | yes |
122+
| subnet_region | The region where the subnet will be created | string | - | yes |
123+
| subnet_private_access | Whether this subnet will have private Google access enabled | string | false | no |
124+
| subnet_flow_logs | Whether the subnet will record and send flow log data to logging | string | false | no |
125+
| description | The description of the subnet being created | string | null | no |
128126

129127
### Route Inputs
130-
131-
The routes list contains maps, where each object represents a route. For the next_hop__ inputs, only one is possible to be used in each route. Having two next_hop__ inputs will produce an error. Each map has the following inputs (please see examples folder for additional references):
132-
133-
| Name | Description | Type | Default | Required |
134-
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----: | :-----: | :------: |
135-
| name | The name of the route being created | string | - | no |
136-
| description | The description of the route being created | string | - | no |
137-
| tags | The network tags assigned to this route. This is a list in string format. Eg. "tag-01,tag-02" | string | - | yes |
138-
| destination_range | The destination range of outgoing packets that this route applies to. Only IPv4 is supported | string | - | yes |
139-
| next_hop_internet | Whether the next hop to this route will the default internet gateway. Use "true" to enable this as next hop | string | - | yes |
140-
| next_hop_ip | Network IP address of an instance that should handle matching packets | string | - | yes |
141-
| next_hop_instance | URL or name of an instance that should handle matching packets. If just name is specified "next_hop_instance_zone" is required | string | - | yes |
142-
| next_hop_instance_zone | The zone of the instance specified in next_hop_instance. Only required if next_hop_instance is specified as a name | string | - | no |
143-
| next_hop_vpn_tunnel | URL to a VpnTunnel that should handle matching packets | string | - | yes |
144-
| priority | The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins | string | 1000 | yes |
128+
The routes list contains maps, where each object represents a route. For the next_hop_* inputs, only one is possible to be used in each route. Having two next_hop_* inputs will produce an error. Each map has the following inputs (please see examples folder for additional references):
129+
130+
| Name | Description | Type | Default | Required |
131+
|------|-------------|:----:|:-----:|:-----:|
132+
| name | The name of the route being created | string | - | no |
133+
| description | The description of the route being created | string | - | no |
134+
| tags | The network tags assigned to this route. This is a list in string format. Eg. "tag-01,tag-02"| string | - | yes |
135+
| destination_range | The destination range of outgoing packets that this route applies to. Only IPv4 is supported | string | - | yes
136+
| next_hop_internet | Whether the next hop to this route will the default internet gateway. Use "true" to enable this as next hop | string | - | yes |
137+
| next_hop_ip | Network IP address of an instance that should handle matching packets | string | - | yes |
138+
| next_hop_instance | URL or name of an instance that should handle matching packets. If just name is specified "next_hop_instance_zone" is required | string | - | yes |
139+
| next_hop_instance_zone | The zone of the instance specified in next_hop_instance. Only required if next_hop_instance is specified as a name | string | - | no |
140+
| next_hop_vpn_tunnel | URL to a VpnTunnel that should handle matching packets | string | - | yes |
141+
| priority | The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins | string | 1000 | yes |
145142

146143
## Requirements
147-
148144
### Installed Software
149-
150-
- [Terraform](https://www.terraform.io/downloads.html) ~> 0.12.0
151-
- [Terraform Provider for GCP][terraform-provider-google] ~> 2.10.0
152-
- [gcloud](https://cloud.google.com/sdk/gcloud/) >243.0.0
145+
- [Terraform](https://www.terraform.io/downloads.html) ~> 0.12.0
146+
- [Terraform Provider for GCP][terraform-provider-google] ~> 2.10.0
147+
- [gcloud](https://cloud.google.com/sdk/gcloud/) >243.0.0
153148

154149
### Configure a Service Account
155-
156150
In order to execute this module you must have a Service Account with the following roles:
157151

158-
- roles/compute.networkAdmin on the organization or folder
152+
- roles/compute.networkAdmin on the organization or folder
159153

160154
If you are going to manage a Shared VPC, you must have either:
161155

162-
- roles/compute.xpnAdmin on the organization
163-
- roles/compute.xpnAdmin on the folder (beta)
156+
- roles/compute.xpnAdmin on the organization
157+
- roles/compute.xpnAdmin on the folder (beta)
164158

165159
### Enable API's
166-
167160
In order to operate with the Service Account you must activate the following API on the project where the Service Account was created:
168161

169-
- Compute Engine API - compute.googleapis.com
162+
- Compute Engine API - compute.googleapis.com

0 commit comments

Comments
 (0)