CNS API contracts for NUMA-Aware Pods

Author: pjohnst5

cns/api.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/Azure/azure-container-networking/cns/common"
+	"github.com/Azure/azure-container-networking/cns/infiniband"
 	"github.com/Azure/azure-container-networking/cns/types"
 	"github.com/Azure/azure-container-networking/crd/nodenetworkconfig/api/v1alpha"
 	"github.com/pkg/errors"
@@ -32,6 +33,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 +386,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
+	MACAddresses []string `json:"macAddresses"` // 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 {
+	ErrorCode types.ResponseCode `json:"errorCode"` // Error code if applicable
+	Msg       string             `json:"msg"`       // Additional message or error description
+}
+
+// GetIBDeviceInfoRequest represents the request to get InfiniBand device information
+// GET /ibdevices/{mac-address-of-device} - no request body needed for GET
+type GetIBDeviceInfoRequest struct {
+	MACAddress string `json:"macAddress"` // MAC address of the device (from URL path)
+}
+
+// GetIBDeviceInfoResponse represents the response containing InfiniBand device information
+type GetIBDeviceInfoResponse struct {
+	MACAddress string             `json:"macAddress"` // MAC address of the device
+	PodID      string             `json:"podID"`      // Pod that the device is assigned to
+	Status     infiniband.Status  `json:"status"`     // Device status (e.g., "pendingProgramming", "error", "programmed", "pendingDeletion", "available")
+	ErrorCode  types.ResponseCode `json:"errorCode"`  // Error code if applicable
+	Msg        string             `json:"msg"`        // Additional message or error description
+}

cns/grpc/cns.go

@@ -26,3 +26,33 @@ func (s *CNS) GetNodeInfo(_ context.Context, req *pb.NodeInfoRequest) (*pb.NodeI
 	// todo: Implement the logic
 	return &pb.NodeInfoResponse{}, nil
 }
+
+// AssignIBDevicesToPod assigns InfiniBand devices to a pod via gRPC.
+func (s *CNS) AssignIBDevicesToPod(_ context.Context, req *pb.AssignIBDevicesToPodRequest) (*pb.AssignIBDevicesToPodResponse, error) {
+	s.Logger.Info("AssignIBDevicesToPod called",
+		zap.String("podID", req.GetPodID()),
+		zap.Strings("deviceIDs", req.GetDeviceIds()))
+
+	// TODO: Implement the actual logic by calling the IBDeviceManager
+	// For now, return a success response
+	return &pb.AssignIBDevicesToPodResponse{
+		ErrorCode: 0,
+		Message:   "InfiniBand devices assigned successfully",
+	}, nil
+}
+
+// GetIBDeviceInfo retrieves information about a specific InfiniBand device via gRPC.
+func (s *CNS) GetIBDeviceInfo(_ context.Context, req *pb.GetIBDeviceInfoRequest) (*pb.GetIBDeviceInfoResponse, error) {
+	s.Logger.Info("GetIBDeviceInfo called",
+		zap.String("deviceID", req.GetDeviceID()))
+
+	// TODO: Implement the actual logic by calling the IBDeviceManager
+	// For now, return a placeholder response
+	return &pb.GetIBDeviceInfoResponse{
+		DeviceID:  req.GetDeviceID(),
+		PodID:     "",
+		Status:    "Available",
+		ErrorCode: 0,
+		Msg:       "Device information retrieved successfully",
+	}, nil
+}

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 errorCode = 1; // Error 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.
+}