Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add lists of allowed kinds #57

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions CODEFLARE.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ priorities impacting the scheduling of jobs by other cluster queues.

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

For various reasons, workloads are not directly submitted to cluster queues but
rather to namespaced [local
Expand Down Expand Up @@ -330,3 +330,36 @@ is based solely on considering the currently admitted workloads of
just those cluster queues that are exceeding their nominal
quota. Workloads admitted by cluster queues that are currently at or
below their nominal quota will not be preempted.

## Allowed Kinds

MLBatch allows users to directly create the following Kinds of compute
resources:
+ AppWrapper
+ PyTorchJob (allowed, but recommend to put inside an AppWrapper)
+ RayJob (allowed, but recommend to put inside an AppWrapper)
+ RayCluster (allowed, but recommend to put inside an AppWrapper)

MLBatch also allows users to directly create the following Kinds of
non-compute resources:
+ Service
+ Secret
+ ConfigMap
+ PersistentVolumeClaim
+ PodGroup (allowed, but recommend to put inside an AppWrapper)

MLBatch allows users to wrap an arbitrary number of one or more of the
following Kinds inside of an AppWrapper:
+ PyTorchJob
+ RayJob
+ RayCluster
+ Deployment
+ StatefulSet
+ Pod
+ Job
+ ServiceAccount
+ Service
+ Secret
+ ConfigMap
+ PersistentVolumeClaim
+ PodGroup
dgrove-oss marked this conversation as resolved.
Show resolved Hide resolved