Skip to content

Commit f0ec7d6

Browse files
yossiovadiaclaude
yossiovadia
and
claude
committed
feat: add OpenWebUI OpenShift integration with deployment scripts
Add complete OpenWebUI deployment for OpenShift integration: - OpenWebUI deployment manifests with OpenShift security contexts - Automated deployment script with prerequisite validation - Safe uninstall script with single confirmation prompt - Internal service discovery (no hardcoded URLs) - Integration with Envoy proxy for model load balancing - Persistent storage for user data and configurations - HTTPS external access via OpenShift routes - Support for auto, Model-A, and Model-B endpoints Files added: - deploy/openshift/openwebui/deployment.yaml - deploy/openshift/openwebui/service.yaml - deploy/openshift/openwebui/route.yaml - deploy/openshift/openwebui/pvc.yaml - deploy/openshift/openwebui/kustomization.yaml - deploy/openshift/openwebui/deploy-openwebui-on-openshift.sh - deploy/openshift/openwebui/uninstall-openwebui.sh - deploy/openshift/openwebui/README.md Features: - Zero-config setup with automatic model discovery - OpenShift-compatible security contexts - Rich user feedback with colored output - Complete validation and connectivity testing - Safe cleanup with data preservation options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Signed-off-by: Yossi Ovadia <[email protected]>
1 parent b7f5c61 commit f0ec7d6

File tree

8 files changed

+545
-0
lines changed

8 files changed

+545
-0
lines changed

‎deploy/openshift/openwebui/README.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# OpenWebUI OpenShift Integration
2+
3+
This directory contains the OpenShift deployment manifests for OpenWebUI, integrated with the existing semantic-router deployment.
4+
5+
## Architecture
6+
7+
- **Namespace**: `vllm-semantic-router-system` (same as semantic-router)
8+
- **Backend Integration**: Connects to Envoy proxy endpoint with load balancing
9+
- **External Access**: Available via OpenShift Route with HTTPS
10+
- **Storage**: Persistent volume for user data and configurations
11+
12+
## Quick Deployment
13+
14+
### Using Scripts (Recommended)
15+
16+
```bash
17+
# Deploy OpenWebUI with full validation and setup
18+
./deploy-openwebui-on-openshift.sh
19+
20+
# Uninstall OpenWebUI (preserves data by default)
21+
./uninstall-openwebui.sh
22+
```
23+
24+
### Using Kubernetes Manifests
25+
26+
```bash
27+
# Deploy OpenWebUI manifests individually
28+
oc apply -f pvc.yaml
29+
oc apply -f deployment.yaml
30+
oc apply -f service.yaml
31+
oc apply -f route.yaml
32+
33+
# Check deployment status
34+
oc get pods -n vllm-semantic-router-system -l app=openwebui
35+
36+
# Get the external URL
37+
oc get route openwebui -n vllm-semantic-router-system -o jsonpath='{.spec.host}'
38+
```
39+
40+
## Configuration
41+
42+
OpenWebUI is configured to connect to the Envoy proxy automatically:
43+
- **Backend URL**: `http://semantic-router.vllm-semantic-router-system.svc.cluster.local:8801/v1`
44+
- **Available Models**: `auto` (load balancer), `Model-A`, `Model-B`
45+
- **Port**: Service exposed on port 3000, mapped to container port 8080
46+
- **Storage**: 2Gi persistent volume for user data
47+
48+
### OpenWebUI Settings
49+
50+
When configuring OpenWebUI in the interface:
51+
- **API Base URL**: `http://semantic-router.vllm-semantic-router-system.svc.cluster.local:8801/v1`
52+
- **API Key**: `not-needed-for-local-models` (or leave empty)
53+
- **Models**: Will auto-discover `auto`, `Model-A`, and `Model-B`
54+
55+
## Files
56+
57+
- `deploy-openwebui-on-openshift.sh` - Complete deployment script with validation
58+
- `uninstall-openwebui.sh` - Safe uninstall script with data preservation options
59+
- `deployment.yaml` - OpenWebUI deployment with OpenShift security contexts
60+
- `service.yaml` - ClusterIP service exposing port 3000
61+
- `route.yaml` - OpenShift route for external HTTPS access
62+
- `pvc.yaml` - Persistent volume claim for data storage
63+
- `kustomization.yaml` - Kustomize configuration for easy deployment
64+
65+
## Usage
66+
67+
1. **Deploy**: Run `./deploy-openwebui-on-openshift.sh`
68+
2. **Access**: Open the provided HTTPS URL in your browser
69+
3. **Configure**: Models are pre-configured and auto-discovered
70+
4. **Chat**: Start conversations with Model-A, Model-B, or auto (load balanced)
71+
72+
## Cleanup
73+
74+
```bash
75+
# Safe uninstall with data preservation option
76+
./uninstall-openwebui.sh
77+
78+
# Or remove all resources immediately
79+
oc delete -f route.yaml -f service.yaml -f deployment.yaml -f pvc.yaml
80+
```
81+
82+
## Features
83+
84+
- **Zero-config Setup**: Automatically connects to semantic-router
85+
- **Load Balancing**: Access both models through Envoy proxy
86+
- **Persistent Data**: User conversations and settings preserved
87+
- **OpenShift Security**: Runs with restricted security contexts
88+
- **HTTPS Access**: Secure external access via OpenShift routes
89+
- **Health Monitoring**: Built-in health checks and monitoring
90+
91+
## Troubleshooting
92+
93+
- **503 Errors**: Check if service endpoints are available with `oc get endpoints openwebui`
94+
- **Connection Issues**: Verify semantic-router is running with `oc get pods -l app=semantic-router`
95+
- **Model Discovery**: Test backend connectivity with the deployment script validation

