Limit Sakkara to setup.k8s to avoid replicating mlbatch-subscription

dgrove-oss · dgrove-oss · commit bb2bd5d6c0ed · 2025-03-17T12:49:40.000-04:00
diff --git a/setup.RHOAI-v2.13/CLUSTER-SETUP.md b/setup.RHOAI-v2.13/CLUSTER-SETUP.md
@@ -1,6 +1,6 @@
 # Cluster Setup
 
-The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
 cluster roles, and priority classes.
 
 ## Priorities
@@ -14,8 +14,6 @@ oc apply -f setup.RHOAI-v2.13/mlbatch-priorities.yaml
 
 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
 
@@ -31,16 +29,7 @@ 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
 
diff --git a/setup.RHOAI-v2.13/UNINSTALL.md b/setup.RHOAI-v2.13/UNINSTALL.md
@@ -20,8 +20,4 @@ oc delete namespace redhat-ods-applications redhat-ods-monitoring redhat-ods-ope
 # Coscheduler uninstall
 helm uninstall -n scheduler-plugins scheduler-plugins
 oc delete namespace scheduler-plugins
-
-# Sakkara uninstall
-helm uninstall -n sakkara-scheduler sakkara-scheduler
-oc delete namespace sakkara-scheduler
 ```
diff --git a/setup.RHOAI-v2.16/CLUSTER-SETUP.md b/setup.RHOAI-v2.16/CLUSTER-SETUP.md
@@ -1,6 +1,6 @@
 # Cluster Setup
 
-The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
 cluster roles, and priority classes.
 
 ## Priorities
@@ -14,8 +14,6 @@ oc apply -f setup.RHOAI-v2.16/mlbatch-priorities.yaml
 
 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
 
@@ -31,16 +29,7 @@ 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
 
diff --git a/setup.RHOAI-v2.16/UNINSTALL.md b/setup.RHOAI-v2.16/UNINSTALL.md
@@ -20,8 +20,4 @@ oc delete namespace redhat-ods-applications redhat-ods-monitoring redhat-ods-ope
 # Coscheduler uninstall
 helm uninstall -n scheduler-plugins scheduler-plugins
 oc delete namespace scheduler-plugins
-
-# Sakkara uninstall
-helm uninstall -n sakkara-scheduler sakkara-scheduler
-oc delete namespace sakkara-scheduler
 ```
diff --git a/setup.RHOAI-v2.17/CLUSTER-SETUP.md b/setup.RHOAI-v2.17/CLUSTER-SETUP.md
@@ -1,6 +1,6 @@
 # Cluster Setup
 
-The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
 cluster roles, and priority classes.
 
 ## Priorities
@@ -14,8 +14,6 @@ oc apply -f setup.RHOAI-v2.17/mlbatch-priorities.yaml
 
 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
 
@@ -31,16 +29,7 @@ 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
 
diff --git a/setup.RHOAI-v2.17/UNINSTALL.md b/setup.RHOAI-v2.17/UNINSTALL.md
@@ -20,8 +20,4 @@ oc delete namespace redhat-ods-applications redhat-ods-monitoring redhat-ods-ope
 # Coscheduler uninstall
 helm uninstall -n scheduler-plugins scheduler-plugins
 oc delete namespace scheduler-plugins
-
-# Sakkara uninstall
-helm uninstall -n sakkara-scheduler sakkara-scheduler
-oc delete namespace sakkara-scheduler
 ```
diff --git a/setup.k8s/CLUSTER-SETUP.md b/setup.k8s/CLUSTER-SETUP.md
@@ -22,7 +22,6 @@ 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:
diff --git a/setup.tmpl/CLUSTER-SETUP.md.tmpl b/setup.tmpl/CLUSTER-SETUP.md.tmpl
@@ -1,7 +1,7 @@
 # Cluster Setup
 
 {{ if .OPENSHIFT -}}
-The cluster setup installs Red Hat OpenShift AI and Scheduler Plugins, configures Kueue,
+The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
 cluster roles, and priority classes.
 
 {{- else -}}
@@ -27,9 +27,10 @@ Create `default-priority`, `high-priority`, and `low-priority` priority classes:
 
 MLBatch utilizes Kubernetes Scheduler Plugins to ensure gang scheduling of
 multi-Pod workloads and to pack `Pods` onto `Nodes` to reduce GPU fragmentation.
+{{ if not .OPENSHIFT -}}
 Two options are described below: Coscheduler and Sakkara. You should pick and install one of them
 as a secondary scheduler for your cluster.
-
+{{- end }}
 ### Coscheduler
 
 Install Coscheduler v0.28.9 as a secondary scheduler and configure packing:
@@ -44,6 +45,7 @@ Patch Coscheduler pod priorities:
 {{ .KUBECTL }} patch deployment -n scheduler-plugins --type=json --patch-file setup.{{ .VERSION }}/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
 ```
 
+{{ if not .OPENSHIFT -}}
 ### Sakkara
 
 [Sakkara](https://github.com/atantawi/scheduler-plugins/tree/sakkara) is an experimental
@@ -54,6 +56,7 @@ Install Sakkara as a secondary scheduler:
 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.
+{{- end }}
 
 {{ if .OPENSHIFT -}}
 ## Red Hat OpenShift AI
