188 lines
9.1 KiB
Markdown
188 lines
9.1 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 = "./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_range = {
|
|
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"
|
|
secondary_ip_range = {}
|
|
}
|
|
]
|
|
}
|
|
# tftest:modules=1:resources=3
|
|
```
|
|
|
|
### 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 = "./modules/net-vpc"
|
|
project_id = "hub"
|
|
name = "vpc-hub"
|
|
subnets = [{
|
|
ip_cidr_range = "10.0.0.0/24"
|
|
name = "subnet-1"
|
|
region = "europe-west1"
|
|
secondary_ip_range = null
|
|
}]
|
|
}
|
|
|
|
module "vpc-spoke-1" {
|
|
source = "./modules/net-vpc"
|
|
project_id = "spoke1"
|
|
name = "vpc-spoke1"
|
|
subnets = [{
|
|
ip_cidr_range = "10.0.1.0/24"
|
|
name = "subnet-2"
|
|
region = "europe-west1"
|
|
secondary_ip_range = null
|
|
}]
|
|
peering_config = {
|
|
peer_vpc_self_link = module.vpc-hub.self_link
|
|
export_routes = false
|
|
import_routes = true
|
|
}
|
|
}
|
|
# tftest:modules=2:resources=6
|
|
```
|
|
|
|
### Shared VPC
|
|
|
|
```hcl
|
|
locals {
|
|
service_project_1 = {
|
|
project_id = "project1"
|
|
gke_service_account = "gke"
|
|
cloud_services_service_account = "cloudsvc"
|
|
}
|
|
service_project_2 = {
|
|
project_id = "project2"
|
|
}
|
|
}
|
|
|
|
module "vpc-host" {
|
|
source = "./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_range = {
|
|
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
|
|
]
|
|
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
|
|
```
|
|
|
|
### Private Service Networking
|
|
|
|
```hcl
|
|
module "vpc" {
|
|
source = "./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_range = null
|
|
}
|
|
]
|
|
private_service_networking_range = "10.10.0.0/16"
|
|
}
|
|
# tftest:modules=1:resources=4
|
|
```
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---: |:---:|:---:|
|
|
| name | The name of the network being created | <code title="">string</code> | ✓ | |
|
|
| project_id | The ID of the project where this VPC will be created | <code title="">string</code> | ✓ | |
|
|
| *auto_create_subnetworks* | Set to true to create an auto mode subnet, defaults to custom mode. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *delete_default_routes_on_create* | Set to true to delete the default routes at creation time. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *description* | An optional description of this resource (triggers recreation on change). | <code title="">string</code> | | <code title="">Terraform-managed.</code> |
|
|
| *iam* | Subnet IAM bindings in {REGION/NAME => {ROLE => [MEMBERS]} format. | <code title="map(map(list(string)))">map(map(list(string)))</code> | | <code title="">{}</code> |
|
|
| *log_config_defaults* | Default configuration for flow logs when enabled. | <code title="object({ aggregation_interval = string flow_sampling = number metadata = string })">object({...})</code> | | <code title="{ aggregation_interval = "INTERVAL_5_SEC" flow_sampling = 0.5 metadata = "INCLUDE_ALL_METADATA" }">...</code> |
|
|
| *log_configs* | Map keyed by subnet 'region/name' of optional configurations for flow logs when enabled. | <code title="map(map(string))">map(map(string))</code> | | <code title="">{}</code> |
|
|
| *mtu* | Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. | <code title=""></code> | | <code title="">null</code> |
|
|
| *peering_config* | VPC peering configuration. | <code title="object({ peer_vpc_self_link = string export_routes = bool import_routes = bool })">object({...})</code> | | <code title="">null</code> |
|
|
| *peering_create_remote_end* | Skip creation of peering on the remote end when using peering_config | <code title="">bool</code> | | <code title="">true</code> |
|
|
| *private_service_networking_range* | RFC1919 CIDR range used for Google services that support private service networking. | <code title="">string</code> | | <code title="null validation { condition = ( var.private_service_networking_range == null || can(cidrnetmask(var.private_service_networking_range)) ) error_message = "Specify a valid RFC1918 CIDR range for private service networking." }">...</code> |
|
|
| *routes* | Network routes, keyed by name. | <code title="map(object({ dest_range = string priority = number tags = list(string) next_hop_type = string # gateway, instance, ip, vpn_tunnel, ilb next_hop = string }))">map(object({...}))</code> | | <code title="">{}</code> |
|
|
| *routing_mode* | The network routing mode (default 'GLOBAL') | <code title="">string</code> | | <code title="GLOBAL validation { condition = var.routing_mode == "GLOBAL" || var.routing_mode == "REGIONAL" error_message = "Routing type must be GLOBAL or REGIONAL." }">...</code> |
|
|
| *shared_vpc_host* | Enable shared VPC for this project. | <code title="">bool</code> | | <code title="">false</code> |
|
|
| *shared_vpc_service_projects* | Shared VPC service projects to register with this host | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
|
| *subnet_descriptions* | Optional map of subnet descriptions, keyed by subnet 'region/name'. | <code title="map(string)">map(string)</code> | | <code title="">{}</code> |
|
|
| *subnet_flow_logs* | Optional map of boolean to control flow logs (default is disabled), keyed by subnet 'region/name'. | <code title="map(bool)">map(bool)</code> | | <code title="">{}</code> |
|
|
| *subnet_private_access* | Optional map of boolean to control private Google access (default is enabled), keyed by subnet 'region/name'. | <code title="map(bool)">map(bool)</code> | | <code title="">{}</code> |
|
|
| *subnets* | The list of subnets being created | <code title="list(object({ name = string ip_cidr_range = string name = string region = string secondary_ip_range = map(string) }))">list(object({...}))</code> | | <code title="">[]</code> |
|
|
| *vpc_create* | Create VPC. When set to false, uses a data source to reference existing VPC. | <code title="">bool</code> | | <code title="">true</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| bindings | Subnet IAM bindings. | |
|
|
| name | The name of the VPC being created. | |
|
|
| network | Network resource. | |
|
|
| project_id | Shared VPC host project id. | |
|
|
| self_link | The URI of the VPC being created. | |
|
|
| subnet_ips | Map of subnet address ranges keyed by name. | |
|
|
| subnet_regions | Map of subnet regions keyed by name. | |
|
|
| subnet_secondary_ranges | Map of subnet secondary ranges keyed by name. | |
|
|
| subnet_self_links | Map of subnet self links keyed by name. | |
|
|
| subnets | Subnet resources. | |
|
|
<!-- END TFDOC -->
|
|
|
|
The key format is `subnet_region/subnet_name`. For example `europe-west1/my_subnet`.
|