Skip to content

Commit a36f34a

Browse files
Added local_interactive to cluster-configuration doc
1 parent 9bb5d1c commit a36f34a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/cluster-configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ cluster = Cluster(ClusterConfiguration(
2323
instascale=False, # Default False
2424
machine_types=["m5.xlarge", "g4dn.xlarge"],
2525
ingress_domain="example.com" # Default None, Mandatory for Vanilla Kubernetes Clusters - ingress_domain is ignored on OpenShift Clusters as a route is created.
26+
local_interactive=False, # Default False
2627
))
2728
```
29+
Note: On OpenShift, the `ingress_domain` is only required when `local_interactive` is enabled. - This may change soon.
2830

2931
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>
3032
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
3638
To create a Ray Cluster using the CodeFlare SDK in a Vanilla Kubernetes environment an `ingress_domain` must be passed in the Cluster Configuration.
3739
This is used for the creation of the Ray Dashboard and Client ingresses.
3840

39-
`ingress_options` can be passed to create a custom Ray Dashboard ingress, `ingress_domain` is still a required variable for the Client ingress.
41+
`ingress_options` can be passed to create a custom Ray Dashboard ingress, `ingress_domain` is still a required variable for the Client route/ingress.
4042
An example of `ingress_options` would look like this.
4143

4244
```

0 commit comments

Comments
 (0)