Create and manage routers

This page describes how to create and manage Google Distributed Cloud connected router resources in a Distributed Cloud zone.

This functionality is only available on Distributed Cloud connected racks. Distributed Cloud connected servers don't support router resources.

For more information about Distributed Cloud routers, see How Distributed Cloud connected works.

Keep the following in mind:

• You can create one router per Distributed Cloud network.

• We recommend that you create a router along with its corresponding interconnect attachment at the same time. For more information about creating an interconnect attachment, see Create an interconnect attachment.

Create a router

To create a Distributed Cloud router, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers create ROUTER_NAME \
    --network=NETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME \
    --asn=ASN

POST /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/routers?routerId=ROUTER_ID
{
 "labels": { LABELS,
  },
 "network": { NETWORK_NAME,
  },
 "asn": { ASN,
  },      
}

Establish a BGP peering session on a router

A router allows you to establish the following types of Border Gateway Protocol (BGP) peering sessions:

• A northbound peering session with an interconnect attachment
• A southbound peering session with a subnetwork
• A loopback peering session with a network

A BGP peering session is established by adding an interface to the router for the Distributed Cloud network component that corresponds to the type of peering session.

Establish a northbound peering session

To establish a northbound peering session on a router with an interconnect attachment, complete the steps in this section. The target interconnect attachment must be associated with the target router.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers add-interface ROUTER_NAME \
    --interface-name=INTERFACE_NAME \
    --interconnect-attachment=ATTACHMENT_NAME \
    --ip-address=INTERCONNECT_ADDRESS \
    --ip-mask-length=IP_MASK_LENGTH \
    --location=REGION \
    --zone=ZONE_NAME

Establish a southbound peering session

To establish a southbound peering session on a router with a subnetwork, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers add-interface ROUTER_NAME \
    --interface-name=INTERFACE_NAME \
    --subnet=SUBNETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Establish a loopback peering session

To establish a loopback peering session on a router with a network, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers add-interface ROUTER_NAME \
    --interface-name=INTERFACE_NAME \
    --loopback-ip-addresses=LOOPBACK_ADDRESSES \
    --location=REGION \
    --zone=ZONE_NAME

Terminate a BGP peering session

To terminate a BGP peering session between a router and an interconnect attachment, a subnetwork, or a network, you must delete the interface for that network component from the target router. To delete the interface, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers remove-interface ROUTER_NAME \
    --interface-name=INTERFACE_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Configure peers in a BGP peering session

You can add and remove BGP peers in a BGP peering session that's established between a router and an interconnect attachment, a subnetwork, or a network. When you add a peer to a BGP peering session, Bidirectional Forwarding Detection (BFD) is automatically enabled on the target router with a 100-ms interval, 100-ms minimum receive window, and a multiplier of 3.

After you add a peer to the target BGP peering session, you can then assign the peer IP address to the Pod that runs your workload. To find the peer IP address, complete the steps in Get information about a router.

Add a peer to a BGP peering session

To add a peer to a BGP peering session, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers add-bgp-peer ROUTER_NAME \
    --peer-name=PEER_NAME> \
    --peer-asn=PEER_ASN \
    --peer-ipv4-range=PEER_IPv4_RANGE \
    --peer-ipv6-range=PEER_IPv6_RANGE \        
    --interface=INTERFACE_NAME \                                                       \
    --location=REGION \
    --zone=ZONE_NAME

Remove a peer from a BGP peering session

To remove a peer from a BGP peering session, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers remove-bgp-peer ROUTER_NAME \
    --peer-name=PEER_NAME> \
    --location=REGION \
    --zone=ZONE_NAME

List routers

To list the routers provisioned within a Distributed Cloud connected zone, complete the steps in this section.

To complete this task, you must have the Edge Network Viewer role (roles/edgenetwork.viewer) in your Google Cloud project.

gcloud edge-cloud networking routers list \
    --location=REGION \
    --zone=ZONE_NAME

 GET /v1/PROJECT_ID/locations/REGION/zones/ZONE_NAME/routers?filter=FILTER&pageSize=PAGE_SIZE&orderBy=SORT_BY&pageToken=PAGE_TOKEN

Get information about a router

To get information about a Distributed Cloud router, complete the steps in this section.

To complete this task, you must have the Edge Network Viewer role (roles/edgenetwork.viewer) in your Google Cloud project.

gcloud edge-cloud networking routers describe ROUTER_NAME \
    --location=REGION \
    --zone=ZONE_NAME

GET /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/routers/ROUTER_ID

This operation returns detailed information about the resource, including its provisioning state:

• PENDING: the resource has not yet begun provisioning and has not yet been propagated throughout the zone.
• PROVISIONING: the resource is being provisioned; you must wait until it has been propagated throughout the zone.
• RUNNING: the resource has been successfully provisioned and propagated throughout the zone; it is ready to use.
• FAILED: the provisioning of the resource was not successful; the resource has not been propagated throughout the zone.

Check the operational status of a router

To check the operational status of a Distributed Cloud router, complete the steps in this section.

To complete this task, you must have the Edge Network Viewer role (roles/edgenetwork.viewer) in your Google Cloud project.

gcloud edge-cloud networking routers get-status ROUTER_NAME \
    --location=REGION \
    --zone=ZONE_NAME

 GET /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/routers/ROUTER_ID:diagnose

Delete a router

To delete a Distributed Cloud router, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud edge-cloud networking routers delete ROUTER_NAME \
    --location=REGION \
    --zone=ZONE_NAME

 DELETE /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/routers/ROUTER_ID

What's next

• Deploy workloads on Google Distributed Cloud connected
• Manage interconnects
• Create and manage interconnect attachments
• Create and manage networks
• Create and manage subnetworks
• Create and manage VPN connections
• Manage zones