‎deploy/openshift/openwebui/deploy-openwebui-on-openshift.sh‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
#!/bin/bash
2+
3+
# Deploy OpenWebUI on OpenShift
4+
# This script deploys OpenWebUI to work with the existing semantic-router deployment
5+
6+
set -e
7+
8+
# Colors for output
9+
RED='\033[0;31m'
10+
GREEN='\033[0;32m'
11+
YELLOW='\033[1;33m'
12+
BLUE='\033[0;34m'
13+
NC='\033[0m' # No Color
14+
15+
# Script directory
16+
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
17+
18+
echo -e "${BLUE}🚀 OpenWebUI OpenShift Deployment Script${NC}"
19+
echo "================================================"
20+
21+
# Check if oc is installed and logged in
22+
if ! command -v oc &> /dev/null; then
23+
echo -e "${RED}❌ Error: 'oc' command not found. Please install OpenShift CLI.${NC}"
24+
exit 1
25+
fi
26+
27+
if ! oc whoami &> /dev/null; then
28+
echo -e "${RED}❌ Error: Not logged into OpenShift. Please run 'oc login'.${NC}"
29+
exit 1
30+
fi
31+
32+
# Get current user and project
33+
CURRENT_USER=$(oc whoami)
34+
echo -e "${GREEN}✅ Logged in as: ${CURRENT_USER}${NC}"
35+
36+
# Check if we're in the right namespace or if it exists
37+
NAMESPACE="vllm-semantic-router-system"
38+
if ! oc get namespace "$NAMESPACE" &> /dev/null; then
39+
echo -e "${RED}❌ Error: Namespace '$NAMESPACE' not found.${NC}"
40+
echo "Please ensure the semantic-router is deployed first."
41+
exit 1
42+
fi
43+
44+
# Switch to the namespace
45+
echo -e "${YELLOW}📁 Switching to namespace: ${NAMESPACE}${NC}"
46+
oc project "$NAMESPACE"
47+
48+
# Check if semantic-router is running
49+
echo -e "${YELLOW}🔍 Checking semantic-router deployment...${NC}"
50+
if ! oc get deployment semantic-router &> /dev/null; then
51+
echo -e "${RED}❌ Error: semantic-router deployment not found.${NC}"
52+
echo "Please deploy semantic-router first."
53+
exit 1
54+
fi
55+
56+
if ! oc get deployment semantic-router -o jsonpath='{.status.readyReplicas}' | grep -q "1"; then
57+
echo -e "${YELLOW}⚠️ Warning: semantic-router deployment may not be ready.${NC}"
58+
echo "Continuing with OpenWebUI deployment..."
59+
fi
60+
61+
echo -e "${GREEN}✅ semantic-router found and ready${NC}"
62+
63+
# Deploy OpenWebUI components
64+
echo -e "${YELLOW}🔧 Deploying OpenWebUI components...${NC}"
65+
66+
echo " 📦 Creating Persistent Volume Claim..."
67+
oc apply -f "$SCRIPT_DIR/pvc.yaml"
68+
69+
echo " 🚀 Creating Deployment..."
70+
oc apply -f "$SCRIPT_DIR/deployment.yaml"
71+
72+
echo " 🌐 Creating Service..."
73+
oc apply -f "$SCRIPT_DIR/service.yaml"
74+
75+
echo " 🔗 Creating Route..."
76+
oc apply -f "$SCRIPT_DIR/route.yaml"
77+
78+
# Wait for deployment to be ready
79+
echo -e "${YELLOW}⏳ Waiting for OpenWebUI deployment to be ready...${NC}"
80+
oc rollout status deployment/openwebui --timeout=300s
81+
82+
# Get the route URL
83+
ROUTE_URL=$(oc get route openwebui -o jsonpath='{.spec.host}')
84+
if [ -z "$ROUTE_URL" ]; then
85+
echo -e "${RED}❌ Error: Could not get route URL${NC}"
86+
exit 1
87+
fi
88+
89+
# Check if OpenWebUI is responding
90+
echo -e "${YELLOW}🔍 Testing OpenWebUI endpoint...${NC}"
91+
if curl -k -s -o /dev/null -w "%{http_code}" "https://$ROUTE_URL" | grep -q "200"; then
92+
echo -e "${GREEN}✅ OpenWebUI is responding${NC}"
93+
else
94+
echo -e "${YELLOW}⚠️ OpenWebUI may still be starting up...${NC}"
95+
fi
96+
97+
# Test backend connectivity
98+
echo -e "${YELLOW}🔍 Testing backend connectivity...${NC}"
99+
if oc exec deployment/openwebui -- curl -s -o /dev/null -w "%{http_code}" \
100+
"http://semantic-router.vllm-semantic-router-system.svc.cluster.local:8801/v1/models" | grep -q "200"; then
101+
echo -e "${GREEN}✅ Backend connectivity working${NC}"
102+
else
103+
echo -e "${YELLOW}⚠️ Backend connectivity may need time to establish...${NC}"
104+
fi
105+
106+
# Display deployment information
107+
echo ""
108+
echo -e "${GREEN}🎉 OpenWebUI deployment completed successfully!${NC}"
109+
echo "================================================"
110+
echo -e "${BLUE}📊 Deployment Summary:${NC}"
111+
echo " 🌐 URL: https://$ROUTE_URL"
112+
echo " 🎯 Backend: http://semantic-router.vllm-semantic-router-system.svc.cluster.local:8801/v1"
113+
echo " 📂 Namespace: $NAMESPACE"
114+
echo ""
115+
echo -e "${BLUE}🔧 Available Models:${NC}"
116+
echo " • auto (load balancer)"
117+
echo " • Model-A (Qwen/Qwen3-0.6B)"
118+
echo " • Model-B (Qwen/Qwen3-0.6B)"
119+
echo ""
120+
echo -e "${BLUE}📝 Configuration for OpenWebUI:${NC}"
121+
echo " • API Base URL: http://semantic-router.vllm-semantic-router-system.svc.cluster.local:8801/v1"
122+
echo " • API Key: not-needed-for-local-models (or leave empty)"
123+
echo ""
124+
echo -e "${YELLOW}💡 Next Steps:${NC}"
125+
echo " 1. Open https://$ROUTE_URL in your browser"
126+
echo " 2. Complete initial setup in OpenWebUI"
127+
echo " 3. The models should be automatically available"
128+
echo ""
129+
echo -e "${GREEN}✨ Happy chatting with your models!${NC}"

