Create and manage networks

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

For more information about Distributed Cloud Edge networks, see How Distributed Cloud Edge works.

Keep the following in mind:

  • You can create up to 20 networks per Distributed Cloud Edge zone.
  • A network is a virtual private network instantiated within the target zone.
  • The network is instantiated as a Virtual Routing Function (VRF).
  • Packets are routed independently inside a network.

Create a network

To create a Distributed Cloud Edge 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

Use the gcloud edge-cloud networking networks create command:

gcloud edge-cloud networking networks create NETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME \
    --mtu=MTU_SIZE

Replace the following:

  • NETWORK_NAME: a descriptive name that uniquely identifies this network.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • MTU_SIZE: the maximum transmission unit (MTU) size for this network. Valid values are 1500 and 9000. This value must match the MTU size of the default network and be the same for all networks.

API

Make a POST request to the projects.locations.zones.networks.create method:

POST /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/networks?networkId=NETWORK_ID
{
 "labels": { LABELS,
  },
 "mtu": { MTU_SIZE,
  },
}

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • NETWORK_ID: a unique ID that identifies this network.
  • LABELS: a list of labels to apply to this network resource.
  • MTU_SIZE: the maximum transmission unit (MTU) size for this network. Valid values are 1500 and 9000.

List networks

To list Distributed Cloud Edge networks provisioned within a Distributed Cloud Edge 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

Use the gcloud edge-cloud networking networks list command:

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

Replace the following:

  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a GET request to the projects.locations.zones.networks.list method:

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

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • FILTER: an expression that constrains the returned results to specific values.
  • PAGE_SIZE: the number of results to return per page.
  • SORT_BY: a comma-delimited list of field names by which the returned results are sorted. The default sort order is ascending; for descending sort order, prefix the desired field with ~.
  • PAGE_TOKEN: a token received in the response to the last list request in the nextPageToken field in the response. Send this token to receive a page of results.

Get information about a network

To get information about a Distributed Cloud Edge network, 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

Use the gcloud edge-cloud networking networks describe command:

gcloud edge-cloud networking networks describe NETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Replace the following:

  • NETWORK_NAME: the name of the target network.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a GET request to the projects.locations.zones.networks.get method:

GET /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/networks/NETWORK_ID

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • NETWORK_ID: the ID of the target network.

Check the operational status of a network

To check the operational status of a Distributed Cloud Edge network, 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

Use the gcloud edge-cloud networking networks get-status command:

gcloud edge-cloud networking networks get-status NETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Replace the following:

  • NETWORK_NAME: the name of the target network.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a GET request to the projects.locations.zones.networks.diagnose method:

 GET /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/networks/NETWORK_ID:diagnose

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • NETWORK_ID: the ID of the target network.

Delete a network

To delete a Distributed Cloud Edge 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

Use the gcloud edge-cloud networking networks delete command:

gcloud edge-cloud networking networks delete NETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Replace the following:

  • NETWORK_NAME: the name of the target network.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a DELETE request to the projects.locations.zones.networks.delete method:

 DELETE /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/networks/NETWORK_ID

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • NETWORK_ID: the ID of the target network.

What's next