🚧 Adding API Server (#281)

* 🚧 Adding API Server

Signed-off-by: Muhammed Hussain Karimi <info@karimi.dev>

* Merge branch 'develop' into add-api-server

Signed-off-by: Muhammed Hussain Karimi <info@karimi.dev>

* 📦 Fix Lock and init API Server

Signed-off-by: Muhammed Hussain Karimi <info@karimi.dev>

Author: mhkarimi1383

.pre-commit.sh

@@ -7,7 +7,7 @@ CHART_DIR="$ROOT_DIR/deploy/helm/rawfile-localpv"
 CHART="$CHART_DIR/Chart.yaml"
 
 help() {
-  cat <<EOF
+	cat <<EOF
 Usage: $(basename "$0") [OPTIONS]
 
 Options:
@@ -21,24 +21,27 @@ EOF
 
 DONE=
 while [ "$#" -gt 0 ]; do
-  case $1 in
-    -h|--help)
-      break
-      shift;;
-    --version-sync)
-      PY_VERSION=$(grep -Po '(?<=version = ")[^"]*' "$ROOT_DIR/pyproject.toml")
-      sed -i'' -e "s/^version: .*/version: $PY_VERSION/" "$CHART"
-      sed -i'' -e "s/^appVersion: .*/appVersion: $PY_VERSION/" "$CHART"
-      DONE="yes"
-      shift;;
-    *)
-      echo -e "Unknown parameter $1" >&2
-      help
-      exit 1
-  esac
+	case $1 in
+	-h | --help)
+		break
+		shift
+		;;
+	--version-sync)
+		PY_VERSION=$(grep -Pom1 '(?<=version = ")[^"]*' "$ROOT_DIR/pyproject.toml")
+		sed -i'' -e "s/^version: .*/version: $PY_VERSION/" "$CHART"
+		sed -i'' -e "s/^appVersion: .*/appVersion: $PY_VERSION/" "$CHART"
+		DONE="yes"
+		shift
+		;;
+	*)
+		echo -e "Unknown parameter $1" >&2
+		help
+		exit 1
+		;;
+	esac
 done
 
 if [ -z "${DONE:-}" ]; then
-  help
-  exit 0
+	help
+	exit 0
 fi

poetry.lock

@@ -24,6 +24,8 @@ tldextract = "^5.3.1"
 humanize = "^4.15.0"
 setproctitle = "^1.3.7"
 ipaddress = "^1.0.23"
+fastapi = {extras = ["standard"], version = "^0.128.0"}
+uvicorn = "^0.40.0"
 
 [tool.poetry.scripts]
 rawfile = "rawfile.rawfile:cli"

pyproject.toml

@@ -0,0 +1,11 @@
+from fastapi import FastAPI
+from api_server.v1.routes import router as v1_router
+
+app = FastAPI(debug=False, title="RawFile LocalPV API Server")
+app.include_router(v1_router, prefix="/v1", tags=["v1"])
+
+
+def start_server(host, workers, port):
+    import uvicorn
+
+    uvicorn.run("api_server:app", host=host, port=port, workers=workers)

rawfile/api_server/__init__.py

@@ -0,0 +1,3 @@
+from .nodes import Node, NodeList, PoolStat, PoolsStat
+
+__all__ = ["Node", "NodeList", "PoolStat", "PoolsStat"]

rawfile/api_server/v1/models/__init__.py

@@ -0,0 +1,21 @@
+from typing import List, TypeAlias
+from pydantic import BaseModel, IPvAnyAddress
+
+
+class PoolStat(BaseModel):
+    reserved_capacity: str
+    path: str
+    reserved_capacity_mode: str
+    capacity: int
+
+
+PoolsStat: TypeAlias = dict[str, PoolStat]
+
+
+class Node(BaseModel):
+    name: str
+    ip: IPvAnyAddress
+    pools_stat: PoolsStat
+
+
+NodeList: TypeAlias = List[Node]

rawfile/api_server/v1/models/nodes.py

@@ -0,0 +1,3 @@
+from fastapi import APIRouter
+
+router = APIRouter()

rawfile/api_server/v1/routes/__init__.py

@@ -0,0 +1,55 @@
+from fastapi import APIRouter
+from internal_svc import SIGNATURE_METADATA
+from orchestrator.k8s import node_ip_mapping
+from api_server.v1.models import NodeList, Node, PoolStat, PoolsStat
+import grpc
+from internal import internal_pb2, internal_pb2_grpc
+from config import config
+import ipaddress
+import asyncio
+
+router = APIRouter()
+
+
+def get_node_pool_stat(node_ip):
+    node_ip_str = node_ip
+    metadata = [(SIGNATURE_METADATA, config.csi_driver.internal_signature)]
+    node_ip = ipaddress.ip_address(node_ip_str)
+    if node_ip.version == 6:
+        node_ip_str = f"[{node_ip_str}]"
+    channel = grpc.insecure_channel(f"{node_ip_str}:{config.csi_driver.internal_port}")
+    stub = internal_pb2_grpc.InternalStub(channel)
+    return stub.GetPoolsStats(
+        internal_pb2.GetPoolsStatsRequest(),
+        metadata=metadata,
+        timeout=15,
+    )
+
+
+async def build_node(node_name: str, node_ip: str) -> Node:
+    pool_stats = await get_node_pool_stat(node_ip)
+
+    return Node(
+        name=node_name,
+        ip=node_ip,
+        pools_stat=PoolsStat(
+            {
+                name: PoolStat(
+                    reserved_capacity=pool.reserved_capacity,
+                    path=pool.path,
+                    reserved_capacity_mode=pool.reserved_capacity_mode,
+                    capacity=pool.capacity,
+                )
+                for name, pool in pool_stats.stats.items()
+            }
+        ),
+    )
+
+
+@router.get("/")
+async def get_nodes() -> NodeList:
+    node_list = []
+    node_ips = node_ip_mapping.get_all_nodes()
+    tasks = [build_node(node_name, node_ip) for node_name, node_ip in node_ips.items()]
+    node_list = await asyncio.gather(*tasks)
+    return node_list

rawfile/api_server/v1/routes/nodes.py

@@ -201,6 +201,22 @@ class GCCmd(BaseModel):
     )
 
 
+class APICmd(BaseModel):
+    host: str = Field(
+        default="0.0.0.0",
+        description="Host address to bind the API server",
+    )
+    port: int = Field(
+        default=8080,
+        description="Port number to bind the API server",
+        gt=0,
+        le=65535,
+    )
+    workers: int = Field(
+        default=4, description="Number of uvicorn (ASGI) workers for API server"
+    )
+
+
 class RawFileCmd(
     BaseSettings, cli_parse_args=True, cli_exit_on_error=False, cli_kebab_case=True
 ):
@@ -253,6 +269,9 @@ def settings_customise_sources(
     csi_driver: CliSubCommand[CSIDriverCmd] = Field(
         description="Starts CSI Driver",
     )
+    api: CliSubCommand[APICmd] = Field(
+        description="Starts API server",
+    )
 
     @model_validator(mode="after")
     def validate_ga(self):