‎deploy/openshift/openwebui/deployment.yaml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
apiVersion: apps/v1
2+
kind: Deployment
3+
metadata:
4+
name: openwebui
5+
namespace: vllm-semantic-router-system
6+
labels:
7+
app: openwebui
8+
component: frontend
9+
spec:
10+
replicas: 1
11+
selector:
12+
matchLabels:
13+
app: openwebui
14+
template:
15+
metadata:
16+
labels:
17+
app: openwebui
18+
component: frontend
19+
spec:
20+
containers:
21+
- name: openwebui
22+
image: ghcr.io/open-webui/open-webui:main
23+
ports:
24+
- containerPort: 8080
25+
name: http
26+
protocol: TCP
27+
env:
28+
# OpenWebUI Configuration - Connect to Envoy proxy
29+
- name: OPENAI_API_BASE_URL
30+
value: "http://semantic-router.vllm-semantic-router-system.svc.cluster.local:8801/v1"
31+
- name: OPENAI_API_KEY
32+
value: "not-needed-for-local-models"
33+
- name: WEBUI_SECRET_KEY
34+
value: "your-secret-key-change-in-production"
35+
- name: DATA_DIR
36+
value: "/app/backend/data"
37+
# Enable multiple OpenAI-compatible endpoints
38+
- name: ENABLE_OPENAI_API
39+
value: "true"
40+
# OpenShift compatible paths
41+
- name: HOME
42+
value: "/tmp/home"
43+
- name: TMPDIR
44+
value: "/tmp"
45+
securityContext:
46+
allowPrivilegeEscalation: false
47+
capabilities:
48+
drop:
49+
- ALL
50+
seccompProfile:
51+
type: RuntimeDefault
52+
volumeMounts:
53+
- name: openwebui-data
54+
mountPath: /app/backend/data
55+
- name: tmp-volume
56+
mountPath: /tmp
57+
livenessProbe:
58+
httpGet:
59+
path: /health
60+
port: 8080
61+
initialDelaySeconds: 30
62+
periodSeconds: 30
63+
timeoutSeconds: 10
64+
failureThreshold: 3
65+
readinessProbe:
66+
httpGet:
67+
path: /health
68+
port: 8080
69+
initialDelaySeconds: 15
70+
periodSeconds: 15
71+
timeoutSeconds: 5
72+
failureThreshold: 3
73+
resources:
74+
requests:
75+
memory: "512Mi"
76+
cpu: "250m"
77+
limits:
78+
memory: "1Gi"
79+
cpu: "500m"
80+
volumes:
81+
- name: openwebui-data
82+
persistentVolumeClaim:
83+
claimName: openwebui-data
84+
- name: tmp-volume
85+
emptyDir: {}

