This page describes how to manage Google Distributed Cloud connected zone resources in a Distributed Cloud connected deployment. Due to the structuring of Google Cloud APIs, Distributed Cloud connected zone resources are referred to as locations in the Distributed Cloud Edge Container API.
For more information about Distributed Cloud connected zones, see How Distributed Cloud connected works.
List zones
To list the Distributed Cloud connected zone in your Google Cloud project, complete the steps in this section.
To complete this task, you must have the
Edge Container Viewer role
(roles/edgecontainer.viewer
) in your Google Cloud project.
Console
In the Google Cloud console, go to the Edge Zones page.
Examine the list of zones and their details.
gcloud
Use the gcloud edge-cloud container zones list
command:
gcloud edge-cloud container zones list \ --project=PROJECT_ID
Replace PROJECT_ID
with the ID of the target
Google Cloud project.
API
Make a GET
request to the projects.locations.list
method:
GET /v1/PROJECT_ID/locations?filter=FILTER&pageSize=PAGE_SIZE&orderBy=SORT_BY&pageToken=PAGE_TOKEN
Replace the following:
PROJECT_ID
: the ID of the target Google Cloud project.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 thenextPageToken
field in the response. Send this token to receive a page of results.
Initialize the network configuration of a zone
To initialize the network configuration of a Distributed Cloud connected zone, complete the steps in this section.
Before you can initialize the network configuration of a zone, you must first enable the Distributed Cloud Edge Network API.
To complete this task, you must have the
Edge Network Admin role
(roles/edgenetwork.admin
) in your Google Cloud project.
You must initialize the network configuration of each of your Distributed Cloud connected zones in the following cases:
- Immediately after your Distributed Cloud connected hardware is installed on your premises.
- You upgraded to Distributed Cloud connected version 1.3.0 on an existing Distributed Cloud connected deployment but did not participate in the private preview of the Distributed Cloud Edge Network API.
Initializing the network configuration of a zone creates a default router named
default
. The default
router is then configured to peer with all of the
interconnects that you requested when you ordered the
Distributed Cloud connected hardware by creating corresponding
interconnect attachments. This provides your
Distributed Cloud connected deployment with basic uplink connectivity
to your local network.
This is a run-once procedure. Subsequent runs do not alter your existing Distributed Cloud networking settings.
gcloud
Use the gcloud edge-cloud networking zones init
command:
gcloud edge-cloud networking zones init ZONE_NAME \ --project=PROJECT_ID \ --location=REGION
Replace the following:
ZONE_NAME
: the name of the target Distributed Cloud connected zone.PROJECT_ID
: the ID of the target Google Cloud project.REGION
: the Google Cloud region in which the target Distributed Cloud connected zone is created.
API
Make a POST
request to the projects.locations.zones.initialize
method:
POST /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME:init
Replace the following:
PROJECT_ID
: the ID of the target Google Cloud project.REGION
: the Google Cloud region in which the target Distributed Cloud connected zone is created.ZONE_NAME
: the name of the target Distributed Cloud connected zone.
Get information about a zone
To get information about a Distributed Cloud connected zone, complete the steps in this section.
To complete this task, you must have the
Edge Container Viewer role
(roles/edgecontainer.viewer
) in your Google Cloud project.
Console
In the Google Cloud console, go to the Edge Zones page.
Click the desired zone.
The Google Cloud console displays detailed information about the selected zone.
gcloud
Use the gcloud edge-cloud container zones describe
command:
gcloud edge-cloud container zones describe ZONE_NAME \ --project=PROJECT_ID
Replace the following:
ZONE_NAME
: the name of the target Distributed Cloud connected zone.PROJECT_ID
: the ID of the target Google Cloud project.
API
Make a GET
request to the projects.locations.get
method:
GET /v1/PROJECT_ID/locations/REGION
Replace the following:
PROJECT_ID
: the ID of the target Google Cloud project.REGION
: the Google Cloud region in which the target Distributed Cloud connected zone is created.
What's next
- Deploy workloads on Google Distributed Cloud connected
- Manage machines
- Create and manage clusters
- Create and manage networks
- Create and manage node pools