sakkara install instructions

Author: dgrove-oss

setup.RHOAI-v2.13/CLUSTER-SETUP.md

@@ -1,6 +1,6 @@
 # Cluster Setup
 
-The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
 cluster roles, and priority classes.
 
 ## Priorities
@@ -10,7 +10,14 @@ Create `default-priority`, `high-priority`, and `low-priority` priority classes:
 oc apply -f setup.RHOAI-v2.13/mlbatch-priorities.yaml
 ```
 
-## Coscheduler
+## Scheduler Plugins
+
+MLBatch utilizes Kubernetes Scheduler Plugins to ensure gang scheduling of
+multi-Pod workloads and to pack `Pods` onto `Nodes` to reduce GPU fragmentation.
+Two options are described below: Coscheduler and Sakkara. You should pick and install one of them
+as a secondary scheduler for your cluster.
+
+### Coscheduler
 
 Install Coscheduler v0.28.9 as a secondary scheduler and configure packing:
 ```sh
@@ -24,6 +31,17 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
 oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.13/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
 ```
 
+### Sakkara
+
+[Sakkara](https://github.com/atantawi/scheduler-plugins/tree/sakkara) is an experimental
+new scheduler plugin with advanced support for topology-aware scheduling.
+
+Install Sakkara as a secondary scheduler:
+```sh
+helm install sakkara-scheduler --namespace sakkara-scheduler --create-namespace mlbatch/sakkara-scheduler
+```
+Optionally, create a config map capturing your cluster's topology as described in the [Sakkara documentation](https://github.com/atantawi/sakkara-deploy/tree/main?tab=readme-ov-file#cluster-topology). This step is optional but recommended for production clusters. If the config map is not present Sakkara will default to a single-level hierarchy containing the Nodes of the cluster.
+
 ## Red Hat OpenShift AI
 
 Create the Red Hat OpenShift AI subscription:

setup.RHOAI-v2.16/CLUSTER-SETUP.md

@@ -1,6 +1,6 @@
 # Cluster Setup
 
-The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
 cluster roles, and priority classes.
 
 ## Priorities
@@ -10,7 +10,14 @@ Create `default-priority`, `high-priority`, and `low-priority` priority classes:
 oc apply -f setup.RHOAI-v2.16/mlbatch-priorities.yaml
 ```
 
-## Coscheduler
+## Scheduler Plugins
+
+MLBatch utilizes Kubernetes Scheduler Plugins to ensure gang scheduling of
+multi-Pod workloads and to pack `Pods` onto `Nodes` to reduce GPU fragmentation.
+Two options are described below: Coscheduler and Sakkara. You should pick and install one of them
+as a secondary scheduler for your cluster.
+
+### Coscheduler
 
 Install Coscheduler v0.28.9 as a secondary scheduler and configure packing:
 ```sh
@@ -24,6 +31,17 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
 oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.16/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
 ```
 
