History

Ludovico Magnocavallo 1ac3fe4460 New tfdoc version (#396 ) * update tfdoc * rewrite check docs, refactor tfdoc replace, regenerate modules READMEs * remove dead code from check docs * do not fail on missing variable files in check docs * fix typos		2021-12-21 08:51:51 +01:00
..
README.md	New tfdoc version (#396 )	2021-12-21 08:51:51 +01:00
main.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
outputs.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
variables.tf	Add more validations to linter	2021-10-08 18:26:04 +02:00
versions.tf	Use the same versions file everywhere, pin to tf 1.0+ provider 4.0+ (#355 )	2021-11-03 15:05:43 +01:00

README.md

Google Network Peering

This module allows creation of a VPC Network Peering between two networks.

The resources created/managed by this module are:

one network peering from local network to peer network
one network peering from peer network to local network

Usage

Basic usage of this module is as follows:

module "peering" {
  source        = "./modules/net-vpc-peering"
  prefix        = "name-prefix"
  local_network = "projects/project-1/global/networks/vpc-1"
  peer_network  = "projects/project-1/global/networks/vpc-2"
}
# tftest:modules=1:resources=2

If you need to create more than one peering for the same VPC Network (A -> B, A -> C) you use a depends_on for second one to keep order of peering creation (It is not currently possible to create more than one peering connection for a VPC Network at the same time).

module "peering-a-b" {
  source        = "./modules/net-vpc-peering"
  prefix        = "name-prefix"
  local_network = "projects/project-a/global/networks/vpc-a"
  peer_network  = "projects/project-b/global/networks/vpc-b"
}

module "peering-a-c" {
  source        = "./modules/net-vpc-peering"
  prefix        = "name-prefix"
  local_network = "projects/project-a/global/networks/vpc-a"
  peer_network  = "projects/project-c/global/networks/vpc-c"
  depends_on    = [module.peering-a-b]
}
# tftest:modules=2:resources=4

Variables

name	description	type	required	default
local_network	Resource link of the network to add a peering to.	`string`	✓
peer_network	Resource link of the peer network.	`string`	✓
export_local_custom_routes	Export custom routes to peer network from local network.	`bool`		`false`
export_peer_custom_routes	Export custom routes to local network from peer network.	`bool`		`false`
peer_create_peering	Create the peering on the remote side. If false, only the peering from this network to the remote network is created.	`bool`		`true`
prefix	Name prefix for the network peerings.	`string`		`"network-peering"`

Outputs

name	description	sensitive
local_network_peering	Network peering resource.
peer_network_peering	Peer network peering resource.