Update docs, demos, and version (#71)

Author: Maxusmusti

demo-notebooks/batch-job/batch_mnist.ipynb

@@ -24,7 +24,8 @@
     "    token = \"XXXX\",\n",
     "    server = \"XXXX\",\n",
     "    skip_tls=True\n",
-    ")"
+    ")\n",
+    "auth.login()"
    ]
   },
   {
@@ -43,7 +44,7 @@
    "outputs": [],
    "source": [
     "# Create our cluster and submit appwrapper\n",
-    "cluster = Cluster(ClusterConfiguration(name='mnisttest', min_worker=2, max_worker=2, min_cpus=8, max_cpus=8, min_memory=16, max_memory=16, gpu=4, instascale=True, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"], auth=auth))"
+    "cluster = Cluster(ClusterConfiguration(name='mnisttest', min_worker=2, max_worker=2, min_cpus=8, max_cpus=8, min_memory=16, max_memory=16, gpu=4, instascale=True, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
    ]
   },
   {
@@ -66,11 +67,12 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "657ebdfb",
    "metadata": {},
    "source": [
-    "Now, we want to check on the status of our resource cluster, until it is finally ready for use."
+    "Now, we want to check on the status of our resource cluster, and wait until it is finally ready for use."
    ]
   },
   {
@@ -122,7 +124,36 @@
     }
    ],
    "source": [
-    "cluster.is_ready()"
+    "cluster.status()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a99d5aff",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cluster.wait_ready()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "df71c1ed",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cluster.status()"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "b3a55fe4",
+   "metadata": {},
+   "source": [
+    "Let's quickly verify that the specs of the cluster are as expected."
    ]
   },
   {
@@ -190,7 +221,7 @@
     }
    ],
    "source": [
-    "cluster.status()"
+    "cluster.details()"
    ]
   },
   {
@@ -1994,6 +2025,16 @@
    "source": [
     "cluster.down()"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0d41b90e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "auth.logout()"
+   ]
   }
  ],
  "metadata": {
@@ -2012,7 +2053,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.9.13"
   },
   "vscode": {
    "interpreter": {

demo-notebooks/interactive/hf_interactive.ipynb

@@ -53,12 +53,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Create authentication object for oc user permissions\n",
+    "# Create authentication object for oc user permissions and login\n",
     "auth = TokenAuthentication(\n",
     "    token = \"XXXX\",\n",
     "    server = \"XXXX\",\n",
     "    skip_tls = True\n",
-    ")"
+    ")\n",
+    "auth.login()"
    ]
   },
   {
@@ -85,7 +86,7 @@
    ],
    "source": [
     "# Create our cluster and submit appwrapper\n",
-    "cluster = Cluster(ClusterConfiguration(name='hfgputest', min_worker=1, max_worker=1, min_cpus=8, max_cpus=8, min_memory=16, max_memory=16, gpu=4, instascale=True, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"], auth=auth))"
+    "cluster = Cluster(ClusterConfiguration(name='hfgputest', min_worker=1, max_worker=1, min_cpus=8, max_cpus=8, min_memory=16, max_memory=16, gpu=4, instascale=True, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
    ]
   },
   {
@@ -107,11 +108,12 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "657ebdfb",
    "metadata": {},
    "source": [
-    "Now, we want to check on the status of our resource cluster, until it is finally ready for use."
+    "Now, we want to check on the initial status of our resource cluster, then wait until it is finally ready for use."
    ]
   },
   {
@@ -163,7 +165,36 @@
     }
    ],
    "source": [
-    "cluster.is_ready()"
+    "cluster.status()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1d26275e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cluster.wait_ready()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d2969a4b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cluster.status()"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "477ac246",
+   "metadata": {},
+   "source": [
+    "Let's quickly verify that the specs of the cluster are as expected."
    ]
   },
   {
@@ -231,7 +262,7 @@
     }
    ],
    "source": [
-    "cluster.status()"
+    "cluster.details()"
    ]
   },
   {
@@ -1379,6 +1410,16 @@
     "cluster.down()"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "61bf4946",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "auth.logout()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "2b7a183b-5e8e-4adb-b9a6-a349e13512a0",
@@ -1416,7 +1457,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.9.13"
   },
   "vscode": {
    "interpreter": {

docs/cluster/auth.html

@@ -92,7 +92,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.auth</code></h1>
         self.server = server
         self.skip_tls = skip_tls
 
-    def login(self):
+    def login(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to login to an OpenShift cluster using the user&#39;s API token and API server address.
         Depending on the cluster, a user can choose to login in with &#34;--insecure-skip-tls-verify` by setting `skip_tls`
@@ -107,15 +107,18 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.auth</code></h1>
             error_msg = osp.result.err()
             if &#34;The server uses a certificate signed by unknown authority&#34; in error_msg:
                 return &#34;Error: certificate auth failure, please set `skip_tls=True` in TokenAuthentication&#34;
+            elif &#34;invalid&#34; in error_msg:
+                raise PermissionError(error_msg)
             else:
                 return error_msg
         return response.out()
 
-    def logout(self):
+    def logout(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to logout of an OpenShift cluster.
         &#34;&#34;&#34;
-        response = oc.invoke(&#34;logout&#34;)
+        args = [f&#34;--token={self.token}&#34;, f&#34;--server={self.server}:6443&#34;]
+        response = oc.invoke(&#34;logout&#34;, args)
         return response.out()
 
 
@@ -137,14 +140,14 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.auth</code></h1>
         self.username = username
         self.password = password
 
-    def login(self):
+    def login(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to login to an OpenShift cluster using the user&#39;s `username` and `password`.
         &#34;&#34;&#34;
         response = oc.login(self.username, self.password)
         return response.out()
 
-    def logout(self):
+    def logout(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to logout of an OpenShift cluster.
         &#34;&#34;&#34;
@@ -261,14 +264,14 @@ <h3>Methods</h3>
         self.username = username
         self.password = password
 
-    def login(self):
+    def login(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to login to an OpenShift cluster using the user&#39;s `username` and `password`.
         &#34;&#34;&#34;
         response = oc.login(self.username, self.password)
         return response.out()
 
-    def logout(self):
+    def logout(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to logout of an OpenShift cluster.
         &#34;&#34;&#34;
@@ -282,15 +285,15 @@ <h3>Ancestors</h3>
 <h3>Methods</h3>
 <dl>
 <dt id="codeflare_sdk.cluster.auth.PasswordUserAuthentication.login"><code class="name flex">
-<span>def <span class="ident">login</span></span>(<span>self)</span>
+<span>def <span class="ident">login</span></span>(<span>self) ‑> str</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This function is used to login to an OpenShift cluster using the user's <code>username</code> and <code>password</code>.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def login(self):
+<pre><code class="python">def login(self) -&gt; str:
     &#34;&#34;&#34;
     This function is used to login to an OpenShift cluster using the user&#39;s `username` and `password`.
     &#34;&#34;&#34;
@@ -299,15 +302,15 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="codeflare_sdk.cluster.auth.PasswordUserAuthentication.logout"><code class="name flex">
-<span>def <span class="ident">logout</span></span>(<span>self)</span>
+<span>def <span class="ident">logout</span></span>(<span>self) ‑> str</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This function is used to logout of an OpenShift cluster.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def logout(self):
+<pre><code class="python">def logout(self) -&gt; str:
     &#34;&#34;&#34;
     This function is used to logout of an OpenShift cluster.
     &#34;&#34;&#34;
@@ -346,7 +349,7 @@ <h3>Methods</h3>
         self.server = server
         self.skip_tls = skip_tls
 
-    def login(self):
+    def login(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to login to an OpenShift cluster using the user&#39;s API token and API server address.
         Depending on the cluster, a user can choose to login in with &#34;--insecure-skip-tls-verify` by setting `skip_tls`
@@ -361,15 +364,18 @@ <h3>Methods</h3>
             error_msg = osp.result.err()
             if &#34;The server uses a certificate signed by unknown authority&#34; in error_msg:
                 return &#34;Error: certificate auth failure, please set `skip_tls=True` in TokenAuthentication&#34;
+            elif &#34;invalid&#34; in error_msg:
+                raise PermissionError(error_msg)
             else:
                 return error_msg
         return response.out()
 
-    def logout(self):
+    def logout(self) -&gt; str:
         &#34;&#34;&#34;
         This function is used to logout of an OpenShift cluster.
         &#34;&#34;&#34;
-        response = oc.invoke(&#34;logout&#34;)
+        args = [f&#34;--token={self.token}&#34;, f&#34;--server={self.server}:6443&#34;]
+        response = oc.invoke(&#34;logout&#34;, args)
         return response.out()</code></pre>
 </details>
 <h3>Ancestors</h3>
@@ -379,7 +385,7 @@ <h3>Ancestors</h3>
 <h3>Methods</h3>
 <dl>
 <dt id="codeflare_sdk.cluster.auth.TokenAuthentication.login"><code class="name flex">
-<span>def <span class="ident">login</span></span>(<span>self)</span>
+<span>def <span class="ident">login</span></span>(<span>self) ‑> str</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This function is used to login to an OpenShift cluster using the user's API token and API server address.
@@ -389,7 +395,7 @@ <h3>Methods</h3>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def login(self):
+<pre><code class="python">def login(self) -&gt; str:
     &#34;&#34;&#34;
     This function is used to login to an OpenShift cluster using the user&#39;s API token and API server address.
     Depending on the cluster, a user can choose to login in with &#34;--insecure-skip-tls-verify` by setting `skip_tls`
@@ -404,25 +410,28 @@ <h3>Methods</h3>
         error_msg = osp.result.err()
         if &#34;The server uses a certificate signed by unknown authority&#34; in error_msg:
             return &#34;Error: certificate auth failure, please set `skip_tls=True` in TokenAuthentication&#34;
+        elif &#34;invalid&#34; in error_msg:
+            raise PermissionError(error_msg)
         else:
             return error_msg
     return response.out()</code></pre>
 </details>
 </dd>
 <dt id="codeflare_sdk.cluster.auth.TokenAuthentication.logout"><code class="name flex">
-<span>def <span class="ident">logout</span></span>(<span>self)</span>
+<span>def <span class="ident">logout</span></span>(<span>self) ‑> str</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This function is used to logout of an OpenShift cluster.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def logout(self):
+<pre><code class="python">def logout(self) -&gt; str:
     &#34;&#34;&#34;
     This function is used to logout of an OpenShift cluster.
     &#34;&#34;&#34;
-    response = oc.invoke(&#34;logout&#34;)
+    args = [f&#34;--token={self.token}&#34;, f&#34;--server={self.server}:6443&#34;]
+    response = oc.invoke(&#34;logout&#34;, args)
     return response.out()</code></pre>
 </details>
 </dd>

docs/cluster/cluster.html

@@ -78,8 +78,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.config</code></h1>
     template: str = f&#34;{dir}/templates/new-template.yaml&#34;
     instascale: bool = False
     envs: dict = field(default_factory=dict)
-    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;
-    auth: Authentication = Authentication()</code></pre>
+    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;</code></pre>
 </details>
 </section>
 <section>
@@ -93,7 +92,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration"><code class="flex name class">
 <span>class <span class="ident">ClusterConfiguration</span></span>
-<span>(</span><span>name: str, namespace: str = 'default', head_info: list = &lt;factory&gt;, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, min_worker: int = 1, max_worker: int = 1, min_memory: int = 2, max_memory: int = 2, gpu: int = 0, template: str = '/home/meyceoz/Documents/codeflare-sdk/src/codeflare_sdk/templates/new-template.yaml', instascale: bool = False, envs: dict = &lt;factory&gt;, image: str = 'ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103', auth: <a title="codeflare_sdk.cluster.auth.Authentication" href="auth.html#codeflare_sdk.cluster.auth.Authentication">Authentication</a> = &lt;codeflare_sdk.cluster.auth.Authentication object&gt;)</span>
+<span>(</span><span>name: str, namespace: str = 'default', head_info: list = &lt;factory&gt;, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, min_worker: int = 1, max_worker: int = 1, min_memory: int = 2, max_memory: int = 2, gpu: int = 0, template: str = '/home/meyceoz/Documents/codeflare-sdk/src/codeflare_sdk/templates/new-template.yaml', instascale: bool = False, envs: dict = &lt;factory&gt;, image: str = 'ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103')</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This dataclass is used to specify resource requirements and other details, and
@@ -122,15 +121,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     template: str = f&#34;{dir}/templates/new-template.yaml&#34;
     instascale: bool = False
     envs: dict = field(default_factory=dict)
-    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;
-    auth: Authentication = Authentication()</code></pre>
+    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;</code></pre>
 </details>
 <h3>Class variables</h3>
 <dl>
-<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.auth"><code class="name">var <span class="ident">auth</span> : <a title="codeflare_sdk.cluster.auth.Authentication" href="auth.html#codeflare_sdk.cluster.auth.Authentication">Authentication</a></code></dt>
-<dd>
-<div class="desc"></div>
-</dd>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration.envs"><code class="name">var <span class="ident">envs</span> : dict</code></dt>
 <dd>
 <div class="desc"></div>
@@ -212,7 +206,6 @@ <h1>Index</h1>
 <li>
 <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#codeflare_sdk.cluster.config.ClusterConfiguration">ClusterConfiguration</a></code></h4>
 <ul class="two-column">
-<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.auth" href="#codeflare_sdk.cluster.config.ClusterConfiguration.auth">auth</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.envs" href="#codeflare_sdk.cluster.config.ClusterConfiguration.envs">envs</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.gpu" href="#codeflare_sdk.cluster.config.ClusterConfiguration.gpu">gpu</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.head_info" href="#codeflare_sdk.cluster.config.ClusterConfiguration.head_info">head_info</a></code></li>

docs/cluster/config.html

@@ -86,9 +86,10 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.model</code></h1>
     &#34;&#34;&#34;
 
     READY = 1
-    QUEUED = 2
-    FAILED = 3
-    UNKNOWN = 4
+    STARTING = 2
+    QUEUED = 3
+    FAILED = 4
+    UNKNOWN = 5
 
 
 @dataclass
@@ -240,9 +241,10 @@ <h3>Class variables</h3>
     &#34;&#34;&#34;
 
     READY = 1
-    QUEUED = 2
-    FAILED = 3
-    UNKNOWN = 4</code></pre>
+    STARTING = 2
+    QUEUED = 3
+    FAILED = 4
+    UNKNOWN = 5</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">
@@ -262,6 +264,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="codeflare_sdk.cluster.model.CodeFlareClusterStatus.STARTING"><code class="name">var <span class="ident">STARTING</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="codeflare_sdk.cluster.model.CodeFlareClusterStatus.UNKNOWN"><code class="name">var <span class="ident">UNKNOWN</span></code></dt>
 <dd>
 <div class="desc"></div>
@@ -425,6 +431,7 @@ <h4><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus" href="#c
 <li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.FAILED" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.FAILED">FAILED</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.QUEUED" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.QUEUED">QUEUED</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.READY" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.READY">READY</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.STARTING" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.STARTING">STARTING</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.model.CodeFlareClusterStatus.UNKNOWN" href="#codeflare_sdk.cluster.model.CodeFlareClusterStatus.UNKNOWN">UNKNOWN</a></code></li>
 </ul>
 </li>

docs/cluster/model.html

@@ -271,7 +271,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
     return outfile
 
 
-def main():
+def main():  # pragma: no cover
     parser = argparse.ArgumentParser(description=&#34;Generate user AppWrapper&#34;)
     parser.add_argument(
         &#34;--name&#34;,
@@ -379,7 +379,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
     return outfile
 
 
-if __name__ == &#34;__main__&#34;:
+if __name__ == &#34;__main__&#34;:  # pragma: no cover
     main()</code></pre>
 </details>
 </section>
@@ -471,7 +471,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def main():
+<pre><code class="python">def main():  # pragma: no cover
     parser = argparse.ArgumentParser(description=&#34;Generate user AppWrapper&#34;)
     parser.add_argument(
         &#34;--name&#34;,

docs/utils/generate_yaml.html

@@ -60,7 +60,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.pretty_print</code></h1>
 
 def print_no_resources_found():
     console = Console()
-    console.print(Panel(&#34;[red]No resources found&#34;))
+    console.print(Panel(&#34;[red]No resources found, have you run cluster.up() yet?&#34;))
 
 
 def print_app_wrappers_status(app_wrappers: List[AppWrapper]):
@@ -69,22 +69,66 @@ <h1 class="title">Module <code>codeflare_sdk.utils.pretty_print</code></h1>
         return  # shortcircuit
 
     console = Console()
+    table = Table(
+        box=box.ASCII_DOUBLE_HEAD,
+        title=&#34;[bold] :rocket: Cluster Queue Status :rocket:&#34;,
+    )
+    table.add_column(&#34;Name&#34;, style=&#34;cyan&#34;, no_wrap=True)
+    table.add_column(&#34;Status&#34;, style=&#34;magenta&#34;)
+
     for app_wrapper in app_wrappers:
         name = app_wrapper.name
         status = app_wrapper.status.value
-
-        table = Table(
-            box=box.ASCII_DOUBLE_HEAD,
-            title=&#34;[bold] :rocket: List of CodeFlare clusters in queue:rocket:&#34;,
-        )
-        table.add_column(&#34;Name&#34;, style=&#34;cyan&#34;, no_wrap=True)
-        table.add_column(&#34;Status&#34;, style=&#34;magenta&#34;)
         table.add_row(name, status)
         table.add_row(&#34;&#34;)  # empty row for spacing
-        console.print(Panel.fit(table))
 
+    console.print(Panel.fit(table))
+
+
+def print_cluster_status(cluster: RayCluster):
+    &#34;Pretty prints the status of a passed-in cluster&#34;
+    if not cluster:
+        print_no_resources_found
+        return
 
-def print_clusters(clusters: List[RayCluster], verbose=True):
+    console = Console()
+    status = (
+        &#34;Active :white_heavy_check_mark:&#34;
+        if cluster.status == RayClusterStatus.READY
+        else &#34;Inactive :x:&#34;
+    )
+    name = cluster.name
+    dashboard = cluster.dashboard
+    # owned = bool(cluster[&#34;userOwned&#34;])
+    owned = True
+
+    #&#39;table0&#39; to display the cluster name, status, url, and dashboard link
+    table0 = Table(box=None, show_header=False)
+    if owned:
+        table0.add_row(&#34;[white on green][bold]Name&#34;)
+    else:
+        table0.add_row(&#34;&#34;)
+    table0.add_row(&#34;[bold underline]&#34; + name, status)
+    table0.add_row()
+    # fixme harcded to default for now
+    table0.add_row(
+        f&#34;[bold]URI:[/bold] ray://{cluster.name}-head-svc.{cluster.namespace}.svc:10001&#34;
+    )  # format that is used to generate the name of the service
+    table0.add_row()
+    table0.add_row(f&#34;[link={dashboard} blue underline]Dashboard:link:[/link]&#34;)
+    table0.add_row(&#34;&#34;)  # empty row for spacing
+
+    # table4 to display table0 and table3, one below the other
+    table4 = Table(box=None, show_header=False)
+    table4.add_row(table0)
+
+    # Encompass all details of the cluster in a single panel
+    table5 = Table(box=None, title=&#34;[bold] :rocket: CodeFlare Cluster Status :rocket:&#34;)
+    table5.add_row(Panel.fit(table4))
+    console.print(table5)
+
+
+def print_clusters(clusters: List[RayCluster]):
     if not clusters:
         print_no_resources_found()
         return  # shortcircuit
@@ -96,13 +140,13 @@ <h1 class="title">Module <code>codeflare_sdk.utils.pretty_print</code></h1>
         status = (
             &#34;Active :white_heavy_check_mark:&#34;
             if cluster.status == RayClusterStatus.READY
-            else &#34;InActive :x:&#34;
+            else &#34;Inactive :x:&#34;
         )
         name = cluster.name
         dashboard = cluster.dashboard
         mincount = str(cluster.min_workers)
         maxcount = str(cluster.max_workers)
-        memory = cluster.worker_mem_min + &#34;~&#34; + cluster.worker_mem_max
+        memory = str(cluster.worker_mem_min) + &#34;~&#34; + str(cluster.worker_mem_max)
         cpu = str(cluster.worker_cpu)
         gpu = str(cluster.worker_gpu)
         # owned = bool(cluster[&#34;userOwned&#34;])
@@ -111,7 +155,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.pretty_print</code></h1>
         #&#39;table0&#39; to display the cluster name, status, url, and dashboard link
         table0 = Table(box=None, show_header=False)
         if owned:
-            table0.add_row(&#34;[white on green][bold]Owner&#34;)
+            table0.add_row(&#34;[white on green][bold]Name&#34;)
         else:
             table0.add_row(&#34;&#34;)
         table0.add_row(&#34;[bold underline]&#34; + name, status)
@@ -162,7 +206,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.pretty_print</code></h1>
             # than being center aligned on the console/terminal if we simply use console.print(title)
 
             table5 = Table(
-                box=None, title=&#34;[bold] :rocket: List of CodeFlare clusters :rocket:&#34;
+                box=None, title=&#34;[bold] :rocket: CodeFlare Cluster Details :rocket:&#34;
             )
             table5.add_row(Panel.fit(table4))
             console.print(table5)
@@ -193,31 +237,84 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         return  # shortcircuit
 
     console = Console()
+    table = Table(
+        box=box.ASCII_DOUBLE_HEAD,
+        title=&#34;[bold] :rocket: Cluster Queue Status :rocket:&#34;,
+    )
+    table.add_column(&#34;Name&#34;, style=&#34;cyan&#34;, no_wrap=True)
+    table.add_column(&#34;Status&#34;, style=&#34;magenta&#34;)
+
     for app_wrapper in app_wrappers:
         name = app_wrapper.name
         status = app_wrapper.status.value
-
-        table = Table(
-            box=box.ASCII_DOUBLE_HEAD,
-            title=&#34;[bold] :rocket: List of CodeFlare clusters in queue:rocket:&#34;,
-        )
-        table.add_column(&#34;Name&#34;, style=&#34;cyan&#34;, no_wrap=True)
-        table.add_column(&#34;Status&#34;, style=&#34;magenta&#34;)
         table.add_row(name, status)
         table.add_row(&#34;&#34;)  # empty row for spacing
-        console.print(Panel.fit(table))</code></pre>
+
+    console.print(Panel.fit(table))</code></pre>
+</details>
+</dd>
+<dt id="codeflare_sdk.utils.pretty_print.print_cluster_status"><code class="name flex">
+<span>def <span class="ident">print_cluster_status</span></span>(<span>cluster: <a title="codeflare_sdk.cluster.model.RayCluster" href="../cluster/model.html#codeflare_sdk.cluster.model.RayCluster">RayCluster</a>)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Pretty prints the status of a passed-in cluster</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def print_cluster_status(cluster: RayCluster):
+    &#34;Pretty prints the status of a passed-in cluster&#34;
+    if not cluster:
+        print_no_resources_found
+        return
+
+    console = Console()
+    status = (
+        &#34;Active :white_heavy_check_mark:&#34;
+        if cluster.status == RayClusterStatus.READY
+        else &#34;Inactive :x:&#34;
+    )
+    name = cluster.name
+    dashboard = cluster.dashboard
+    # owned = bool(cluster[&#34;userOwned&#34;])
+    owned = True
+
+    #&#39;table0&#39; to display the cluster name, status, url, and dashboard link
+    table0 = Table(box=None, show_header=False)
+    if owned:
+        table0.add_row(&#34;[white on green][bold]Name&#34;)
+    else:
+        table0.add_row(&#34;&#34;)
+    table0.add_row(&#34;[bold underline]&#34; + name, status)
+    table0.add_row()
+    # fixme harcded to default for now
+    table0.add_row(
+        f&#34;[bold]URI:[/bold] ray://{cluster.name}-head-svc.{cluster.namespace}.svc:10001&#34;
+    )  # format that is used to generate the name of the service
+    table0.add_row()
+    table0.add_row(f&#34;[link={dashboard} blue underline]Dashboard:link:[/link]&#34;)
+    table0.add_row(&#34;&#34;)  # empty row for spacing
+
+    # table4 to display table0 and table3, one below the other
+    table4 = Table(box=None, show_header=False)
+    table4.add_row(table0)
+
+    # Encompass all details of the cluster in a single panel
+    table5 = Table(box=None, title=&#34;[bold] :rocket: CodeFlare Cluster Status :rocket:&#34;)
+    table5.add_row(Panel.fit(table4))
+    console.print(table5)</code></pre>
 </details>
 </dd>
 <dt id="codeflare_sdk.utils.pretty_print.print_clusters"><code class="name flex">
-<span>def <span class="ident">print_clusters</span></span>(<span>clusters: List[<a title="codeflare_sdk.cluster.model.RayCluster" href="../cluster/model.html#codeflare_sdk.cluster.model.RayCluster">RayCluster</a>], verbose=True)</span>
+<span>def <span class="ident">print_clusters</span></span>(<span>clusters: List[<a title="codeflare_sdk.cluster.model.RayCluster" href="../cluster/model.html#codeflare_sdk.cluster.model.RayCluster">RayCluster</a>])</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def print_clusters(clusters: List[RayCluster], verbose=True):
+<pre><code class="python">def print_clusters(clusters: List[RayCluster]):
     if not clusters:
         print_no_resources_found()
         return  # shortcircuit
@@ -229,13 +326,13 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         status = (
             &#34;Active :white_heavy_check_mark:&#34;
             if cluster.status == RayClusterStatus.READY
-            else &#34;InActive :x:&#34;
+            else &#34;Inactive :x:&#34;
         )
         name = cluster.name
         dashboard = cluster.dashboard
         mincount = str(cluster.min_workers)
         maxcount = str(cluster.max_workers)
-        memory = cluster.worker_mem_min + &#34;~&#34; + cluster.worker_mem_max
+        memory = str(cluster.worker_mem_min) + &#34;~&#34; + str(cluster.worker_mem_max)
         cpu = str(cluster.worker_cpu)
         gpu = str(cluster.worker_gpu)
         # owned = bool(cluster[&#34;userOwned&#34;])
@@ -244,7 +341,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         #&#39;table0&#39; to display the cluster name, status, url, and dashboard link
         table0 = Table(box=None, show_header=False)
         if owned:
-            table0.add_row(&#34;[white on green][bold]Owner&#34;)
+            table0.add_row(&#34;[white on green][bold]Name&#34;)
         else:
             table0.add_row(&#34;&#34;)
         table0.add_row(&#34;[bold underline]&#34; + name, status)
@@ -295,7 +392,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
             # than being center aligned on the console/terminal if we simply use console.print(title)
 
             table5 = Table(
-                box=None, title=&#34;[bold] :rocket: List of CodeFlare clusters :rocket:&#34;
+                box=None, title=&#34;[bold] :rocket: CodeFlare Cluster Details :rocket:&#34;
             )
             table5.add_row(Panel.fit(table4))
             console.print(table5)
@@ -315,7 +412,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </summary>
 <pre><code class="python">def print_no_resources_found():
     console = Console()
-    console.print(Panel(&#34;[red]No resources found&#34;))</code></pre>
+    console.print(Panel(&#34;[red]No resources found, have you run cluster.up() yet?&#34;))</code></pre>
 </details>
 </dd>
 </dl>
@@ -337,6 +434,7 @@ <h1>Index</h1>
 <li><h3><a href="#header-functions">Functions</a></h3>
 <ul class="">
 <li><code><a title="codeflare_sdk.utils.pretty_print.print_app_wrappers_status" href="#codeflare_sdk.utils.pretty_print.print_app_wrappers_status">print_app_wrappers_status</a></code></li>
+<li><code><a title="codeflare_sdk.utils.pretty_print.print_cluster_status" href="#codeflare_sdk.utils.pretty_print.print_cluster_status">print_cluster_status</a></code></li>
 <li><code><a title="codeflare_sdk.utils.pretty_print.print_clusters" href="#codeflare_sdk.utils.pretty_print.print_clusters">print_clusters</a></code></li>
 <li><code><a title="codeflare_sdk.utils.pretty_print.print_no_resources_found" href="#codeflare_sdk.utils.pretty_print.print_no_resources_found">print_no_resources_found</a></code></li>
 </ul>

docs/utils/pretty_print.html

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codeflare-sdk"
-version = "0.2.2"
+version = "0.3.0"
 description = "Python SDK for codeflare client"
 
 license = "Apache-2.0"