Google Compute Engine Router Peer
This page shows how to write Terraform for Compute Engine Router Peer and write them securely.
google_compute_router_peer (Terraform)
The Router Peer in Compute Engine can be configured in Terraform with the resource name google_compute_router_peer
. The following sections describe 3 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "google_compute_router_peer" "gcve_router_peer1" {
name = "gcve-router-peer1"
router = google_compute_router.gcve_router.name
region = var.region
peer_ip_address = "169.254.0.2"
peer_asn = 64515
resource "google_compute_router_peer" "router1_peer1" {
name = "router1-peer1"
router = google_compute_router.router1.name
region = "us-central1"
peer_ip_address = "169.254.0.2"
peer_asn = 64515
resource "google_compute_router_peer" "router1_peer1" {
provider = "google-beta"
project = var.gcp_project_id
name = var.bgp_peer_1
router = var.cloud_router
region = var.gcp_region
Parameters
-
advertise_mode
optional - string
User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"]
-
advertised_groups
optional - list of string
User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets. 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets. * 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertiseMode is 'CUSTOM' and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
-
advertised_route_priority
optional - number
The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
Name of the interface the BGP peer is associated with.
-
ip_address
optional computed - string
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
-
management_type
optional computed - string
The resource that configures and manages this BGP peer. 'MANAGED_BY_USER' is the default value and can be managed by you or other users 'MANAGED_BY_ATTACHMENT' is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
-
name
required - string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-
peer_asn
required - number
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
-
peer_ip_address
required - string
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
-
router
required - string
The name of the Cloud Router in which this BgpPeer will be configured.
-
advertised_ip_ranges
list block-
description
optional - string
User-specified description for the IP range.
-
range
required - string
The IP range to advertise. The value must be a CIDR-formatted string.
-
-
timeouts
single block
Explanation in Terraform Registry
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. To get more information about RouterBgpPeer, see:
- API documentation
- How-to Guides
Tips: Best Practices for The Other Google Compute Engine Resources
In addition to the google_compute_disk, Google Compute Engine has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.
google_compute_disk
Ensure the encryption key for your GCE disk is stored securely
It is better to store the encryption key for your GCE disk securely. Secret Manager could be used instead.
google_compute_firewall
Ensure your VPC firewall blocks unwanted outbound traffic
It is better to block unwanted outbound traffic not to expose resources in the VPC to unwanted attacks.
google_compute_instance
Ensure appropriate service account is assigned to your GCE instance
It is better to create a custom service account for the instance and assign it.
google_compute_project_metadata
Ensure OS login for your GCE instances is enabled at project level
It is better to enable OS login for your GCE instances. Enabling OS login ensures that SSH keys used to connect to instances are mapped with IAM users, allowing centralized and automated SSH key management.
google_compute_ssl_policy
Ensure to use modern TLS protocols
It's better to adopt TLS v1.2+ instead of outdated TLS protocols.
google_compute_subnetwork
Ensure VPC flow logging is enabled
It is better to enable VPC flow logging. VPC flow logging allows us to audit traffic in your network.
Frequently asked questions
What is Google Compute Engine Router Peer?
Google Compute Engine Router Peer is a resource for Compute Engine of Google Cloud Platform. Settings can be wrote in Terraform.
Where can I find the example code for the Google Compute Engine Router Peer?
For Terraform, the PacketBeta/gcve-cloudvpn-transit-vpc, TanAlex/gcp-terraform-sample and tranquilitybase-io/tb-module-gcp-aws-vpn source code examples are useful. See the Terraform Example section for further details.