Added local_interactive annotation

Author: Bobbins228

src/codeflare_sdk/cluster/cluster.py

@@ -504,45 +504,13 @@ def torchx_config(
 
     def from_k8_cluster_object(rc, mcad=True, ingress_domain=None, ingress_options={}, write_to_file=False):
         config_check()
-        cluster_name = rc["metadata"]["name"]
-        if is_openshift_cluster():
-            try:
-                api_instance = client.CustomObjectsApi(api_config_handler())
-                routes = api_instance.list_namespaced_custom_object(
-                    group="route.openshift.io",
-                    version="v1",
-                    namespace=rc["metadata"]["namespace"],
-                    plural="routes",
-                )
-            except Exception as e:  # pragma no cover
-                return _kube_api_error_handling(e)
-            for route in routes["items"]:
-                if (
-                    route["metadata"]["name"] == f"rayclient-{cluster_name}"
-                    and route["spec"]["port"]["targetPort"] == "client"
-                ):
-                    local_interactive = True
-                    break
-                else:
-                    local_interactive = False
+        if (
+            rc["metadata"]["annotations"]["sdk.codeflare.dev/local_interactive"]
+            == "true"
+        ):
+            local_interactive = True
         else:
-            try:
-                api_instance = client.NetworkingV1Api(api_config_handler())
-                ingresses = api_instance.list_namespaced_ingress(
-                    rc["metadata"]["namespace"]
-                )
-            except Exception as e:  # pragma no cover
-                return _kube_api_error_handling(e)
-            for ingress in ingresses.items:
-                if (
-                    f"rayclient-{cluster_name}" == ingress.metadata.name
-                    and ingress.spec.rules[0].http.paths[0].backend.service.port.number
-                    == 10001
-                ):
-                    local_interactive = True
-                    break
-                else:
-                    local_interactive = False
+            local_interactive = False
 
         machine_types = (
             rc["metadata"]["labels"]["orderedinstance"].split("_")
@@ -551,9 +519,10 @@ def from_k8_cluster_object(rc, mcad=True, ingress_domain=None, ingress_options={
         )
 
         if local_interactive and ingress_domain == None:
-            ingress_domain = get_ingress_domain_from_client(
-                rc["metadata"]["name"], rc["metadata"]["namespace"]
-            )
+            ingress_domain = rc["metadata"]["annotations"][
+                "sdk.codeflare.dev/ingress_domain"
+            ]
+
         cluster_config = ClusterConfiguration(
             name=rc["metadata"]["name"],
             namespace=rc["metadata"]["namespace"],
@@ -1080,30 +1049,3 @@ def _copy_to_ray(cluster: Cluster) -> RayCluster:
     if ray.status == CodeFlareClusterStatus.READY:
         ray.status = RayClusterStatus.READY
     return ray
-
-
-def get_ingress_domain_from_client(cluster_name: str, namespace: str = "default"):
-    if is_openshift_cluster():
-        try:
-            config_check()
-            api_instance = client.CustomObjectsApi(api_config_handler())
-            route = api_instance.get_namespaced_custom_object(
-                group="route.openshift.io",
-                version="v1",
-                namespace=namespace,
-                plural="routes",
-                name=f"rayclient-{cluster_name}",
-            )
-            return route["spec"]["host"].split(".", 1)[1]
-        except Exception as e:  # pragma no cover
-            return _kube_api_error_handling(e)
-    else:
-        try:
-            config_check()
-            api_instance = client.NetworkingV1Api(api_config_handler())
-            ingress = api_instance.read_namespaced_ingress(
-                f"rayclient-{cluster_name}", namespace
-            )
-            return ingress.spec.rules[0].host.split(".", 1)[1]
-        except Exception as e:  # pragma no cover
-            return _kube_api_error_handling(e)

src/codeflare_sdk/templates/base-template.yaml

@@ -40,6 +40,8 @@ spec:
         apiVersion: ray.io/v1
         kind: RayCluster
         metadata:
+          annotations:
+            sdk.codeflare.dev/local_interactive: "false"
           labels:
             workload.codeflare.dev/appwrapper: "aw-kuberay"
             controller-tools.k8s.io: "1.0"

src/codeflare_sdk/utils/generate_yaml.py

@@ -461,6 +461,12 @@ def enable_local_interactive(resources, cluster_name, namespace, ingress_domain)
         namespace,
         ingress_domain,
     )
+    item["generictemplate"]["metadata"]["annotations"][
+        "sdk.codeflare.dev/local_interactive"
+    ] = "true"
+    item["generictemplate"]["metadata"]["annotations"][
+        "sdk.codeflare.dev/ingress_domain"
+    ] = ingress_domain
 
     item["generictemplate"]["spec"]["headGroupSpec"]["template"]["spec"][
         "initContainers"

tests/test-case-bad.yaml

@@ -32,6 +32,8 @@ spec:
         apiVersion: ray.io/v1
         kind: RayCluster
         metadata:
+          annotations:
+            sdk.codeflare.dev/local_interactive: 'false'
           labels:
             workload.codeflare.dev/appwrapper: unit-test-cluster
             controller-tools.k8s.io: '1.0'

tests/test-case-no-mcad.yamls

@@ -2,6 +2,8 @@
 apiVersion: ray.io/v1
 kind: RayCluster
 metadata:
+  annotations:
+    sdk.codeflare.dev/local_interactive: 'false'
   labels:
     controller-tools.k8s.io: '1.0'
     workload.codeflare.dev/appwrapper: unit-test-cluster-ray

tests/test-case-prio.yaml

@@ -32,6 +32,8 @@ spec:
         apiVersion: ray.io/v1
         kind: RayCluster
         metadata:
+          annotations:
+            sdk.codeflare.dev/local_interactive: 'false'
           labels:
             controller-tools.k8s.io: '1.0'
             workload.codeflare.dev/appwrapper: prio-test-cluster

tests/test-case.yaml

@@ -31,6 +31,8 @@ spec:
         apiVersion: ray.io/v1
         kind: RayCluster
         metadata:
+          annotations:
+            sdk.codeflare.dev/local_interactive: 'false'
           labels:
             controller-tools.k8s.io: '1.0'
             workload.codeflare.dev/appwrapper: unit-test-cluster

tests/unit_test.py

@@ -40,7 +40,6 @@
     _app_wrapper_status,
     _ray_cluster_status,
     _get_ingress_domain,
-    get_ingress_domain_from_client,
 )
 from codeflare_sdk.cluster.auth import (
     TokenAuthentication,
@@ -978,6 +977,10 @@ def get_ray_obj(group, version, namespace, plural, cls=None):
                 "metadata": {
                     "creationTimestamp": "2024-03-05T09:55:37Z",
                     "generation": 1,
+                    "annotations": {
+                        "sdk.codeflare.dev/local_interactive": "true",
+                        "sdk.codeflare.dev/ingress_domain": "apps.cluster.awsroute.org",
+                    },
                     "labels": {
                         "appwrapper.mcad.ibm.com": "quicktest",
                         "controller-tools.k8s.io": "1.0",
@@ -1531,6 +1534,9 @@ def get_aw_obj(group, version, namespace, plural):
                                     "apiVersion": "ray.io/v1",
                                     "kind": "RayCluster",
                                     "metadata": {
+                                        "annotations": {
+                                            "sdk.codeflare.dev/local_interactive": "false"
+                                        },
                                         "labels": {
                                             "workload.codeflare.dev/appwrapper": "quicktest1",
                                             "controller-tools.k8s.io": "1.0",
@@ -1859,6 +1865,9 @@ def get_aw_obj(group, version, namespace, plural):
                                     "apiVersion": "ray.io/v1",
                                     "kind": "RayCluster",
                                     "metadata": {
+                                        "annotations": {
+                                            "sdk.codeflare.dev/local_interactive": "false"
+                                        },
                                         "labels": {
                                             "workload.codeflare.dev/appwrapper": "quicktest2",
                                             "controller-tools.k8s.io": "1.0",
@@ -2210,28 +2219,6 @@ def test_get_cluster(mocker):
     assert cluster_config.num_workers == 1
 
 
-def test_get_ingress_domain_from_client(mocker):
-    mocker.patch("kubernetes.config.load_kube_config")
-    mocker.patch("kubernetes.client.ApisApi.get_api_versions")
-    mocker.patch(
-        "kubernetes.client.NetworkingV1Api.read_namespaced_ingress",
-        return_value=ingress_retrieval(cluster_name="unit-test-cluster").items[0],
-    )
-
-    ingress_domain = get_ingress_domain_from_client("unit-test-cluster", "ns")
-    assert ingress_domain == "apps.cluster.awsroute.org"
-
-    mocker.patch(
-        "codeflare_sdk.utils.generate_yaml.is_openshift_cluster", return_value=True
-    )
-    mocker.patch(
-        "kubernetes.client.CustomObjectsApi.get_namespaced_custom_object",
-        side_effect=route_retrieval,
-    )
-    ingress_domain = get_ingress_domain_from_client("unit-test-cluster", "ns")
-    assert ingress_domain == "apps.cluster.awsroute.org"
-
-
 def route_retrieval(group, version, namespace, plural, name):
     assert group == "route.openshift.io"
     assert version == "v1"