‎deploy/openshift/openwebui/kustomization.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
apiVersion: kustomize.config.k8s.io/v1beta1
2+
kind: Kustomization
3+
4+
metadata:
5+
name: openwebui
6+
namespace: vllm-semantic-router-system
7+
8+
# Resources that make up the OpenWebUI deployment
9+
resources:
10+
- pvc.yaml
11+
- deployment.yaml
12+
- service.yaml
13+
- route.yaml
14+
15+
# Common labels applied to all resources
16+
commonLabels:
17+
app.kubernetes.io/name: openwebui
18+
app.kubernetes.io/component: frontend
19+
app.kubernetes.io/part-of: semantic-router
20+
21+
# Namespace for all resources
22+
namespace: vllm-semantic-router-system

‎deploy/openshift/openwebui/pvc.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
apiVersion: v1
2+
kind: PersistentVolumeClaim
3+
metadata:
4+
name: openwebui-data
5+
namespace: vllm-semantic-router-system
6+
labels:
7+
app: openwebui
8+
component: frontend
9+
spec:
10+
accessModes:
11+
- ReadWriteOnce
12+
resources:
13+
requests:
14+
storage: 2Gi
15+
# Use default storage class for OpenShift
16+
# storageClassName: ""

‎deploy/openshift/openwebui/route.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
apiVersion: route.openshift.io/v1
2+
kind: Route
3+
metadata:
4+
name: openwebui
5+
namespace: vllm-semantic-router-system
6+
labels:
7+
app: openwebui
8+
component: frontend
9+
annotations:
10+
haproxy.router.openshift.io/timeout: "300s"
11+
spec:
12+
host: openwebui-vllm-semantic-router-system.apps.cluster-pbd96.pbd96.sandbox5333.opentlc.com
13+
to:
14+
kind: Service
15+
name: openwebui
16+
weight: 100
17+
port:
18+
targetPort: http
19+
tls:
20+
termination: edge
21+
insecureEdgeTerminationPolicy: Redirect
22+
wildcardPolicy: None

‎deploy/openshift/openwebui/service.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: v1
2+
kind: Service
3+
metadata:
4+
name: openwebui
5+
namespace: vllm-semantic-router-system
6+
labels:
7+
app: openwebui
8+
component: frontend
9+
spec:
10+
type: ClusterIP
11+
ports:
12+
- port: 3000
13+
targetPort: 8080
14+
protocol: TCP
15+
name: http
16+
selector:
17+
app: openwebui

0 commit comments

Comments
 (0)