Algorithm-scheduling/openapi.yaml at main · anpulin/Algorithm-scheduling · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
openapi: 3.1.0
info:
  title: Compute Tide Frontend Integration API
  version: 0.1.0
  description: |
    Draft API contract for the Compute Tide frontend.
    The frontend supports mock mode and remote API mode.
servers:
  - url: /api/compute-tide
paths:
  /bootstrap:
    get:
      summary: Load full frontend bootstrap snapshot
      operationId: getBootstrap
      responses:
        "200":
          description: Bootstrap snapshot
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BootstrapEnvelope"
  /reservations:
    post:
      summary: Create a reservation
      operationId: createReservation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateReservationRequest"
      responses:
        "200":
          description: Reservation created and latest snapshot returned
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReservationMutationResponse"
  /reservations/{reservationId}/lifecycle:
    post:
      summary: Update reservation lifecycle
      operationId: updateReservationLifecycle
      parameters:
        - name: reservationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ReservationLifecycleRequest"
      responses:
        "200":
          description: Lifecycle updated and latest snapshot returned
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReservationMutationResponse"
  /nodes/{nodeId}/migrate:
    post:
      summary: Migrate node to another pool
      operationId: migrateNode
      parameters:
        - name: nodeId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NodeMigrationRequest"
      responses:
        "200":
          description: Node migrated and latest snapshot returned
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NodeMutationResponse"
components:
  schemas:
    BootstrapEnvelope:
      type: object
      properties:
        snapshot:
          $ref: "#/components/schemas/BootstrapSnapshot"
        data:
          $ref: "#/components/schemas/BootstrapSnapshot"
        pools:
          type: array
          items:
            $ref: "#/components/schemas/Pool"
        reservations:
          type: array
          items:
            $ref: "#/components/schemas/Reservation"
        tasks:
          type: array
          items:
            $ref: "#/components/schemas/Task"
        nodes:
          type: array
          items:
            $ref: "#/components/schemas/Node"
        policies:
          type: array
          items:
            $ref: "#/components/schemas/Policy"
        scheduleReservations:
          type: array
          items:
            $ref: "#/components/schemas/ScheduleReservation"
    BootstrapSnapshot:
      type: object
      required:
        - pools
        - reservations
        - tasks
        - nodes
        - policies
        - scheduleReservations
      properties:
        pools:
          type: array
          items:
            $ref: "#/components/schemas/Pool"
        reservations:
          type: array
          items:
            $ref: "#/components/schemas/Reservation"
        tasks:
          type: array
          items:
            $ref: "#/components/schemas/Task"
        nodes:
          type: array
          items:
            $ref: "#/components/schemas/Node"
        policies:
          type: array
          items:
            $ref: "#/components/schemas/Policy"
        scheduleReservations:
          type: array
          items:
            $ref: "#/components/schemas/ScheduleReservation"
    Pool:
      type: object
      required:
        - id
        - name
        - totalGpu
        - usedGpu
        - reservedToday
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        nodes:
          type: integer
        totalGpu:
          type: integer
        usedGpu:
          type: integer
        reservedToday:
          type: integer
        cpu:
          type: integer
        memory:
          type: integer
        taint:
          type: string
        status:
          type: string
    Reservation:
      type: object
      required:
        - id
        - project
        - applicant
        - pool
        - gpu
        - start
        - end
        - status
        - fulfillment
      properties:
        id:
          type: string
        project:
          type: string
        applicant:
          type: string
        pool:
          type: string
        gpu:
          type: integer
        start:
          type: string
        end:
          type: string
        status:
          type: string
          enum: [approved, pending, rejected]
        fulfillment:
          type: string
    Task:
      type: object
      required:
        - name
        - project
        - reservationId
        - pool
        - gpu
        - status
      properties:
        name:
          type: string
        project:
          type: string
        reservationId:
          type: string
        pool:
          type: string
        gpu:
          type: integer
        status:
          type: string
        start:
          type: string
    Node:
      type: object
      required:
        - id
        - name
        - pool
      properties:
        id:
          type: string
        name:
          type: string
        pool:
          type: string
        gpuModel:
          type: string
        totalGpu:
          type: integer
        usedGpu:
          type: integer
        runningTasks:
          type: integer
        labels:
          type: string
        taints:
          type: string
    Policy:
      type: object
      required:
        - name
        - pool
        - enabled
      properties:
        name:
          type: string
        pool:
          type: string
        label:
          type: string
        taint:
          type: string
        effect:
          type: string
        enabled:
          type: boolean
    ScheduleReservation:
      type: object
      required:
        - reservationId
        - pool
        - start
        - end
        - gpuStart
        - gpuCount
        - statusKey
      properties:
        reservationId:
          type: string
        pool:
          type: string
        start:
          type: string
        end:
          type: string
        gpuStart:
          type: integer
        gpuCount:
          type: integer
        statusKey:
          type: string
          enum: [approved, pending, running, ended, conflict]
    CreateReservationRequest:
      type: object
      required:
        - applicant
        - department
        - project
        - taskType
        - poolId
        - gpuCount
        - cpuCount
        - memoryGb
        - nodeCount
        - startAt
        - endAt
      properties:
        applicant:
          type: string
        department:
          type: string
        project:
          type: string
        taskType:
          type: string
        poolId:
          type: string
        gpuCount:
          type: integer
        cpuCount:
          type: integer
        memoryGb:
          type: integer
        nodeCount:
          type: integer
        startAt:
          type: string
          format: date-time
        endAt:
          type: string
          format: date-time
        purpose:
          type: string
    ReservationLifecycleRequest:
      type: object
      required:
        - action
      properties:
        action:
          type: string
          enum: [approve, running, ended, conflict, reject]
    NodeMigrationRequest:
      type: object
      required:
        - targetPool
      properties:
        targetPool:
          type: string
    ReservationMutationResponse:
      type: object
      properties:
        reservationId:
          type: string
        snapshot:
          $ref: "#/components/schemas/BootstrapSnapshot"
    NodeMutationResponse:
      type: object
      properties:
        snapshot:
          $ref: "#/components/schemas/BootstrapSnapshot"