Skip to content

Commit 077e046

Browse files
authored
add lists of allowed kinds (#57)
1 parent ebc12cb commit 077e046

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

CODEFLARE.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ priorities impacting the scheduling of jobs by other cluster queues.
3434

3535
Unlike MCAD, Kueue only considers quotas when admitting workloads. As a result,
3636
MLBatch must ensure that all resource-consuming workloads in user namespaces are managed
37-
by Kueue. This is accomplished by stricter controls on the Kinds of non-AppWrapper
38-
resources users are permitted to create.
37+
by Kueue. This is accomplished by strictly [limiting the Kinds](#allowed-kinds)
38+
of non-AppWrapper resources users are permitted to create.
3939

4040
For various reasons, workloads are not directly submitted to cluster queues but
4141
rather to namespaced [local
@@ -330,3 +330,36 @@ is based solely on considering the currently admitted workloads of
330330
just those cluster queues that are exceeding their nominal
331331
quota. Workloads admitted by cluster queues that are currently at or
332332
below their nominal quota will not be preempted.
333+
334+
## Allowed Kinds
335+
336+
MLBatch allows users to directly create the following Kinds of compute
337+
resources:
338+
+ AppWrapper
339+
+ PyTorchJob (allowed, but recommend to put inside an AppWrapper)
340+
+ RayJob (allowed, but recommend to put inside an AppWrapper)
341+
+ RayCluster (allowed, but recommend to put inside an AppWrapper)
342+
343+
MLBatch also allows users to directly create the following Kinds of
344+
non-compute resources:
345+
+ Service
346+
+ Secret
347+
+ ConfigMap
348+
+ PersistentVolumeClaim
349+
+ PodGroup (allowed, but recommend to put inside an AppWrapper)
350+
351+
MLBatch allows users to wrap an arbitrary number of one or more of the
352+
following Kinds inside of an AppWrapper:
353+
+ PyTorchJob
354+
+ RayJob
355+
+ RayCluster
356+
+ Deployment
357+
+ StatefulSet
358+
+ Pod
359+
+ Job
360+
+ ServiceAccount
361+
+ Service
362+
+ Secret
363+
+ ConfigMap
364+
+ PersistentVolumeClaim
365+
+ PodGroup

0 commit comments

Comments
 (0)