CNS API contracts for NUMA-Aware Pods

Author: pjohnst5

cns/api.go

@@ -32,6 +32,9 @@ const (
 	V1Prefix                      = "/v0.1"
 	V2Prefix                      = "/v0.2"
 	EndpointPath                  = "/network/endpoints/"
+	// IBDevice API paths
+	IBDevicesPodPath = "/ibdevices/pod/" // PUT /ibdevices/pod/{podname-podnamespace}
+	IBDevicesPath    = "/ibdevices/"     // GET /ibdevices/{mac-address-of-device}
 	// Service Fabric SWIFTV2 mode
 	StandaloneSWIFTV2 SWIFTV2Mode = "StandaloneSWIFTV2"
 	// K8s SWIFTV2 mode
@@ -382,3 +385,33 @@ type GetVMUniqueIDResponse struct {
 	Response   Response `json:"response"`
 	VMUniqueID string   `json:"vmuniqueid"`
 }
+
+// IBDevice API Contracts
+
+// AssignIBDevicesToPodRequest represents the request to assign InfiniBand devices to a pod
+// PUT /ibdevices/pod/{podname-podnamespace}
+type AssignIBDevicesToPodRequest struct {
+	PodID     string   `json:"podID"`     // podname-podnamespace format
+	DeviceIDs []string `json:"deviceIds"` // Array of MAC addresses like ["60:45:bd:a4:b5:7a", "7c:1e:52:07:11:36"]
+}
+
+// AssignIBDevicesToPodResponse represents the response for assigning InfiniBand devices to a pod
+type AssignIBDevicesToPodResponse struct {
+	Response Response `json:"response"` // Contains cnsCode (int) and message (string)
+}
+
+// GetIBDeviceInfoRequest represents the request to get InfiniBand device information
+// GET /ibdevices/{mac-address-of-device} - no request body needed for GET
+type GetIBDeviceInfoRequest struct {
+	DeviceID string `json:"deviceID"` // MAC address of the device (from URL path)
+}
+
+// GetIBDeviceInfoResponse represents the response containing InfiniBand device information
+type GetIBDeviceInfoResponse struct {
+	Response  Response `json:"response,omitempty"` // Standard CNS response (optional for success cases)
+	DeviceID  string   `json:"deviceID"`           // MAC address of the device
+	PodID     string   `json:"podID"`              // Pod that the device is assigned to
+	Status    string   `json:"status"`             // Device status (e.g., "assigned", "available")
+	ErrorCode int      `json:"errorCode"`          // Error code if applicable
+	Msg       string   `json:"msg"`                // Additional message or error description
+}

cns/grpc/proto/server.proto

@@ -15,6 +15,12 @@ service CNS {
   // Retrieves detailed information about a specific node.
   // Primarily used for health checks.
   rpc GetNodeInfo(NodeInfoRequest) returns (NodeInfoResponse);
+
+  // Assigns InfiniBand devices to a pod.
+  rpc AssignIBDevicesToPod(AssignIBDevicesToPodRequest) returns (AssignIBDevicesToPodResponse);
+
+  // Retrieves information about a specific InfiniBand device.
+  rpc GetIBDeviceInfo(GetIBDeviceInfoRequest) returns (GetIBDeviceInfoResponse);
 }
 
 // SetOrchestratorInfoRequest is the request message for setting the orchestrator information.
@@ -41,3 +47,29 @@ message NodeInfoResponse {
   string status = 5; // The current status of the node (e.g., running, stopped).
   string message = 6; // Additional information about the node's health or status.
 }
+
+// AssignIBDevicesToPodRequest is the request message for assigning InfiniBand devices to a pod.
+message AssignIBDevicesToPodRequest {
+  string podID = 1; // The pod ID in format podname-podnamespace.
+  repeated string deviceIds = 2; // List of device MAC addresses.
+}
+
+// AssignIBDevicesToPodResponse is the response message for assigning InfiniBand devices to a pod.
+message AssignIBDevicesToPodResponse {
+  int32 cnsCode = 1; // CNS response code (0 for success).
+  string message = 2; // Response message.
+}
+
+// GetIBDeviceInfoRequest is the request message for retrieving InfiniBand device information.
+message GetIBDeviceInfoRequest {
+  string deviceID = 1; // The device ID (MAC address).
+}
+
+// GetIBDeviceInfoResponse is the response message containing InfiniBand device information.
+message GetIBDeviceInfoResponse {
+  string deviceID = 1; // The device ID (MAC address).
+  string podID = 2; // The pod ID that the device is assigned to.
+  string status = 3; // The status of the device.
+  int32 errorCode = 4; // Error code if applicable.
+  string msg = 5; // Additional message or error description.
+}