From d408a25e3af96d0baccb9c4330e758567f1d1b37 Mon Sep 17 00:00:00 2001
From: Bobbins228 <markcampbell114@gmail.com>
Date: Thu, 30 Nov 2023 11:46:29 +0000
Subject: [PATCH] Documented ingress functionality

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index e864189b0..014b14d35 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,31 @@ Full documentation can be found [here](https://project-codeflare.github.io/codef
 
 Can be installed via `pip`: `pip install codeflare-sdk`
 
+## CodeFlare SDK in a Kubernetes environment
+To create a Ray Cluster using the CodeFlare SDK in a 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.
+An example of `ingress_options` would look like this.
+
+```
+ingress_options = {
+  "ingresses": [
+    {
+      "ingressName": "<ingress_name>",
+      "port": <port_number>,
+      "pathType": "<path_type>",
+      "path": "<path>",
+      "host":"<host>",
+      "annotations": {
+        "foo": "bar",
+        "foo": "bar",
+      }
+    }
+  ]
+}
+```
+
 ## Development
 
 ### Prerequisites