Skip to content

Commit ae2bfec

Browse files
szedan-rhclaude
andcommitted
chore: fix markdown linting issues in OpenShift docs
Applied markdownlint auto-fixes to ensure documentation follows project style guidelines: - Added blank lines around lists (MD032) - Added blank lines around fenced code blocks (MD031) Files fixed: - deploy/openshift/README.md - deploy/openshift/README-DYNAMIC-IPS.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Signed-off-by: szedan <[email protected]>
1 parent f7fe95a commit ae2bfec

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

deploy/openshift/README-DYNAMIC-IPS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This deployment uses **dynamic IP configuration** to ensure portability across d
77
## Architecture
88

99
### Pod Structure
10+
1011
1. **semantic-router Pod**:
1112
- Container 1: `semantic-router` (ExtProc service)
1213
- Container 2: `envoy-proxy` (Proxy)
@@ -41,16 +42,19 @@ oc create configmap semantic-router-config --from-file=dynamic-config.yaml
4142
## Benefits
4243

4344
### ✅ Cross-Cluster Portability
45+
4446
- Works on any OpenShift/Kubernetes cluster
4547
- No manual IP configuration needed
4648
- IPs are discovered automatically
4749

4850
### ✅ Service-Based Routing
51+
4952
- Uses Kubernetes ClusterIP services
5053
- Automatic service discovery
5154
- Load balancing handled by Kubernetes
5255

5356
### ✅ Separation of Concerns
57+
5458
- vLLM models in separate pods
5559
- Independent scaling
5660
- Better resource isolation
@@ -185,24 +189,29 @@ oc rollout status deployment/semantic-router -n vllm-semantic-router-system
185189
## Comparison: Alternative Approaches
186190

187191
### ❌ Hardcoded IPs (Original)
192+
188193
```yaml
189194
address: "172.30.64.134" # Works only on specific cluster
190195
```
191196
192197
### ❌ Localhost (Sidecar Pattern)
198+
193199
```yaml
194200
address: "127.0.0.1" # Requires all containers in same pod
195201
```
196202
197203
### ✅ Dynamic IPs (Current Solution)
204+
198205
```yaml
199206
address: "$DISCOVERED_IP" # Works on any cluster
200207
```
201208
202209
### 🚀 DNS Names (Future Enhancement)
210+
203211
```yaml
204212
address: "vllm-model-a.vllm-semantic-router-system.svc.cluster.local"
205213
```
214+
206215
**Note**: Requires Go code changes to accept DNS names (see `src/semantic-router/pkg/config/validator.go`)
207216

208217
## Future Improvements

deploy/openshift/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ cd deploy/openshift
2020
```
2121

2222
This script will:
23+
2324
- ✅ Build the llm-katan image from Dockerfile
2425
- ✅ Create namespace and PVCs
2526
- ✅ Deploy vLLM model services (model-a and model-b)

0 commit comments

Comments
 (0)