align deploy/k8s README

Signed-off-by: JaredforReal <[email protected]>

Author: JaredforReal

deploy/kubernetes/README.md

@@ -1,6 +1,6 @@
 # Semantic Router Kubernetes Deployment
 
-This directory contains Kubernetes manifests for deploying the Semantic Router using Kustomize.
+Kustomize manifests for deploying the Semantic Router and its observability stack (Prometheus, Grafana, Dashboard, optional Open WebUI + Pipelines) on Kubernetes.
 
 ## Architecture
 
@@ -12,8 +12,9 @@ The deployment consists of:
   - **Init Container**: Downloads/copies model files to persistent volume
   - **Main Container**: Runs the semantic router service
 - **Services**:
-  - Main service exposing gRPC port (50051), Classification API (8080), and metrics port (9190)
-  - Separate metrics service for monitoring
+  - Main service exposing gRPC (50051), Classification API (8080), and metrics (9190)
+  - Separate metrics service for monitoring (`semantic-router-metrics`)
+  - Observability services (Grafana, Prometheus, Dashboard, optional Open WebUI)
 
 ## Ports
 
@@ -23,17 +24,40 @@ The deployment consists of:
 
 ## Quick Start
 
-### Standard Kubernetes Deployment
+### Deploy Core (Router)
 
 ```bash
 kubectl apply -k deploy/kubernetes/
 
 # Check deployment status
-kubectl get pods -l app=semantic-router -n semantic-router
-kubectl get services -l app=semantic-router -n semantic-router
+kubectl get pods -l app=semantic-router -n vllm-semantic-router-system
+kubectl get services -l app=semantic-router -n vllm-semantic-router-system
 
 # View logs
-kubectl logs -l app=semantic-router -n semantic-router -f
+kubectl logs -l app=semantic-router -n vllm-semantic-router-system -f
+
+### Add Observability (Prometheus + Grafana + Dashboard + Playground)
+
+```bash
+kubectl apply -k deploy/kubernetes/observability/
+```
+
+Port-forward to UIs (local dev):
+
+```bash
+kubectl port-forward -n vllm-semantic-router-system svc/prometheus 9090:9090
+kubectl port-forward -n vllm-semantic-router-system svc/grafana 3000:3000
+kubectl port-forward -n vllm-semantic-router-system svc/semantic-router-dashboard 8700:80
+kubectl port-forward -n vllm-semantic-router-system svc/openwebui 3001:8080
+```
+
+Then open:
+
+- Prometheus → http://localhost:9090
+- Grafana → http://localhost:3000
+- Dashboard → http://localhost:8700
+- Open WebUI (Playground) → http://localhost:3001
+
 ```
 
 ### Kind (Kubernetes in Docker) Deployment
@@ -86,20 +110,20 @@ kubectl wait --for=condition=Ready nodes --all --timeout=300s
 kubectl apply -k deploy/kubernetes/
 
 # Wait for deployment to be ready
-kubectl wait --for=condition=Available deployment/semantic-router -n semantic-router --timeout=600s
+kubectl wait --for=condition=Available deployment/semantic-router -n vllm-semantic-router-system --timeout=600s
 ```
 
 **Step 3: Check deployment status**
 
 ```bash
 # Check pods
-kubectl get pods -n semantic-router -o wide
+kubectl get pods -n vllm-semantic-router-system -o wide
 
 # Check services
-kubectl get services -n semantic-router
+kubectl get services -n vllm-semantic-router-system
 
 # View logs
-kubectl logs -l app=semantic-router -n semantic-router -f
+kubectl logs -l app=semantic-router -n vllm-semantic-router-system -f
 ```
 
 #### Resource Requirements for Kind
@@ -131,19 +155,30 @@ make port-forward-grpc
 
 # Access metrics
 make port-forward-metrics
+
+# Access Dashboard / Grafana / Open WebUI
+kubectl port-forward -n vllm-semantic-router-system svc/semantic-router-dashboard 8700:80
+kubectl port-forward -n vllm-semantic-router-system svc/grafana 3000:3000
+kubectl port-forward -n vllm-semantic-router-system svc/openwebui 3001:8080
 ```
 
 Or using kubectl directly:
 
 ```bash
 # Access Classification API (HTTP REST)
-kubectl port-forward -n semantic-router svc/semantic-router 8080:8080
+kubectl port-forward -n vllm-semantic-router-system svc/semantic-router 8080:8080
 
 # Access gRPC API
-kubectl port-forward -n semantic-router svc/semantic-router 50051:50051
+kubectl port-forward -n vllm-semantic-router-system svc/semantic-router 50051:50051
 
 # Access metrics
-kubectl port-forward -n semantic-router svc/semantic-router-metrics 9190:9190
+kubectl port-forward -n vllm-semantic-router-system svc/semantic-router-metrics 9190:9190
+
+# Access Prometheus/Grafana/Dashboard/Open WebUI
+kubectl port-forward -n vllm-semantic-router-system svc/prometheus 9090:9090
+kubectl port-forward -n vllm-semantic-router-system svc/grafana 3000:3000
+kubectl port-forward -n vllm-semantic-router-system svc/semantic-router-dashboard 8700:80
+kubectl port-forward -n vllm-semantic-router-system svc/openwebui 3001:8080
 ```
 
 #### Testing the Deployment
@@ -313,7 +348,10 @@ Edit the `resources` section in `deployment.yaml` accordingly.
 - `namespace.yaml` - Dedicated namespace for the application
 - `config.yaml` - Application configuration
 - `tools_db.json` - Tools database for semantic routing
-- `kustomization.yaml` - Kustomize configuration for easy deployment
+- `kustomization.yaml` - Kustomize configuration for core deployment
+- `observability/` - Prometheus, Grafana, Dashboard, optional Open WebUI + Pipelines (with its own `kustomization.yaml`)
+
+For detailed observability setup and screenshots, see `deploy/kubernetes/observability/README.md`.
 
 ### Development Tools