CNS API contracts for NUMA-Aware Pods

Author: pjohnst5

cns/api.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/Azure/azure-container-networking/cns/common"
 	"github.com/Azure/azure-container-networking/cns/types"
+	"github.com/Azure/azure-container-networking/cns/types/infiniband"
 	"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 infiniband.ErrorCode `json:"errorCode"` // Error code if applicable
+	Message   string               `json:"message"`   // Additional message or error description
+}
+
+// GetIBDeviceStatusRequest represents the request to get the InfiniBand device programming status
+// GET /ibdevices/{mac-address-of-device} - no request body needed for GET
+type GetIBDeviceStatusRequest struct {
+	MACAddress string `json:"macAddress"` // MAC address of the device (from URL path)
+}
+
+// GetIBDeviceStatusResponse represents the response containing InfiniBand device programming status
+type GetIBDeviceStatusResponse 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  infiniband.ErrorCode `json:"errorCode"`  // Error code if applicable
+	Message    string               `json:"message"`    // Additional message or error description
+}

cns/swagger.yaml

@@ -120,6 +120,78 @@ paths:
               schema:
                 $ref: "#/components/schemas/UnpublishNetworkContainerResponse"
 
+  /ibdevices/pod/{podname-podnamespace}:
+    put:
+      summary: Assigns IB devices to a pod
+      description: >-
+        Assigns the specified IB devices to the pod identified by PodID. The
+        MAC addresses of the devices are provided in the request body.
+      parameters:
+        - name: podname-podnamespace
+          in: path
+          required: true
+          description: The name and namespace of the pod
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssignIBDevicesToPodRequest"
+      responses:
+        '200':
+          description: >-
+            The request passed initial validation and CNS was able to propagate its state.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AssignIBDevicesToPodResponse"
+        '404':
+          description: >-
+            The pod specified by PodID was not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AssignIBDevicesToPodResponse"
+        '400':
+          description: >-
+            One of the IB devices specified is not available
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AssignIBDevicesToPodResponse"
+  
+  /ibdevices/{macaddress}:
+    get:
+      summary: Get status about an IB device
+      description: >-
+        Retrieves the current status of the specified IB device.
+      parameters:
+        - name: macaddress
+          in: path
+          required: true
+          description: The MAC address of the IB device (with colons ":")
+          schema:
+            type: string
+      requestBody:
+        required: false
+      responses:
+        '200':
+          description: >-
+            The request was successful and the status of the IB device is returned.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetIBDeviceStatusResponse"
+        '404':
+          description: >-
+            The IB device specified by MAC address was not found.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetIBDeviceStatusResponse"
+
 components:
   schemas:
     UnpublishNetworkContainerResponse:
@@ -351,3 +423,99 @@ components:
         Message:
           type: string
           description: The error message
+
+    ErrorCode:
+      type: integer
+      description: Pre-defined error code of what went wrong, if anything (see cns/types/infiniband/errorcodes.go)
+      oneOf:
+      - title: Success
+        const: 0
+        description: Successful operation
+      - title: PodNotFound
+        const: 1
+        description: Pod not found
+      - title: DeviceUnavailable
+        const: 2
+        description: Device is unavailable
+      - title: DeviceNotFound
+        const: 3
+        description: Device not found
+      - title: AnnotationNotFound
+        const: 4
+        description: Annotation not found on pod
+      - title: PodAlreadyAllocated
+        const: 5
+        description: Pod was already assigned IB devices (and new ones don't match)
+      - title: InternalProgrammingError
+        const: 6
+        description: Something went wrong programming the devices
+      
+    Status:
+      type: integer
+      description: Status of IB device (see cns/types/infiniband/status.go)
+      oneOf:
+      - title: ProgrammingPending
+        const: 0
+        description: Programming of device is pending
+      - title: ProgrammingFailed
+        const: 1
+        description: Programming of device failed
+      - title: ProgrammingComplete  
+        const: 2
+        description: Programming of device is complete
+      - title: ReleasePending
+        const: 3
+        description: Release of device is pending
+      - title: Available
+        const: 4
+        description: Device is available for use
+
+    AssignIBDevicesToPodRequest:
+      type: object
+      required:
+        - PodID
+        - MACAddresses
+      properties:
+        PodID:
+          type: string
+          description: podname-podnamespace of which pod to attach these devices through
+        MACAddresses:
+          type: array
+          description: MAC addresses of IB devices such as "60:45:bd:a4:b5:7a"
+          items:
+            type: string
+
+    AssignIBDevicesToPodResponse:
+      type: object
+      required:
+        - ErrorCode
+        - Message
+      properties:
+        ErrorCode:
+          $ref: "#/components/schemas/ErrorCode"
+        Message:
+          type: string
+          description: Human-readable message or error description
+
+    GetIBDeviceStatusResponse:
+      type: object
+      required:
+        - MACAddress
+        - PodID
+        - Status
+        - ErrorCode
+        - Message
+      properties:
+        MACAddress:
+          type: string
+          description: MAC address of the IB device
+        PodID:
+          type: string
+          description: podname-podnamespace of the pod to which the device is assigned, if any
+        Status:
+          $ref: "#/components/schemas/Status"
+        ErrorCode:
+          $ref: "#/components/schemas/ErrorCode"
+        Message:
+          type: string
+          description: Human-readable message or error description

cns/types/infiniband/errorcodes.go

@@ -0,0 +1,13 @@
+package infiniband
+
+type ErrorCode int
+
+const (
+	Success                  ErrorCode = 0
+	PodNotFound              ErrorCode = 1
+	DeviceUnavailable        ErrorCode = 2
+	DeviceNotFound           ErrorCode = 3
+	AnnotationNotFound       ErrorCode = 4
+	PodAlreadyAllocated      ErrorCode = 5
+	InternalProgrammingError ErrorCode = 6
+)

cns/types/infiniband/status.go

@@ -0,0 +1,11 @@
+package infiniband
+
+type Status int
+
+const (
+	ProgrammingPending  Status = 0
+	ProgrammingFailed   Status = 1
+	ProgrammingComplete Status = 2
+	ReleasePending      Status = 3
+	Available           Status = 4
+)