Expand OpenManage AI documentation with architecture and deploy context.

Keeps runtime data and secrets out of git; documents relationship to OME Cockpit.
2026-07-17 04:04:33 +02:00
commit c0a545bf2c
8 changed files with 215 additions and 0 deletions
@@ -0,0 +1,50 @@
+# OpenManage AI — documentation
+
+**Forgejo:** http://atc-mgt01.dell-atc.lan:3001/mo/openmanage-ai  
+**Live:** http://atc-portal01.dell-atc.lan:3080  
+**Companion cockpit:** http://atc-mgt01.dell-atc.lan:3001/mo/ome-cockpit
+
+## Purpose
+
+Branded **Open WebUI** instance (`WEBUI_NAME=OpenManage AI`) for ATC demos, wired to:
+
+- vLLM OpenAI API (`OPENAI_API_BASE_URL` → `http://10.0.10.106:8000/v1`)
+- OME fleet REST tool (`ome_fleet`) for reliable natural-language fleet answers
+- Optional native OME MCP entry (often session-unstable in this lab)
+
+## Architecture
+
+```mermaid
+flowchart LR
+  User[Admin browser :3080]
+  OWUI[Open WebUI container]
+  VLLM[vLLM :8000]
+  OME[OME REST]
+
+  User --> OWUI
+  OWUI -->|chat/completions| VLLM
+  OWUI -->|tool ome_fleet| OME
+```
+
+## Recommended model
+
+Use **OME Copilot** (pipeline with tools), not only bare `llama3-70b-gptq`, when you need live OME facts.
+
+## Auth (lab)
+
+Local accounts (managed in Open WebUI DB), signup disabled after bootstrap.  
+Passwords are **not** stored in git — rotate via ops runbook.
+
+## Deploy
+
+```bash
+cd /home/lab/openmanage   # or clone this repo
+cp .env.example .env
+docker compose up -d
+```
+
+See `SETUP.md` and `DEMO.md` for operator steps and known MCP session caveats.
+
+## Relation to Cockpit
+
+Cockpit chat can list Open WebUI models and route `ome-copilot` / `arena-model` through Open WebUI when `OPENWEBUI_EMAIL` / `OPENWEBUI_PASSWORD` are configured on the cockpit side.