+### Sakkara
+
+[Sakkara](https://github.com/atantawi/scheduler-plugins/tree/sakkara) is an experimental
+new scheduler plugin with advanced support for topology-aware scheduling.
+
+Install Sakkara as a secondary scheduler:
+```sh
+helm install sakkara-scheduler --namespace sakkara-scheduler --create-namespace mlbatch/sakkara-scheduler
+```
+Optionally, create a config map capturing your cluster's topology as described in the [Sakkara documentation](https://github.com/atantawi/sakkara-deploy/tree/main?tab=readme-ov-file#cluster-topology). This step is optional but recommended for production clusters. If the config map is not present Sakkara will default to a single-level hierarchy containing the Nodes of the cluster.
+
 ## Red Hat OpenShift AI
 
 Create the Red Hat OpenShift AI subscription:

setup.RHOAI-v2.17/CLUSTER-SETUP.md

@@ -1,6 +1,6 @@
 # Cluster Setup
 
-The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
 cluster roles, and priority classes.
 
 ## Priorities
@@ -10,7 +10,14 @@ Create `default-priority`, `high-priority`, and `low-priority` priority classes:
 oc apply -f setup.RHOAI-v2.17/mlbatch-priorities.yaml
 ```
 
-## Coscheduler
+## Scheduler Plugins
+
+MLBatch utilizes Kubernetes Scheduler Plugins to ensure gang scheduling of
+multi-Pod workloads and to pack `Pods` onto `Nodes` to reduce GPU fragmentation.
+Two options are described below: Coscheduler and Sakkara. You should pick and install one of them
+as a secondary scheduler for your cluster.
+
+### Coscheduler
 
 Install Coscheduler v0.28.9 as a secondary scheduler and configure packing:
 ```sh
@@ -24,6 +31,17 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
 oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.17/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
 ```
 
+### Sakkara
+
+[Sakkara](https://github.com/atantawi/scheduler-plugins/tree/sakkara) is an experimental
+new scheduler plugin with advanced support for topology-aware scheduling.
+
+Install Sakkara as a secondary scheduler:
+```sh
+helm install sakkara-scheduler --namespace sakkara-scheduler --create-namespace mlbatch/sakkara-scheduler
+```
+Optionally, create a config map capturing your cluster's topology as described in the [Sakkara documentation](https://github.com/atantawi/sakkara-deploy/tree/main?tab=readme-ov-file#cluster-topology). This step is optional but recommended for production clusters. If the config map is not present Sakkara will default to a single-level hierarchy containing the Nodes of the cluster.
+
 ## Red Hat OpenShift AI
 
 Create the Red Hat OpenShift AI subscription:

setup.k8s/CLUSTER-SETUP.md

@@ -1,7 +1,7 @@
 # Cluster Setup
 
 The cluster setup installs and configures the following components:
-+ Coscheduler
++ Scheduler Plugins
 + Kubeflow Training Operator
 + KubeRay
 + Kueue
@@ -16,7 +16,14 @@ Create `default-priority`, `high-priority`, and `low-priority` priority classes:
 kubectl apply -f setup.k8s/mlbatch-priorities.yaml
 ```
 
-## Coscheduler
+## Scheduler Plugins
+
+MLBatch utilizes Kubernetes Scheduler Plugins to ensure gang scheduling of
+multi-Pod workloads and to pack `Pods` onto `Nodes` to reduce GPU fragmentation.
+Two options are described below: Coscheduler and Sakkara. You should pick and install one of them
+as a secondary scheduler for your cluster.
+
+### Coscheduler
 
 Install Coscheduler v0.28.9 as a secondary scheduler and configure packing:
 ```sh
@@ -30,6 +37,17 @@ kubectl patch deployment -n scheduler-plugins --type=json --patch-file setup.k8s
 kubectl patch deployment -n scheduler-plugins --type=json --patch-file setup.k8s/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
 ```
 
+### Sakkara
+
+[Sakkara](https://github.com/atantawi/scheduler-plugins/tree/sakkara) is an experimental
+new scheduler plugin with advanced support for topology-aware scheduling.
+
+Install Sakkara as a secondary scheduler:
+```sh
+helm install sakkara-scheduler --namespace sakkara-scheduler --create-namespace mlbatch/sakkara-scheduler
+```
+Optionally, create a config map capturing your cluster's topology as described in the [Sakkara documentation](https://github.com/atantawi/sakkara-deploy/tree/main?tab=readme-ov-file#cluster-topology). This step is optional but recommended for production clusters. If the config map is not present Sakkara will default to a single-level hierarchy containing the Nodes of the cluster.
+
 ## Install Operators
 
 Create the mlbatch-system namespace

setup.tmpl/CLUSTER-SETUP.md.tmpl

@@ -1,12 +1,12 @@
 # Cluster Setup
 
 {{ if .OPENSHIFT -}}
-The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
 cluster roles, and priority classes.
 
 {{- else -}}
 The cluster setup installs and configures the following components:
-+ Coscheduler
++ Scheduler Plugins
 + Kubeflow Training Operator
 + KubeRay
 + Kueue
@@ -23,7 +23,14 @@ Create `default-priority`, `high-priority`, and `low-priority` priority classes:
 {{ .KUBECTL }} apply -f setup.{{ .VERSION }}/mlbatch-priorities.yaml
 ```
 
-## Coscheduler
+## Scheduler Plugins
+
+MLBatch utilizes Kubernetes Scheduler Plugins to ensure gang scheduling of
+multi-Pod workloads and to pack `Pods` onto `Nodes` to reduce GPU fragmentation.
+Two options are described below: Coscheduler and Sakkara. You should pick and install one of them
+as a secondary scheduler for your cluster.
+
+### Coscheduler
 
 Install Coscheduler v0.28.9 as a secondary scheduler and configure packing:
 ```sh
@@ -37,6 +44,17 @@ Patch Coscheduler pod priorities:
 {{ .KUBECTL }} patch deployment -n scheduler-plugins --type=json --patch-file setup.{{ .VERSION }}/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
 ```
 
+### Sakkara
+
+[Sakkara](https://github.com/atantawi/scheduler-plugins/tree/sakkara) is an experimental
+new scheduler plugin with advanced support for topology-aware scheduling.
+
+Install Sakkara as a secondary scheduler:
+```sh
+helm install sakkara-scheduler --namespace sakkara-scheduler --create-namespace mlbatch/sakkara-scheduler
+```
+Optionally, create a config map capturing your cluster's topology as described in the [Sakkara documentation](https://github.com/atantawi/sakkara-deploy/tree/main?tab=readme-ov-file#cluster-topology). This step is optional but recommended for production clusters. If the config map is not present Sakkara will default to a single-level hierarchy containing the Nodes of the cluster.
+
 {{ if .OPENSHIFT -}}
 ## Red Hat OpenShift AI