fairshare-simulator

Fairshare Simulator

This is a simple HTTP server that simulates the fair share resource division algorithm used in the KAI Scheduler's proportion plugin.

Building and Running

Build the simulator:

go build .

Run it:

./fairshare-simulator -port=8080

The port is configurable with the -port flag and defaults to 8080.

Usage

Send a POST request to /simulate with a JSON body containing the simulation parameters.

Example Request

POST /simulate HTTP/1.1
Content-Type: application/json

{
    "totalResource": {
      "GPU": 100,
      "CPU": 16000,
      "Memory": 32000000
    },
    "queues": [
      {
        "uid": "queue1",
        "name": "test-queue",
        "priority": 0,
        "resourceShare": {
          "gpu": {
            "deserved": 10,
            "request": 100,
            "overQuotaWeight": 3
          }
        }
      },
      {
        "uid": "queue2",
        "name": "test-queue2",
        "priority": 0,
        "resourceShare": {
          "gpu": {
            "deserved": 10,
            "request": 100,
            "overQuotaWeight": 1
          }
        }
      }
    ]
}

Response

The response is a JSON object with fair share values for each queue:

{
  "queue1": {
    "gpu": 70,
    "cpu": 16000,
    "memory": 100000
  },
  "queue2": {
    "gpu": 30,
    "cpu": 16000,
    "memory": 100000
  }
}

(Note: Actual values depend on the input parameters and the simulation logic.)

This simulator uses the SetResourcesShare function from the proportion plugin to compute the fair shares.