change 'priority' to 'dispatch priority'

Author: MichaelClifford

src/codeflare_sdk/cluster/cluster.py

@@ -84,7 +84,7 @@ def create_app_wrapper(self):
         instascale = self.config.instascale
         instance_types = self.config.machine_types
         env = self.config.envs
-        priority = self.config.priority
+        dispatch_priority = self.config.dispatch_priority
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -99,7 +99,7 @@ def create_app_wrapper(self):
             instascale=instascale,
             instance_types=instance_types,
             env=env,
-            priority=priority,
+            dispatch_priority=dispatch_priority,
         )
 
     # creates a new cluster with the provided or default spec

src/codeflare_sdk/cluster/config.py

@@ -48,4 +48,4 @@ class ClusterConfiguration:
     instascale: bool = False
     envs: dict = field(default_factory=dict)
     image: str = "ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103"
-    priority: str = "low"
+    dispatch_priority: str = "default"

src/codeflare_sdk/utils/generate_yaml.py

@@ -236,7 +236,7 @@ def generate_appwrapper(
     instascale: bool,
     instance_types: list,
     env,
-    priority: str,
+    dispatch_priority: str,
 ):
     user_yaml = read_template(template)
     appwrapper_name, cluster_name = gen_names(name)
@@ -245,7 +245,7 @@ def generate_appwrapper(
     route_item = resources["resources"].get("GenericItems")[1]
     update_names(user_yaml, item, appwrapper_name, cluster_name, namespace)
     update_labels(user_yaml, instascale, instance_types)
-    update_priority(user_yaml, item, priority)
+    update_priority(user_yaml, item, dispatch_priority)
     update_scheduling_spec(user_yaml, workers)
     update_custompodresources(
         item, min_cpu, max_cpu, min_memory, max_memory, gpu, workers
@@ -344,10 +344,10 @@ def main():  # pragma: no cover
         help="Set the kubernetes namespace you want to deploy your cluster to. Default. If left blank, uses the 'default' namespace",
     )
     parser.add_argument(
-        "--priority",
+        "--dispatch-priority",
         required=False,
-        default="low",
-        help="Set the priority of the cluster. Default is 'low'. Options are 'low', 'default', 'high'",
+        default="default",
+        help="Set the dispatch priority of the framework cluster. Options are 'low', 'default', and 'high'",
     )
 
     args = parser.parse_args()
@@ -363,7 +363,7 @@ def main():  # pragma: no cover
     instascale = args.instascale
     instance_types = args.instance_types
     namespace = args.namespace
-    priority = args.priority
+    dispatch_priority = args.dispatch_priority
     env = {}
 
     outfile = generate_appwrapper(
@@ -380,7 +380,7 @@ def main():  # pragma: no cover
         instascale,
         instance_types,
         env,
-        priority,
+        dispatch_priority,
     )
     return outfile
 

tests/test-case-cmd.yaml

@@ -4,7 +4,7 @@ metadata:
   name: unit-cmd-cluster
   namespace: default
 spec:
-  priority: 1
+  priority: 5
   resources:
     GenericItems:
     - custompodresources:
@@ -88,7 +88,7 @@ spec:
                       cpu: 2
                       memory: 8G
                       nvidia.com/gpu: 0
-                priorityClassName: low-priority
+                priorityClassName: default-priority
           rayVersion: 1.12.0
           workerGroupSpecs:
           - groupName: small-group-unit-cmd-cluster
@@ -137,7 +137,7 @@ spec:
                     do echo waiting for myservice; sleep 2; done
                   image: busybox:1.28
                   name: init-myservice
-                priorityClassName: low-priority
+                priorityClassName: default-priority
       replicas: 1
     - generictemplate:
         apiVersion: route.openshift.io/v1

tests/test-case.yaml

@@ -6,7 +6,7 @@ metadata:
   name: unit-test-cluster
   namespace: ns
 spec:
-  priority: 1
+  priority: 5
   resources:
     GenericItems:
     - custompodresources:
@@ -99,7 +99,7 @@ spec:
                       cpu: 2
                       memory: 8G
                       nvidia.com/gpu: 0
-                priorityClassName: low-priority
+                priorityClassName: default-priority
           rayVersion: 1.12.0
           workerGroupSpecs:
           - groupName: small-group-unit-test-cluster
@@ -157,7 +157,7 @@ spec:
                     do echo waiting for myservice; sleep 2; done
                   image: busybox:1.28
                   name: init-myservice
-                priorityClassName: low-priority
+                priorityClassName: default-priority
       replicas: 1
     - generictemplate:
         apiVersion: route.openshift.io/v1

tests/unit_test.py

@@ -212,7 +212,7 @@ def test_config_creation():
         gpu=7,
         instascale=True,
         machine_types=["cpu.small", "gpu.large"],
-        priority="low",
+        dispatch_priority="default",
     )
 
     assert config.name == "unit-test-cluster" and config.namespace == "ns"
@@ -227,7 +227,7 @@ def test_config_creation():
     assert config.template == f"{parent}/src/codeflare_sdk/templates/new-template.yaml"
     assert config.instascale
     assert config.machine_types == ["cpu.small", "gpu.large"]
-    assert config.priority == "low"
+    assert config.dispatch_priority == "default"
     return config