Remove local_interactive

Author: Bobbins228

docs/cluster-configuration.md

@@ -22,39 +22,11 @@ cluster = Cluster(ClusterConfiguration(
     image="quay.io/project-codeflare/ray:latest-py39-cu118", # Mandatory Field
     instascale=False, # Default False
     machine_types=["m5.xlarge", "g4dn.xlarge"],
-    ingress_domain="example.com" # Default None, Mandatory for Vanilla Kubernetes Clusters - ingress_domain is ignored on OpenShift Clusters as a route is created.
-    local_interactive=False, # Default False
 ))
 ```
-Note: On OpenShift, the `ingress_domain` is only required when `local_interactive` is enabled. - This may change soon.
 
 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>
 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>
 The Ray Cluster and service will be created by KubeRay directly and the other components will be individually created.
-
-## Ray Cluster Configuration in a Vanilla Kubernetes environment (Non-OpenShift)
-To create a Ray Cluster using the CodeFlare SDK in a Vanilla Kubernetes environment an `ingress_domain` must be passed in the Cluster Configuration.
-This is used for the creation of the Ray Dashboard and Client ingresses.
-
-`ingress_options` can be passed to create a custom Ray Dashboard ingress, `ingress_domain` is still a required variable for the Client route/ingress.
-An example of `ingress_options` would look like this.
-
-```
-ingress_options = {
-  "ingresses": [
-    {
-      "ingressName": "<ingress_name>",
-      "port": <port_number>,
-      "pathType": "<path_type>",
-      "path": "<path>",
-      "host":"<host>",
-      "annotations": {
-        "foo": "bar",
-        "foo": "bar",
-      }
-    }
-  ]
-}
-```

src/codeflare_sdk/cluster/cluster.py

@@ -179,7 +179,6 @@ def create_app_wrapper(self):
         mcad = self.config.mcad
         instance_types = self.config.machine_types
         env = self.config.envs
-        local_interactive = self.config.local_interactive
         image_pull_secrets = self.config.image_pull_secrets
         dispatch_priority = self.config.dispatch_priority
         write_to_file = self.config.write_to_file
@@ -203,7 +202,6 @@ def create_app_wrapper(self):
             mcad=mcad,
             instance_types=instance_types,
             env=env,
-            local_interactive=local_interactive,
             image_pull_secrets=image_pull_secrets,
             dispatch_priority=dispatch_priority,
             priority_val=priority_val,
@@ -479,13 +477,6 @@ def from_k8_cluster_object(
         verify_tls=True,
     ):
         config_check()
-        if (
-            rc["metadata"]["annotations"]["sdk.codeflare.dev/local_interactive"]
-            == "True"
-        ):
-            local_interactive = True
-        else:
-            local_interactive = False
         machine_types = (
             rc["metadata"]["labels"]["orderedinstance"].split("_")
             if "orderedinstance" in rc["metadata"]["labels"]
@@ -526,19 +517,15 @@ def from_k8_cluster_object(
             image=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"]["containers"][
                 0
             ]["image"],
-            local_interactive=local_interactive,
             mcad=mcad,
             write_to_file=write_to_file,
             verify_tls=verify_tls,
         )
         return Cluster(cluster_config)
 
     def local_client_url(self):
-        if self.config.local_interactive == True:
-            ingress_domain = _get_ingress_domain(self)
-            return f"ray://{ingress_domain}"
-        else:
-            return "None"
+        ingress_domain = _get_ingress_domain(self)
+        return f"ray://{ingress_domain}"
 
     def _component_resources_up(
         self, namespace: str, api_instance: client.CustomObjectsApi

src/codeflare_sdk/cluster/config.py

@@ -49,7 +49,6 @@ class ClusterConfiguration:
     mcad: bool = False
     envs: dict = field(default_factory=dict)
     image: str = ""
-    local_interactive: bool = False
     image_pull_secrets: list = field(default_factory=list)
     dispatch_priority: str = None
     write_to_file: bool = False

src/codeflare_sdk/templates/base-template.yaml

@@ -40,8 +40,6 @@ 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

@@ -277,14 +277,6 @@ def update_ca_secret(ca_secret_item, cluster_name, namespace):
     data["ca.key"], data["ca.crt"] = generate_cert.generate_ca_cert(365)
 
 
-def enable_local_interactive(resources):  # pragma: no cover
-    item = resources["resources"].get("GenericItems")[0]
-
-    item["generictemplate"]["metadata"]["annotations"][
-        "sdk.codeflare.dev/local_interactive"
-    ] = "True"
-
-
 def del_from_list_by_name(l: list, target: typing.List[str]) -> list:
     return [x for x in l if x["name"] not in target]
 
@@ -454,7 +446,6 @@ def generate_appwrapper(
     mcad: bool,
     instance_types: list,
     env,
-    local_interactive: bool,
     image_pull_secrets: list,
     dispatch_priority: str,
     priority_val: int,
@@ -505,9 +496,6 @@ def generate_appwrapper(
         head_gpus,
     )
 
-    if local_interactive:
-        enable_local_interactive(resources)
-
     ca_secret_item = resources["resources"].get("GenericItems")[1]
     update_ca_secret(ca_secret_item, cluster_name, namespace)
 

tests/test-case-bad.yaml

@@ -32,8 +32,6 @@ 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,8 +2,6 @@
 apiVersion: ray.io/v1
 kind: RayCluster
 metadata:
-  annotations:
-    sdk.codeflare.dev/local_interactive: 'False'
   labels:
     controller-tools.k8s.io: '1.0'
     kueue.x-k8s.io/queue-name: local-queue-default

tests/test-case-prio.yaml

@@ -32,8 +32,6 @@ 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,8 +31,6 @@ 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/test-default-appwrapper.yaml

@@ -29,8 +29,6 @@ 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-default-cluster

tests/unit_test.py

@@ -74,7 +74,6 @@
     gen_names,
     is_openshift_cluster,
     read_template,
-    enable_local_interactive,
     write_components,
 )
 
@@ -258,7 +257,6 @@ def test_config_creation():
     assert config.image_pull_secrets == ["unit-test-pull-secret"]
     assert config.dispatch_priority == None
     assert config.mcad == True
-    assert config.local_interactive == False
 
 
 def ca_secret_support(path, mcad: bool):
@@ -746,7 +744,6 @@ def test_local_client_url(mocker):
     cluster_config = ClusterConfiguration(
         name="unit-test-cluster-localinter",
         namespace="ns",
-        local_interactive=True,
         write_to_file=True,
     )
     cluster = Cluster(cluster_config)
@@ -1062,9 +1059,6 @@ 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",
-                    },
                     "labels": {
                         "appwrapper.mcad.ibm.com": "quicktest",
                         "controller-tools.k8s.io": "1.0",
@@ -1874,9 +1868,6 @@ 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",
@@ -2204,9 +2195,6 @@ 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",
@@ -2518,7 +2506,6 @@ def custom_side_effect(group, version, namespace, plural, **kwargs):
     assert cluster_config.min_cpus == 1 and cluster_config.max_cpus == 1
     assert cluster_config.min_memory == 2 and cluster_config.max_memory == 2
     assert cluster_config.num_gpus == 0
-    assert cluster_config.local_interactive == True
     assert (
         cluster_config.image
         == "ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103"
@@ -2552,7 +2539,6 @@ def test_get_cluster(mocker):
     assert cluster_config.min_memory == 2 and cluster_config.max_memory == 2
     assert cluster_config.num_gpus == 0
     assert cluster_config.instascale
-    assert cluster_config.local_interactive
     assert (
         cluster_config.image
         == "ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103"
@@ -3082,120 +3068,6 @@ def test_export_env():
     )
 
 
-# def test_enable_local_interactive(mocker):
-#     template = f"{parent}/src/codeflare_sdk/templates/base-template.yaml"
-#     user_yaml = read_template(template)
-#     aw_spec = user_yaml.get("spec", None)
-#     cluster_name = "test-enable-local"
-#     namespace = "default"
-#     ingress_domain = "mytest.domain"
-#     mocker.patch("kubernetes.client.ApisApi.get_api_versions")
-#     mocker.patch(
-#         "codeflare_sdk.utils.generate_yaml.is_openshift_cluster", return_value=False
-#     )
-#     volume_mounts = [
-#         {"name": "ca-vol", "mountPath": "/home/ray/workspace/ca", "readOnly": True},
-#         {
-#             "name": "server-cert",
-#             "mountPath": "/home/ray/workspace/tls",
-#             "readOnly": False,
-#         },
-#     ]
-#     volumes = [
-#         {
-#             "name": "ca-vol",
-#             "secret": {"secretName": "ca-secret-test-enable-local"},
-#             "optional": False,
-#         },
-#         {"name": "server-cert", "emptyDir": {}},
-#         {
-#             "name": "odh-trusted-ca-cert",
-#             "configMap": {
-#                 "name": "odh-trusted-ca-bundle",
-#                 "items": [
-#                     {"key": "ca-bundle.crt", "path": "odh-trusted-ca-bundle.crt"}
-#                 ],
-#                 "optional": True,
-#             },
-#         },
-#         {
-#             "name": "odh-ca-cert",
-#             "configMap": {
-#                 "name": "odh-trusted-ca-bundle",
-#                 "items": [{"key": "odh-ca-bundle.crt", "path": "odh-ca-bundle.crt"}],
-#                 "optional": True,
-#             },
-#         },
-#     ]
-#     tls_env = [
-#         {"name": "RAY_USE_TLS", "value": "1"},
-#         {"name": "RAY_TLS_SERVER_CERT", "value": "/home/ray/workspace/tls/server.crt"},
-#         {"name": "RAY_TLS_SERVER_KEY", "value": "/home/ray/workspace/tls/server.key"},
-#         {"name": "RAY_TLS_CA_CERT", "value": "/home/ray/workspace/tls/ca.crt"},
-#     ]
-#     assert aw_spec != None
-#     enable_local_interactive(aw_spec, cluster_name, namespace, ingress_domain)
-#     head_group_spec = aw_spec["resources"]["GenericItems"][0]["generictemplate"][
-#         "spec"
-#     ]["headGroupSpec"]
-#     worker_group_spec = aw_spec["resources"]["GenericItems"][0]["generictemplate"][
-#         "spec"
-#     ]["workerGroupSpecs"]
-#     ca_secret = aw_spec["resources"]["GenericItems"][1]["generictemplate"]
-#     # At a minimal, make sure the following items are presented in the appwrapper spec.resources.
-#     # 1. headgroup has the initContainers command to generated TLS cert from the mounted CA cert.
-#     #    Note: In this particular command, the DNS.5 in [alt_name] must match the exposed local_client_url: rayclient-{cluster_name}.{namespace}.{ingress_domain}
-#     assert (
-#         head_group_spec["template"]["spec"]["initContainers"][0]["command"][2]
-#         == f"cd /home/ray/workspace/tls && openssl req -nodes -newkey rsa:2048 -keyout server.key -out server.csr -subj '/CN=ray-head' && printf \"authorityKeyIdentifier=keyid,issuer\\nbasicConstraints=CA:FALSE\\nsubjectAltName = @alt_names\\n[alt_names]\\nDNS.1 = 127.0.0.1\\nDNS.2 = localhost\\nDNS.3 = ${{FQ_RAY_IP}}\\nDNS.4 = $(awk 'END{{print $1}}' /etc/hosts)\\nDNS.5 = rayclient-{cluster_name}-$(cat /var/run/secrets/kubernetes.io/serviceaccount/namespace).{ingress_domain}\">./domain.ext && cp /home/ray/workspace/ca/* . && openssl x509 -req -CA ca.crt -CAkey ca.key -in server.csr -out server.crt -days 365 -CAcreateserial -extfile domain.ext"
-#     )
-#     assert (
-#         head_group_spec["template"]["spec"]["initContainers"][0]["volumeMounts"]
-#         == volume_mounts
-#     )
-#     assert head_group_spec["template"]["spec"]["volumes"] == volumes
-
-#     # 2. workerGroupSpec has the initContainers command to generated TLS cert from the mounted CA cert.
-#     assert (
-#         worker_group_spec[0]["template"]["spec"]["initContainers"][0]["command"][2]
-#         == "cd /home/ray/workspace/tls && openssl req -nodes -newkey rsa:2048 -keyout server.key -out server.csr -subj '/CN=ray-head' && printf \"authorityKeyIdentifier=keyid,issuer\\nbasicConstraints=CA:FALSE\\nsubjectAltName = @alt_names\\n[alt_names]\\nDNS.1 = 127.0.0.1\\nDNS.2 = localhost\\nDNS.3 = ${FQ_RAY_IP}\\nDNS.4 = $(awk 'END{print $1}' /etc/hosts)\">./domain.ext && cp /home/ray/workspace/ca/* . && openssl x509 -req -CA ca.crt -CAkey ca.key -in server.csr -out server.crt -days 365 -CAcreateserial -extfile domain.ext"
-#     )
-#     assert (
-#         worker_group_spec[0]["template"]["spec"]["initContainers"][0]["volumeMounts"]
-#         == volume_mounts
-#     )
-#     assert worker_group_spec[0]["template"]["spec"]["volumes"] == volumes
-
-#     # 3. Required Envs to enable TLS encryption between head and workers
-#     for i in range(len(tls_env)):
-#         assert (
-#             head_group_spec["template"]["spec"]["containers"][0]["env"][i + 1]["name"]
-#             == tls_env[i]["name"]
-#         )
-#         assert (
-#             head_group_spec["template"]["spec"]["containers"][0]["env"][i + 1]["value"]
-#             == tls_env[i]["value"]
-#         )
-#         assert (
-#             worker_group_spec[0]["template"]["spec"]["containers"][0]["env"][i + 1][
-#                 "name"
-#             ]
-#             == tls_env[i]["name"]
-#         )
-#         assert (
-#             worker_group_spec[0]["template"]["spec"]["containers"][0]["env"][i + 1][
-#                 "value"
-#             ]
-#             == tls_env[i]["value"]
-#         )
-
-#     # 4. Secret with ca.crt and ca.key
-#     assert ca_secret["kind"] == "Secret"
-#     assert ca_secret["data"]["ca.crt"] != None
-#     assert ca_secret["data"]["ca.key"] != None
-#     assert ca_secret["metadata"]["name"] == f"ca-secret-{cluster_name}"
-#     assert ca_secret["metadata"]["namespace"] == namespace
-
 """
 Ray Jobs tests
 """