Skip to content

Commit 9bb5d1c

Browse files
Update cluster-configuration doc for clarity
1 parent 62be50e commit 9bb5d1c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/cluster-configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ cluster = Cluster(ClusterConfiguration(
2222
image="quay.io/project-codeflare/ray:latest-py39-cu118", # Mandatory Field
2323
instascale=False, # Default False
2424
machine_types=["m5.xlarge", "g4dn.xlarge"],
25-
ingress_domain="example.com" # Default None, Mandatory for Kubernetes Clusters
25+
ingress_domain="example.com" # Default None, Mandatory for Vanilla Kubernetes Clusters - ingress_domain is ignored on OpenShift Clusters as a route is created.
2626
))
2727
```
2828

@@ -32,8 +32,8 @@ From there a user can call `cluster.up()` and `cluster.down()` to create and rem
3232
In cases where `mcad=False` a yaml file will be created with the individual Ray Cluster, Route/Ingress and Secret included.<br>
3333
The Ray Cluster and service will be created by KubeRay directly and the other components will be individually created.
3434

35-
## Ray Cluster Configuration in a Kubernetes environment
36-
To create a Ray Cluster using the CodeFlare SDK in a Kubernetes environment an `ingress_domain` must be passed in the Cluster Configuration.
35+
## Ray Cluster Configuration in a Vanilla Kubernetes environment (Non-OpenShift)
36+
To create a Ray Cluster using the CodeFlare SDK in a Vanilla Kubernetes environment an `ingress_domain` must be passed in the Cluster Configuration.
3737
This is used for the creation of the Ray Dashboard and Client ingresses.
3838

3939
`ingress_options` can be passed to create a custom Ray Dashboard ingress, `ingress_domain` is still a required variable for the Client ingress.

0 commit comments

Comments
 (0)