441 lines
17 KiB
Markdown
441 lines
17 KiB
Markdown
# Minimalistic VPC module
|
|
|
|
This module allows creation and management of VPC networks including subnetworks and subnetwork IAM bindings, Shared VPC activation and service project registration, and one-to-one peering.
|
|
|
|
## Examples
|
|
|
|
The module allows for several different VPC configurations, some of the most common are shown below.
|
|
|
|
### Simple VPC
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
subnets = [
|
|
{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "production"
|
|
region = "europe-west1"
|
|
secondary_ip_ranges = {
|
|
pods = "172.16.0.0/20"
|
|
services = "192.168.0.0/24"
|
|
}
|
|
},
|
|
{
|
|
ip_cidr_range = "10.0.16.0/24"
|
|
name = "production"
|
|
region = "europe-west2"
|
|
}
|
|
]
|
|
}
|
|
# tftest modules=1 resources=3 inventory=simple.yaml
|
|
```
|
|
|
|
### Subnet Options
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
subnets = [
|
|
# simple subnet
|
|
{
|
|
name = "simple"
|
|
region = "europe-west1"
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
},
|
|
# custom description and PGA disabled
|
|
{
|
|
name = "no-pga"
|
|
region = "europe-west1"
|
|
ip_cidr_range = "10.0.1.0/24",
|
|
description = "Subnet b"
|
|
enable_private_access = false
|
|
},
|
|
# secondary ranges
|
|
{
|
|
name = "with-secondary-ranges"
|
|
region = "europe-west1"
|
|
ip_cidr_range = "10.0.2.0/24"
|
|
secondary_ip_ranges = {
|
|
a = "192.168.0.0/24"
|
|
b = "192.168.1.0/24"
|
|
}
|
|
},
|
|
# enable flow logs
|
|
{
|
|
name = "with-flow-logs"
|
|
region = "europe-west1"
|
|
ip_cidr_range = "10.0.3.0/24"
|
|
flow_logs_config = {
|
|
flow_sampling = 0.5
|
|
aggregation_interval = "INTERVAL_10_MIN"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
# tftest modules=1 resources=5 inventory=subnet-options.yaml
|
|
```
|
|
|
|
### Subnet IAM
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
subnets = [
|
|
{
|
|
name = "subnet-1"
|
|
region = "europe-west1"
|
|
ip_cidr_range = "10.0.1.0/24"
|
|
},
|
|
{
|
|
name = "subnet-2"
|
|
region = "europe-west1"
|
|
ip_cidr_range = "10.0.1.0/24"
|
|
}
|
|
]
|
|
subnet_iam = {
|
|
"europe-west1/subnet-1" = {
|
|
"roles/compute.networkUser" = [
|
|
"user:user1@example.com", "group:group1@example.com"
|
|
]
|
|
}
|
|
"europe-west1/subnet-2" = {
|
|
"roles/compute.networkUser" = [
|
|
"user:user2@example.com", "group:group2@example.com"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=5 inventory=subnet-iam.yaml
|
|
```
|
|
|
|
### Peering
|
|
|
|
A single peering can be configured for the VPC, so as to allow management of simple scenarios, and more complex configurations like hub and spoke by defining the peering configuration on the spoke VPCs. Care must be taken so as a single peering is created/changed/destroyed at a time, due to the specific behaviour of the peering API calls.
|
|
|
|
If you only want to create the "local" side of the peering, use `peering_create_remote_end` to `false`. This is useful if you don't have permissions on the remote project/VPC to create peerings.
|
|
|
|
```hcl
|
|
module "vpc-hub" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "hub"
|
|
name = "vpc-hub"
|
|
subnets = [{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "subnet-1"
|
|
region = "europe-west1"
|
|
}]
|
|
}
|
|
|
|
module "vpc-spoke-1" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "spoke1"
|
|
name = "vpc-spoke1"
|
|
subnets = [{
|
|
ip_cidr_range = "10.0.1.0/24"
|
|
name = "subnet-2"
|
|
region = "europe-west1"
|
|
}]
|
|
peering_config = {
|
|
peer_vpc_self_link = module.vpc-hub.self_link
|
|
import_routes = true
|
|
}
|
|
}
|
|
# tftest modules=2 resources=6 inventory=peering.yaml
|
|
```
|
|
|
|
### Shared VPC
|
|
|
|
[Shared VPC](https://cloud.google.com/vpc/docs/shared-vpc) is a project-level functionality which enables a project to share its VPCs with other projects. The `shared_vpc_host` variable is here to help with rapid prototyping, we recommend leveraging the project module for production usage.
|
|
|
|
```hcl
|
|
locals {
|
|
service_project_1 = {
|
|
project_id = "project1"
|
|
gke_service_account = "serviceAccount:gke"
|
|
cloud_services_service_account = "serviceAccount:cloudsvc"
|
|
}
|
|
service_project_2 = {
|
|
project_id = "project2"
|
|
}
|
|
}
|
|
|
|
module "vpc-host" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-host-network"
|
|
subnets = [
|
|
{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "subnet-1"
|
|
region = "europe-west1"
|
|
secondary_ip_ranges = {
|
|
pods = "172.16.0.0/20"
|
|
services = "192.168.0.0/24"
|
|
}
|
|
}
|
|
]
|
|
shared_vpc_host = true
|
|
shared_vpc_service_projects = [
|
|
local.service_project_1.project_id,
|
|
local.service_project_2.project_id
|
|
]
|
|
subnet_iam = {
|
|
"europe-west1/subnet-1" = {
|
|
"roles/compute.networkUser" = [
|
|
local.service_project_1.cloud_services_service_account,
|
|
local.service_project_1.gke_service_account
|
|
]
|
|
"roles/compute.securityAdmin" = [
|
|
local.service_project_1.gke_service_account
|
|
]
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=7 inventory=shared-vpc.yaml
|
|
```
|
|
|
|
### Private Service Networking
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
subnets = [
|
|
{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "production"
|
|
region = "europe-west1"
|
|
}
|
|
]
|
|
psa_config = {
|
|
ranges = { myrange = "10.0.1.0/24" }
|
|
}
|
|
}
|
|
# tftest modules=1 resources=5 inventory=psc.yaml
|
|
```
|
|
|
|
### Private Service Networking with peering routes
|
|
|
|
Custom routes can be optionally exported/imported through the peering formed with the Google managed PSA VPC.
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
subnets = [
|
|
{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "production"
|
|
region = "europe-west1"
|
|
}
|
|
]
|
|
psa_config = {
|
|
ranges = { myrange = "10.0.1.0/24" }
|
|
export_routes = true
|
|
import_routes = true
|
|
}
|
|
}
|
|
# tftest modules=1 resources=5 inventory=psc-routes.yaml
|
|
```
|
|
|
|
### Subnets for Private Service Connect, Proxy-only subnets
|
|
|
|
Along with common private subnets module supports creation more service specific subnets for the following purposes:
|
|
|
|
- [Proxy-only subnets](https://cloud.google.com/load-balancing/docs/proxy-only-subnets) for Regional HTTPS Internal HTTPS Load Balancers
|
|
- [Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect#psc-subnets) subnets
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
|
|
subnets_proxy_only = [
|
|
{
|
|
ip_cidr_range = "10.0.1.0/24"
|
|
name = "regional-proxy"
|
|
region = "europe-west1"
|
|
active = true
|
|
}
|
|
]
|
|
subnets_psc = [
|
|
{
|
|
ip_cidr_range = "10.0.3.0/24"
|
|
name = "psc"
|
|
region = "europe-west1"
|
|
}
|
|
]
|
|
}
|
|
# tftest modules=1 resources=3 inventory=proxy-only-subnets.yaml
|
|
```
|
|
|
|
### DNS Policies
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
dns_policy = {
|
|
inbound = true
|
|
outbound = {
|
|
private_ns = ["10.0.0.1"]
|
|
public_ns = ["8.8.8.8"]
|
|
}
|
|
}
|
|
subnets = [
|
|
{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "production"
|
|
region = "europe-west1"
|
|
}
|
|
]
|
|
}
|
|
# tftest modules=1 resources=3 inventory=dns-policies.yaml
|
|
```
|
|
|
|
### Subnet Factory
|
|
|
|
The `net-vpc` module includes a subnet factory (see [Resource Factories](../../blueprints/factories/)) for the massive creation of subnets leveraging one configuration file per subnet. The factory also supports proxy-only and PSC subnets via the `purpose` attribute.
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
project_id = "my-project"
|
|
name = "my-network"
|
|
data_folder = "config/subnets"
|
|
}
|
|
# tftest modules=1 resources=6 files=subnet-simple,subnet-detailed,subnet-proxy,subnet-psc inventory=factory.yaml
|
|
```
|
|
|
|
```yaml
|
|
# tftest-file id=subnet-simple path=config/subnets/subnet-simple.yaml
|
|
region: europe-west4
|
|
ip_cidr_range: 10.0.1.0/24
|
|
```
|
|
|
|
```yaml
|
|
# tftest-file id=subnet-detailed path=config/subnets/subnet-detailed.yaml
|
|
region: europe-west1
|
|
description: Sample description
|
|
ip_cidr_range: 10.0.0.0/24
|
|
# optional attributes
|
|
enable_private_access: false # defaults to true
|
|
iam_users: ["foobar@example.com"] # grant compute/networkUser to users
|
|
iam_groups: ["lorem@example.com"] # grant compute/networkUser to groups
|
|
iam_service_accounts: ["fbz@prj.iam.gserviceaccount.com"]
|
|
secondary_ip_ranges: # map of secondary ip ranges
|
|
secondary-range-a: 192.168.0.0/24
|
|
flow_logs: # enable, set to empty map to use defaults
|
|
aggregation_interval: "INTERVAL_5_SEC"
|
|
flow_sampling: 0.5
|
|
metadata: "INCLUDE_ALL_METADATA"
|
|
filter_expression: null
|
|
```
|
|
|
|
```yaml
|
|
# tftest-file id=subnet-proxy path=config/subnets/subnet-proxy.yaml
|
|
region: europe-west4
|
|
ip_cidr_range: 10.1.0.0/24
|
|
purpose: REGIONAL_MANAGED_PROXY
|
|
```
|
|
|
|
```yaml
|
|
# tftest-file id=subnet-psc path=config/subnets/subnet-psc.yaml
|
|
region: europe-west4
|
|
ip_cidr_range: 10.2.0.0/24
|
|
purpose: PRIVATE_SERVICE_CONNECT
|
|
```
|
|
|
|
### Custom Routes
|
|
|
|
VPC routes can be configured through the `routes` variable.
|
|
|
|
```hcl
|
|
locals {
|
|
route_types = {
|
|
gateway = "global/gateways/default-internet-gateway"
|
|
instance = "zones/europe-west1-b/test"
|
|
ip = "192.168.0.128"
|
|
ilb = "regions/europe-west1/forwardingRules/test"
|
|
vpn_tunnel = "regions/europe-west1/vpnTunnels/foo"
|
|
}
|
|
}
|
|
module "vpc" {
|
|
source = "./fabric/modules/net-vpc"
|
|
for_each = local.route_types
|
|
project_id = "my-project"
|
|
name = "my-network-with-route-${replace(each.key, "_", "-")}"
|
|
routes = {
|
|
next-hop = {
|
|
dest_range = "192.168.128.0/24"
|
|
tags = null
|
|
next_hop_type = each.key
|
|
next_hop = each.value
|
|
}
|
|
gateway = {
|
|
dest_range = "0.0.0.0/0",
|
|
priority = 100
|
|
tags = ["tag-a"]
|
|
next_hop_type = "gateway",
|
|
next_hop = "global/gateways/default-internet-gateway"
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=5 resources=15 inventory=routes.yaml
|
|
```
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [name](variables.tf#L60) | The name of the network being created. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L76) | The ID of the project where this VPC will be created. | <code>string</code> | ✓ | |
|
|
| [auto_create_subnetworks](variables.tf#L17) | Set to true to create an auto mode subnet, defaults to custom mode. | <code>bool</code> | | <code>false</code> |
|
|
| [data_folder](variables.tf#L23) | An optional folder containing the subnet configurations in YaML format. | <code>string</code> | | <code>null</code> |
|
|
| [delete_default_routes_on_create](variables.tf#L29) | Set to true to delete the default routes at creation time. | <code>bool</code> | | <code>false</code> |
|
|
| [description](variables.tf#L35) | An optional description of this resource (triggers recreation on change). | <code>string</code> | | <code>"Terraform-managed."</code> |
|
|
| [dns_policy](variables.tf#L41) | DNS policy setup for the VPC. | <code title="object({ inbound = optional(bool) logging = optional(bool) outbound = optional(object({ private_ns = list(string) public_ns = list(string) })) })">object({…})</code> | | <code>null</code> |
|
|
| [mtu](variables.tf#L54) | Maximum Transmission Unit in bytes. The minimum value for this field is 1460 (the default) and the maximum value is 1500 bytes. | <code>number</code> | | <code>null</code> |
|
|
| [peering_config](variables.tf#L65) | VPC peering configuration. | <code title="object({ peer_vpc_self_link = string create_remote_peer = optional(bool, true) export_routes = optional(bool) import_routes = optional(bool) })">object({…})</code> | | <code>null</code> |
|
|
| [psa_config](variables.tf#L81) | The Private Service Access configuration for Service Networking. | <code title="object({ ranges = map(string) export_routes = optional(bool, false) import_routes = optional(bool, false) })">object({…})</code> | | <code>null</code> |
|
|
| [routes](variables.tf#L91) | Network routes, keyed by name. | <code title="map(object({ dest_range = string next_hop_type = string # gateway, instance, ip, vpn_tunnel, ilb next_hop = string priority = optional(number) tags = optional(list(string)) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
| [routing_mode](variables.tf#L111) | The network routing mode (default 'GLOBAL'). | <code>string</code> | | <code>"GLOBAL"</code> |
|
|
| [shared_vpc_host](variables.tf#L121) | Enable shared VPC for this project. | <code>bool</code> | | <code>false</code> |
|
|
| [shared_vpc_service_projects](variables.tf#L127) | Shared VPC service projects to register with this host. | <code>list(string)</code> | | <code>[]</code> |
|
|
| [subnet_iam](variables.tf#L133) | Subnet IAM bindings in {REGION/NAME => {ROLE => [MEMBERS]} format. | <code>map(map(list(string)))</code> | | <code>{}</code> |
|
|
| [subnets](variables.tf#L139) | Subnet configuration. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) enable_private_access = optional(bool, true) flow_logs_config = optional(object({ aggregation_interval = optional(string) filter_expression = optional(string) flow_sampling = optional(number) metadata = optional(string) metadata_fields = optional(list(string)) })) ipv6 = optional(object({ access_type = optional(string) enable_private_access = optional(bool, true) })) secondary_ip_ranges = optional(map(string)) }))">list(object({…}))</code> | | <code>[]</code> |
|
|
| [subnets_proxy_only](variables.tf#L164) | List of proxy-only subnets for Regional HTTPS or Internal HTTPS load balancers. Note: Only one proxy-only subnet for each VPC network in each region can be active. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) active = bool }))">list(object({…}))</code> | | <code>[]</code> |
|
|
| [subnets_psc](variables.tf#L176) | List of subnets for Private Service Connect service producers. | <code title="list(object({ name = string ip_cidr_range = string region = string description = optional(string) }))">list(object({…}))</code> | | <code>[]</code> |
|
|
| [vpc_create](variables.tf#L187) | Create VPC. When set to false, uses a data source to reference existing VPC. | <code>bool</code> | | <code>true</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [bindings](outputs.tf#L17) | Subnet IAM bindings. | |
|
|
| [name](outputs.tf#L22) | The name of the VPC being created. | |
|
|
| [network](outputs.tf#L34) | Network resource. | |
|
|
| [project_id](outputs.tf#L46) | Project ID containing the network. Use this when you need to create resources *after* the VPC is fully set up (e.g. subnets created, shared VPC service projects attached, Private Service Networking configured). | |
|
|
| [self_link](outputs.tf#L59) | The URI of the VPC being created. | |
|
|
| [subnet_ips](outputs.tf#L71) | Map of subnet address ranges keyed by name. | |
|
|
| [subnet_regions](outputs.tf#L78) | Map of subnet regions keyed by name. | |
|
|
| [subnet_secondary_ranges](outputs.tf#L85) | Map of subnet secondary ranges keyed by name. | |
|
|
| [subnet_self_links](outputs.tf#L96) | Map of subnet self links keyed by name. | |
|
|
| [subnets](outputs.tf#L102) | Subnet resources. | |
|
|
| [subnets_proxy_only](outputs.tf#L107) | L7 ILB or L7 Regional LB subnet resources. | |
|
|
| [subnets_psc](outputs.tf#L112) | Private Service Connect subnet resources. | |
|
|
|
|
<!-- END TFDOC -->
|
|
The key format is `subnet_region/subnet_name`. For example `europe-west1/my_subnet`.
|