File tree Expand file tree Collapse file tree 1 file changed +25
-0
lines changed
Expand file tree Collapse file tree 1 file changed +25
-0
lines changed Original file line number Diff line number Diff line change @@ -17,6 +17,31 @@ Full documentation can be found [here](https://project-codeflare.github.io/codef
1717
1818Can be installed via ` pip ` : ` pip install codeflare-sdk `
1919
20+ ## CodeFlare SDK in a Kubernetes environment
21+ To create a Ray Cluster using the CodeFlare SDK in a Kubernetes environment an ` ingress_domain ` must be passed in the Cluster Configuration.
22+ This is used for the creation of the Ray Dashboard and Client ingresses.
23+
24+ ` ingress_options ` can be passed to create a custom Ray Dashboard ingress, ` ingress_domain ` is still a required variable for the Client ingress.
25+ An example of ` ingress_options ` would look like this.
26+
27+ ```
28+ ingress_options = {
29+ "ingresses": [
30+ {
31+ "ingressName": "<ingress_name>",
32+ "port": <port_number>,
33+ "pathType": "<path_type>",
34+ "path": "<path>",
35+ "host":"<host>",
36+ "annotations": {
37+ "foo": "bar",
38+ "foo": "bar",
39+ }
40+ }
41+ ]
42+ }
43+ ```
44+
2045## Development
2146
2247### Prerequisites
You can’t perform that action at this time.
0 commit comments