IP Address Management API overview

The IP Address Management (IPAM) API uses Kubernetes custom resources and relies on the Kubernetes Resource Model (KRM). It manages IP address allocation across a Google Distributed Cloud (GDC) air-gapped deployment.

To use the IPAM API, we recommend that you use the gdcloud CLI, or call the API directly using the kubectl CLI. If your application needs to use your own libraries to call this API, use the following examples and the full API definitions to build your requests:

• ipam.gdc.goog
• ipam.global.gdc.goog

Service endpoint and discovery document

The IPAM APIs are provided in two packages depending on zonal deployment or global deployment.

The API endpoints for the zonal and global IPAM APIs are the following, respectively:

• https:// MANAGEMENT_API_SERVER_ENDPOINT /apis/ipam.gdc.goog/v1
• https:// MANAGEMENT_API_SERVER_ENDPOINT /apis/ipam.global.gdc.goog/v1

The MANAGEMENT_API_SERVER_ENDPOINT variable is the endpoint of the Management API server.

Using the kubectl proxy command, you can access that URL in your browser or with a tool such as curl to get the discovery document for the IPAM API. The kubectl proxy command opens up a proxy to the Kubernetes API server on your local machine. After that command is running, you can access the document at the following URLs:

• http://127.0.0.1:8001/apis/ipam.gdc.goog/v1
• http://127.0.0.1:8001/apis/ipam.global.gdc.goog/v1

Example custom resources

The following is an example of a zonal Subnet object:

  apiVersion 
 : 
  
 ipam.gdc.goog/v1 
 kind 
 : 
  
 Subnet 
 metadata 
 : 
  
 labels 
 : 
  
 ipam.gdc.goog/overlay-network-type 
 : 
  
 External 
  
 ipam.gdc.goog/category-type 
 : 
  
 ExternalOverlayNetwork 
  
 name 
 : 
  
 test-subnet 
  
 namespace 
 : 
  
 root 
 spec 
 : 
  
 type 
 : 
  
 Root 
  
 ipv4Request 
 : 
  
 cidr 
 : 
  
 10.0.0.0/16 
  
 networkSpec 
 : 
  
 staticVLANID 
 : 
  
 100 
  
 enableVLANID 
 : 
  
 true 
  
 enableGateway 
 : 
  
 true 
 

The following is an example of a global Subnet object for a default VPC root CIDR:

  apiVersion 
 : 
  
 ipam.global.gdc.goog/v1 
 kind 
 : 
  
 Subnet 
 metadata 
 : 
  
 labels 
 : 
  
 ipam.gdc.goog/vpc 
 : 
  
 default-vpc 
  
 ipam.gdc.goog/usage 
 : 
  
 network-root-range 
  
 name 
 : 
  
 default-vpc-root-cidr 
  
 namespace 
 : 
  
 platform 
 spec 
 : 
  
 ipv4Request 
 : 
  
 cidr 
 : 
  
 10.200.0.0/23 
  
 type 
 : 
  
 Root