REST Resource: projects.locations.zones

Resource: Zone

A zone holding a set of hardware.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "state": enum (State),
  "contacts": [
    {
      object (Contact)
    }
  ],
  "ciqUri": string,
  "networkConfig": {
    object (ZoneNetworkConfig)
  },
  "globallyUniqueId": string,
  "subscriptionConfigs": [
    {
      object (SubscriptionConfig)
    }
  ],
  "provisioningState": enum (ProvisioningState),
  "skipClusterProvisioning": boolean,
  "clusterIntentRequired": boolean,
  "clusterIntentVerified": boolean,
  "aiCapable": boolean,
  "intelPccsKey": string
}
Fields
name

string

Identifier. Name of this zone. Format: projects/{project}/locations/{location}/zones/{zone}
createTime

string (Timestamp format)

Output only. Time when this zone was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time when this zone was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels associated with this zone as key value pairs. For more information about labels, see Create and manage labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Optional. Human friendly display name of this zone.
state

enum (State)

Output only. Current state for this zone.
contacts[]

object (Contact)

Required. The zone points of contact (name, email, phone). Order-dependent: the first contact in the list is the primary contact, second is secondary, etc.
ciqUri

string

Output only. Link to the Customer Intake Questionnaire (CIQ) sheet for this zone.
networkConfig

object (ZoneNetworkConfig)

Optional. Networking configuration for this zone.
globallyUniqueId

string

Output only. Globally unique identifier generated for this Edge Zone.
subscriptionConfigs[]

object (SubscriptionConfig)

Output only. Subscription configurations for this zone.
provisioningState

enum (ProvisioningState)

Output only. Provisioning state for configurations like MAC addresses.
skipClusterProvisioning

boolean

Optional. Whether to skip the cluster provisioning step during factory turnup. If true, indicates that the Kubernetes cluster will be created after the zone's hardware is installed at the customer site.
clusterIntentRequired

boolean

Output only. Indicates whether a valid cluster intent must be provided by the customer before accepting the order. If true, the order cannot be accepted until cluster intent is present. This is used to enforce early validation and prevent delays caused by missing configuration.
clusterIntentVerified

boolean

Output only. Indicates whether the provided cluster intent has been successfully verified. This flag ensures cluster intent exists before order can be accepted.
aiCapable

boolean

Output only. Indicates whether this zone is for Gemini on GDC Software cluster.
intelPccsKey

string

Optional. Intel Platform Config and Attestation Service (PCCS) key for provisioning and attesting AI accelerator hardware. Used by zones serving Gemini on GDC Software cluster.

State

Valid states for a zone.

Enums
STATE_UNSPECIFIED State of the Zone is unspecified.
ADDITIONAL_INFO_NEEDED More information is required from the customer to make progress.
INFO_COMPLETE The Zone has all necessary information to start Zone preparation.
PREPARING Google is preparing the Zone.
READY_FOR_CUSTOMER_FACTORY_TURNUP_CHECKS Factory turnup has succeeded.
CUSTOMER_FACTORY_TURNUP_CHECKS_STARTED The Zone is running factory turnup checks.
READY_FOR_PROVISIONING The Zone is ready for provisioning.
READY_FOR_SITE_TURNUP The Zone is ready for site turnup.
PROVISIONING_STARTED The Zone's provisioning has started.
PROVISIONING_FAILED The Zone's provisioning has failed.
CUSTOMER_FACTORY_TURNUP_CHECKS_FAILED The Zone failed in factory turnup checks.
ACTIVE The Zone is available to use.
CANCELLED The Zone has been cancelled.

ZoneNetworkConfig

Networking configuration for a zone.

JSON representation 
{
  "machineMgmtIpv4Range": string,
  "kubernetesNodeIpv4Range": string,
  "kubernetesControlPlaneIpv4Range": string,
  "managementIpv4Subnet": {
    object (Subnet)
  },
  "kubernetesIpv4Subnet": {
    object (Subnet)
  },
  "dnsIpv4Addresses": [
    string
  ],
  "kubernetesPrimaryVlanId": integer,
  "aiCapableIpv4Subnet": {
    object (Subnet)
  },
  "bgpConfig": {
    object (BGPConfig)
  },
  "topLevelDomain": string,
  "torSwitchType": string
}
Fields
machineMgmtIpv4Range

string

Required. An IPv4 address block for machine management. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per machine in the Zone. Should be in managementIpv4Subnet, and disjoint with other address ranges.
kubernetesNodeIpv4Range

string

Required. An IPv4 address block for kubernetes nodes. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per machine in the Zone. Should be in kubernetesIpv4Subnet, and disjoint with other address ranges.
kubernetesControlPlaneIpv4Range

string

Required. An IPv4 address block for kubernetes control plane. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per cluster in the Zone. Should be in kubernetesIpv4Subnet, and disjoint with other address ranges.
managementIpv4Subnet

object (Subnet)

Required. An IPv4 subnet for the management network.
kubernetesIpv4Subnet

object (Subnet)

Optional. An IPv4 subnet for the kubernetes network. If unspecified, the kubernetes subnet will be the same as the management subnet.
dnsIpv4Addresses[]

string

Optional. DNS nameservers. The GDC Infrastructure will resolve DNS queries via these IPs. If unspecified, Google DNS is used.
kubernetesPrimaryVlanId

integer

Optional. Kubernetes VLAN ID. By default, the kubernetes node, including the primary kubernetes network, are in the same VLAN as the machine management network. For network segmentation purposes, these can optionally be separated.
aiCapableIpv4Subnet

object (Subnet)

Optional. IPv4 subnet for a zone serving Gemini on GDC Software cluster. Last /29 subnet of provided range is reserved for DHCP.
bgpConfig

object (BGPConfig)

Optional. Border Gateway Protocol (BGP) specific configuration for this zone. Used by zones serving Gemini on GDC Software cluster.
topLevelDomain

string

Optional. Custom top level domain for this zone. Used by zones serving Gemini on GDC Software cluster.
torSwitchType

string

Optional. Additional information about customer's ToR switch type. Used by zones serving Gemini on GDC Software cluster.

Subnet

Represents a subnet.

JSON representation 
{
  "addressRange": string,
  "defaultGatewayIpAddress": string
}
Fields
addressRange

string

Required. Address range for this subnet in CIDR notation.
defaultGatewayIpAddress

string

Required. Default gateway for this subnet.

BGPConfig

Border Gateway Protocol (BGP) configuration.

JSON representation 
{
  "asn": string,
  "l3PeerIps": [
    string
  ]
}
Fields
asn

string

Required. BGP Autonomous System Number (ASN).
l3PeerIps[]

string

Required. BGP Peer-IPs. At least two L3 peer IPs are required.

ProvisioningState

Valid provisioning states for configurations like MAC addresses.

Enums
PROVISIONING_STATE_UNSPECIFIED Provisioning state is unspecified.
PROVISIONING_REQUIRED Provisioning is required. Set by Google.
PROVISIONING_IN_PROGRESS Provisioning is in progress. Set by customer.
PROVISIONING_COMPLETE Provisioning is complete. Set by customer.

Methods

create

 Creates a new zone in a given project and location.

delete

 Deletes a zone.

get

 Gets details of a zone.

list

 Lists zones in a given project and location.

patch

 Updates the parameters of a zone.

signal

 Signals the state of a zone.