CNS API contracts for NUMA-Aware Pods

[pjohnst5]

CNS IBDevice API Contracts

Overview

Two new APIs for managing InfiniBand (IB) devices in Azure Container Network Service (CNS):

1. PUT IB Devices for Pod - PUT IB devices for a pod
2. GET IB Device Info - GET IB device status

---

API 1: PUT IB Devices for Pod

Endpoint

PUT /ibdevices/pod/{podname-podnamespace}

Request Body

{
  "podID": "my-pod-my-namespace",
  "macAddresses": ["60:45:bd:a4:b5:7a", "7c:1e:52:07:11:36"]
}

Success Response

{
  "errorCode": 0,
  "message": "Successfully assigned 2 devices to pod my-pod-my-namespace"
}

Error Response

{
  "errorCode": 2,
  "message": "Device 60:45:bd:a4:b5:7a is already assigned to another pod"
}

See errorCodes.go in this PR for full list of error codes.

---

API 2: GET IB Device Information

Endpoint

GET /ibdevices/{mac-address-of-device}

Request

No request body (MAC address provided in URL path)

Success Response

{
  "macAddress": "60:45:bd:a4:b5:7a",
  "podID": "my-pod-my-namespace", 
  "status": "programmed",
  "errorCode": 0,
  "message": ""
}

Device Not Found Response

{
  "deviceID": "60:45:bd:a4:b5:7a",
  "podID": "",
  "status": "",
  "errorCode": 3,
  "message": "Device not found"
}

See status.go in this PR for list of all statuses of an IB device

---

Request body

See api.go for the structs

• AssignIBDevicesToPodRequest
• AssignIBDevicesToPodResponse
• GetIBDeviceInfoRequest
• GetIBDeviceInfoResponse

---