rename mcad to appwrapper

Author: dgrove-oss

docs/cluster-configuration.md

@@ -18,17 +18,18 @@ cluster = Cluster(ClusterConfiguration(
     max_cpus=1, # Default 1
     min_memory=2, # Default 2
     max_memory=2, # Default 2
-    mcad=True, # Default True
+    num_gpus=0, # Default 0
+    appwrapper=True, # Default True
     image="quay.io/project-codeflare/ray:latest-py39-cu118", # Mandatory Field
     machine_types=["m5.xlarge", "g4dn.xlarge"],
     labels={"exampleLabel": "example", "secondLabel": "example"},
 ))
 ```
 
-Upon creating a cluster configuration with `mcad=True` an appwrapper will be created featuring the Ray Cluster and any Routes, Ingresses or Secrets that are needed to be created along side it.<br>
+Upon creating a cluster configuration with `appwrapper=True` an appwrapper will be created featuring the Ray Cluster and any Routes, Ingresses or Secrets that are needed to be created along side it.<br>
 From there a user can call `cluster.up()` and `cluster.down()` to create and remove the appwrapper thus creating and removing the Ray Cluster.
 
-In cases where `mcad=False` a yaml file will be created with the individual Ray Cluster, Route/Ingress and Secret included.<br>
+In cases where `appwrapper=False` a yaml file will be created with the individual Ray Cluster, Route/Ingress and Secret included.<br>
 The Ray Cluster and service will be created by KubeRay directly and the other components will be individually created.
 
 The `labels={"exampleLabel": "example"}` parameter can be used to apply additional labels to the RayCluster resource.

src/codeflare_sdk/cluster/cluster.py

@@ -153,7 +153,7 @@ def create_app_wrapper(self):
 
         # Before attempting to create the cluster AW, let's evaluate the ClusterConfig
         if self.config.dispatch_priority:
-            if not self.config.mcad:
+            if not self.config.appwrapper:
                 raise ValueError(
                     "Invalid Cluster Configuration, cannot have dispatch priority without MCAD"
                 )
@@ -179,7 +179,7 @@ def create_app_wrapper(self):
         template = self.config.template
         image = self.config.image
         instascale = self.config.instascale
-        mcad = self.config.mcad
+        appwrapper = self.config.appwrapper
         instance_types = self.config.machine_types
         env = self.config.envs
         image_pull_secrets = self.config.image_pull_secrets
@@ -203,7 +203,7 @@ def create_app_wrapper(self):
             template=template,
             image=image,
             instascale=instascale,
-            mcad=mcad,
+            appwrapper=appwrapper,
             instance_types=instance_types,
             env=env,
             image_pull_secrets=image_pull_secrets,
@@ -230,7 +230,7 @@ def up(self):
         try:
             config_check()
             api_instance = client.CustomObjectsApi(api_config_handler())
-            if self.config.mcad:
+            if self.config.appwrapper:
                 if self.config.write_to_file:
                     with open(self.app_wrapper_yaml) as f:
                         aw = yaml.load(f, Loader=yaml.FullLoader)
@@ -284,7 +284,7 @@ def down(self):
         try:
             config_check()
             api_instance = client.CustomObjectsApi(api_config_handler())
-            if self.config.mcad:
+            if self.config.appwrapper:
                 api_instance.delete_namespaced_custom_object(
                     group="workload.codeflare.dev",
                     version="v1beta1",
@@ -306,7 +306,7 @@ def status(
         """
         ready = False
         status = CodeFlareClusterStatus.UNKNOWN
-        if self.config.mcad:
+        if self.config.appwrapper:
             # check the app wrapper status
             appwrapper = _app_wrapper_status(self.config.name, self.config.namespace)
             if appwrapper:
@@ -501,7 +501,7 @@ def job_logs(self, job_id: str) -> str:
 
     def from_k8_cluster_object(
         rc,
-        mcad=True,
+        appwrapper=True,
         write_to_file=False,
         verify_tls=True,
     ):
@@ -538,7 +538,7 @@ def from_k8_cluster_object(
             image=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"]["containers"][
                 0
             ]["image"],
-            mcad=mcad,
+            appwrapper=appwrapper,
             write_to_file=write_to_file,
             verify_tls=verify_tls,
             local_queue=rc["metadata"]
@@ -597,12 +597,14 @@ def list_all_clusters(namespace: str, print_to_console: bool = True):
     return clusters
 
 
-def list_all_queued(namespace: str, print_to_console: bool = True, mcad: bool = False):
+def list_all_queued(
+    namespace: str, print_to_console: bool = True, appwrapper: bool = False
+):
     """
     Returns (and prints by default) a list of all currently queued-up Ray Clusters
     in a given namespace.
     """
-    if mcad:
+    if appwrapper:
         resources = _get_app_wrappers(
             namespace, filter=[AppWrapperStatus.RUNNING, AppWrapperStatus.PENDING]
         )
@@ -675,10 +677,10 @@ def get_cluster(
 
     for rc in rcs["items"]:
         if rc["metadata"]["name"] == cluster_name:
-            mcad = _check_aw_exists(cluster_name, namespace)
+            appwrapper = _check_aw_exists(cluster_name, namespace)
             return Cluster.from_k8_cluster_object(
                 rc,
-                mcad=mcad,
+                appwrapper=appwrapper,
                 write_to_file=write_to_file,
                 verify_tls=verify_tls,
             )

src/codeflare_sdk/cluster/config.py

@@ -47,7 +47,7 @@ class ClusterConfiguration:
     num_gpus: int = 0
     template: str = f"{dir}/templates/base-template.yaml"
     instascale: bool = False
-    mcad: bool = False
+    appwrapper: bool = False
     envs: dict = field(default_factory=dict)
     image: str = ""
     image_pull_secrets: list = field(default_factory=list)

src/codeflare_sdk/utils/generate_yaml.py

@@ -426,7 +426,7 @@ def generate_appwrapper(
     template: str,
     image: str,
     instascale: bool,
-    mcad: bool,
+    appwrapper: bool,
     instance_types: list,
     env,
     image_pull_secrets: list,
@@ -484,13 +484,13 @@ def generate_appwrapper(
     outfile = os.path.join(directory_path, appwrapper_name + ".yaml")
 
     if write_to_file:
-        if mcad:
+        if appwrapper:
             write_user_appwrapper(user_yaml, outfile)
         else:
             write_components(user_yaml, outfile, namespace, local_queue, labels)
         return outfile
     else:
-        if mcad:
+        if appwrapper:
             user_yaml = load_appwrapper(user_yaml, name)
         else:
             user_yaml = load_components(user_yaml, name, namespace, local_queue, labels)

tests/e2e/start_ray_cluster.py

@@ -22,7 +22,7 @@
         num_gpus=0,
         instascale=False,
         image=ray_image,
-        mcad=True,
+        appwrapper=True,
     )
 )
 

tests/unit_test.py

@@ -269,7 +269,7 @@ def test_config_creation():
     assert config.machine_types == ["cpu.small", "gpu.large"]
     assert config.image_pull_secrets == ["unit-test-pull-secret"]
     assert config.dispatch_priority == None
-    assert config.mcad == True
+    assert config.appwrapper == True
 
 
 def test_cluster_creation(mocker):
@@ -345,8 +345,8 @@ def test_cluster_creation_no_mcad(mocker):
     config = createClusterConfig()
     config.name = "unit-test-cluster-ray"
     config.write_to_file = True
-    config.mcad = False
     config.labels = {"testlabel": "test", "testlabel2": "test"}
+    config.appwrapper = False
     cluster = Cluster(config)
 
     assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster-ray.yaml"
@@ -372,7 +372,7 @@ def test_cluster_creation_no_mcad_local_queue(mocker):
     )
     config = createClusterConfig()
     config.name = "unit-test-cluster-ray"
-    config.mcad = False
+    config.appwrapper = False
     config.write_to_file = True
     config.local_queue = "local-queue-default"
     config.labels = {"testlabel": "test", "testlabel2": "test"}
@@ -399,7 +399,7 @@ def test_cluster_creation_no_mcad_local_queue(mocker):
         image_pull_secrets=["unit-test-pull-secret"],
         image="quay.io/project-codeflare/ray:latest-py39-cu118",
         write_to_file=True,
-        mcad=False,
+        appwrapper=False,
         local_queue="local-queue-default",
         labels={"testlabel": "test", "testlabel2": "test"},
     )
@@ -446,7 +446,7 @@ def test_default_cluster_creation(mocker):
     default_config = ClusterConfiguration(
         name="unit-test-default-cluster",
         image="quay.io/project-codeflare/ray:latest-py39-cu118",
-        mcad=True,
+        appwrapper=True,
     )
     cluster = Cluster(default_config)
     test_aw = yaml.load(cluster.app_wrapper_yaml, Loader=yaml.FullLoader)
@@ -587,7 +587,7 @@ def test_cluster_up_down_no_mcad(mocker):
     )
     config = createClusterConfig()
     config.name = "unit-test-cluster-ray"
-    config.mcad = False
+    config.appwrapper = False
     cluster = Cluster(config)
     cluster.up()
     cluster.down()
@@ -904,7 +904,7 @@ def test_ray_details(mocker, capsys):
             namespace="ns",
             image="quay.io/project-codeflare/ray:latest-py39-cu118",
             write_to_file=True,
-            mcad=True,
+            appwrapper=True,
         )
     )
     captured = capsys.readouterr()
@@ -2672,7 +2672,7 @@ def test_list_queue(mocker, capsys):
         "kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
         side_effect=get_obj_none,
     )
-    list_all_queued("ns", mcad=True)
+    list_all_queued("ns", appwrapper=True)
     captured = capsys.readouterr()
     assert captured.out == (
         "╭──────────────────────────────────────────────────────────────────────────────╮\n"
@@ -2683,7 +2683,7 @@ def test_list_queue(mocker, capsys):
         "kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
         side_effect=get_aw_obj,
     )
-    list_all_queued("ns", mcad=True)
+    list_all_queued("ns", appwrapper=True)
     captured = capsys.readouterr()
     assert captured.out == (
         "╭──────────────────────────╮\n"
@@ -2770,7 +2770,7 @@ def test_cluster_status(mocker):
             namespace="ns",
             image="quay.io/project-codeflare/ray:latest-py39-cu118",
             write_to_file=True,
-            mcad=True,
+            appwrapper=True,
         )
     )
     mocker.patch("codeflare_sdk.cluster.cluster._app_wrapper_status", return_value=None)
@@ -2865,7 +2865,7 @@ def test_wait_ready(mocker, capsys):
             namespace="ns",
             image="quay.io/project-codeflare/ray:latest-py39-cu118",
             write_to_file=True,
-            mcad=True,
+            appwrapper=True,
         )
     )
     try:

tests/unit_test_support.py

@@ -14,7 +14,7 @@ def createClusterConfig():
         min_memory=5,
         max_memory=6,
         num_gpus=7,
-        mcad=True,
+        appwrapper=True,
         instascale=True,
         machine_types=["cpu.small", "gpu.large"],
         image_pull_secrets=["unit-test-pull-secret"],