From a36f34a6b11719fe062b8e1fb5c18806c2ff5029 Mon Sep 17 00:00:00 2001 From: ChristianZaccaria Date: Fri, 26 Jan 2024 14:17:16 +0000 Subject: [PATCH] Added local_interactive to cluster-configuration doc --- docs/cluster-configuration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/cluster-configuration.md b/docs/cluster-configuration.md index 24d63a1e6..2ad614a68 100644 --- a/docs/cluster-configuration.md +++ b/docs/cluster-configuration.md @@ -23,8 +23,10 @@ cluster = Cluster(ClusterConfiguration( 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.
From there a user can call `cluster.up()` and `cluster.down()` to create and remove the appwrapper thus creating and removing the Ray Cluster. @@ -36,7 +38,7 @@ The Ray Cluster and service will be created by KubeRay directly and the other co 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 ingress. +`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. ```