pretty print list of clusters

Author: atinsood

requirements.txt

@@ -0,0 +1,2 @@
+openshift-client==1.0.18
+rich==12.5.1

src/codeflare_sdk.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+README.md
 pyproject.toml
 src/codeflare_sdk/__init__.py
 src/codeflare_sdk.egg-info/PKG-INFO
@@ -6,4 +7,6 @@ src/codeflare_sdk.egg-info/dependency_links.txt
 src/codeflare_sdk.egg-info/top_level.txt
 src/codeflare_sdk/cluster/__init__.py
 src/codeflare_sdk/cluster/cluster.py
-src/codeflare_sdk/cluster/config.py
+src/codeflare_sdk/cluster/config.py
+src/codeflare_sdk/utils/__init__.py
+src/codeflare_sdk/utils/pretty_print.py

src/codeflare_sdk/cluster/cluster.py

@@ -1,9 +1,50 @@
 from .config import ClusterConfiguration
-def up(config: ClusterConfiguration):
-    pass
+from ..utils.pretty_print import RayCluster
+from ..utils import pretty_print
+import openshift as oc
+from typing import List
 
-def down(name):
-    pass
+class Cluster:
+    def __init__(self, config: ClusterConfiguration):
+        pass
 
-def status(name):
-    pass
+    def up(self):
+        pass
+
+    def down(self, name):
+        pass
+
+    def status(self, name):
+        pass
+
+
+def list_all_clusters(print_to_console=True):
+    clusters = _get_ray_clusters()
+    if print_to_console:
+        pretty_print.print_clusters(clusters)
+    return clusters
+        
+
+# private methods
+
+def _get_appwrappers(namespace='default'):
+    with oc.project(namespace), oc.timeout(10*60):
+        app_wrappers = oc.selector('appwrappers').qnames()
+    return app_wrappers
+
+
+def _get_ray_clusters(namespace='default') -> List[RayCluster]:
+    list_of_clusters = []
+    with oc.project(namespace), oc.timeout(10*60):
+        ray_clusters = oc.selector('rayclusters').objects()
+        for cluster in ray_clusters:
+            cluster_model = cluster.model
+            list_of_clusters.append(RayCluster(
+                name=cluster.name(), status=cluster_model.status.state, 
+                min_workers=cluster_model.spec.workerGroupSpecs[0].replicas,
+                max_workers=cluster_model.spec.workerGroupSpecs[0].replicas,
+                worker_mem_max=cluster_model.spec.workerGroupSpecs[0].template.spec.containers[0].resources.limits.memory,
+                worker_mem_min=cluster_model.spec.workerGroupSpecs[0].template.spec.containers[0].resources.requests.memory,
+                worker_cpu=cluster_model.spec.workerGroupSpecs[0].template.spec.containers[0].resources.limits.cpu,
+                worker_gpu=0))
+    return list_of_clusters

src/codeflare_sdk/utils/__init__.py

@@ -0,0 +1,96 @@
+from ast import Str
+from turtle import st
+from rich import print
+from rich.table import Table
+from rich.console import Console
+from rich.layout import Layout
+from rich.panel import Panel
+from rich import box
+from dataclasses import dataclass
+from typing import List
+
+@dataclass
+class RayCluster:
+    name: str
+    status: str
+    min_workers: int
+    max_workers: int
+    worker_mem_min: str
+    worker_mem_max: str
+    worker_cpu: int
+    worker_gpu: int
+
+def print_clusters(clusters:List[RayCluster], verbose=True):
+    console = Console()
+
+    title_printed = False
+
+    for cluster in clusters:
+        status = "Active :white_heavy_check_mark:" if cluster.status.lower() == 'ready' else "InActive :x:"
+        name = cluster.name
+        dashboard = f"https://codeflare-raydashboard.research.ibm.com?rayclustername={name}"
+        mincount = str(cluster.min_workers)
+        maxcount = str(cluster.max_workers)
+        memory = cluster.worker_mem_min+"~"+cluster.worker_mem_max
+        cpu = str(cluster.worker_cpu)
+        gpu = str(cluster.worker_mem_max)
+        #owned = bool(cluster["userOwned"])
+        owned = True
+
+        #'table0' to display the cluster name, status, url, and dashboard link
+        table0 = Table(box=None, show_header=False)
+        if owned:
+            table0.add_row("[white on green][bold]Owner")
+        else:
+            table0.add_row("")
+        table0.add_row("[bold underline]"+name,status)
+        table0.add_row()
+        table0.add_row(f"[bold]URI:[/bold] ray://{name}-head.codeflare.svc:1001")
+        table0.add_row()
+        table0.add_row(f"[link={dashboard} blue underline]Dashboard:link:[/link]")
+        table0.add_row("") #empty row for spacing
+
+
+        #'table1' to display the worker counts
+        table1 = Table(box=None)
+        table1.add_row()
+        table1.add_column("Min", style="cyan", no_wrap=True)
+        table1.add_column("Max", style="magenta")
+        table1.add_row()
+        table1.add_row(mincount,maxcount)
+        table1.add_row()
+
+        #'table2' to display the worker resources
+        table2 = Table(box=None)
+        table2.add_column("Memory", style="cyan", no_wrap=True, min_width=10)
+        table2.add_column("CPU", style="magenta", min_width=10)
+        table2.add_column("GPU", style="magenta", min_width=10)
+        table2.add_row()
+        table2.add_row(memory, cpu, gpu)
+        table2.add_row()
+
+        #panels to encompass table1 and table2 into separate cards
+        panel_1 = Panel.fit(table1,title="Workers")
+        panel_2 = Panel.fit(table2, title="Worker specs(each)")
+
+        #table3 to display panel_1 and panel_2 side-by-side in a single row
+        table3 = Table(box=None, show_header=False, title="Cluster Resources")
+        table3.add_row(panel_1,panel_2)
+
+        #table4 to display table0 and table3, one below the other
+        table4 = Table(box=None, show_header=False)
+        table4.add_row(table0)
+        table4.add_row(table3)
+
+        # Encompass all details of the cluster in a single panel
+        if not title_printed:
+            #If first cluster in the list, then create a table with title "Codeflare clusters".
+            #This is done to ensure the title is center aligned on the cluster display tables, rather
+            #than being center aligned on the console/terminal if we simply use console.print(title)
+
+            table5 = Table(box=None, title="[bold] :rocket: List of CodeFlare clusters :rocket:")
+            table5.add_row(Panel.fit(table4))
+            console.print(table5)
+            title_printed = True
+        else:
+            console.print(Panel.fit(table4))

src/codeflare_sdk/utils/pretty_print.py

@@ -0,0 +1,6 @@
+from codeflare_sdk.cluster.cluster import _get_ray_clusters
+from codeflare_sdk.utils.pretty_print import print_clusters
+def test_list_clusters():
+    clusters = _get_ray_clusters()
+    print_clusters(clusters)
+