Skip to content

Commit

Permalink
Added local_interactive to cluster-configuration doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianZaccaria authored and openshift-merge-bot[bot] committed Jan 26, 2024
1 parent 9bb5d1c commit a36f34a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/cluster-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<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.
Expand All @@ -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.

```
Expand Down

0 comments on commit a36f34a

Please sign in to comment.