Document full architecture, design, API, features, deployment, and security.

Adds diagrams and expands the ATC demo path so the cockpit is fully described in-repo.
2026-07-17 04:04:32 +02:00
parent b73ff9465c
commit c2bb0465d0
9 changed files with 951 additions and 22 deletions
@@ -1,23 +1,94 @@
 # Dell OpenManage Cockpit (ATC)

-Interactive fleet operations UI for Dell OpenManage Enterprise.
+Interactive operations cockpit for **Dell OpenManage Enterprise** in the Dell ATC lab.

-## Features
- Live topology (Orbit / Galaxy / Clusters / Lanes / Helix)
- KPI context popups, triage, ops desk tickets
- In-browser SSH terminal (own username/password)
- Cockpit chat against vLLM / OpenManage AI models
- Full inventory + application/firmware landscape from OME
+**Live URL (lab):** http://atc-portal01.dell-atc.lan:3090  
+**Forgejo:** http://atc-mgt01.dell-atc.lan:3001/mo/ome-cockpit  
+**Companion AI stack:** http://atc-mgt01.dell-atc.lan:3001/mo/openmanage-ai · http://atc-portal01.dell-atc.lan:3080
+
+---
+
+## What it is
+
+A single-pane ops UI for ATC admins (Jody van Dongen, Laurens Rammers, Mohamed El Kadi) that:
+
+- Polls OME for devices, power, alerts, and groups
+- Renders a live topology with multiple layouts and color modes
+- Surfaces KPI context popups, realtime triage, and an ops ticket desk
+- Embeds an in-browser SSH terminal (user-chosen credentials)
+- Chats against vLLM / OpenManage AI models with a live fleet context pack
+- Loads full OME inventory + firmware/software landscape per device
+
+---
+
+## Documentation map
+
+| Doc | Contents |
+|-----|----------|
+| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | System context, components, data flows, protocols |
+| [docs/DESIGN.md](docs/DESIGN.md) | Visual language, layout, interaction design |
+| [docs/API.md](docs/API.md) | HTTP + WebSocket API reference |
+| [docs/FEATURES.md](docs/FEATURES.md) | Feature catalog (UI + backend behaviors) |
+| [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) | Install, env, ports, ops, troubleshooting |
+| [docs/SECURITY.md](docs/SECURITY.md) | Secrets, SSH allowlist, multi-user limits |
+| [DEMO.md](DEMO.md) | Short demo script for ATC walkthroughs |
+
+---
+
+## Quick start

-## Run
 ```bash
-cp .env.example .env   # fill OME + vLLM settings
+cp .env.example .env
+# Fill OME_URL / OME_USER / OME_PASSWORD, VLLM_URL, GPU_METRICS_URL, OPENWEBUI_*
 docker compose up -d --build
 ```

-UI: `http://<host>:3090`
+Open http://localhost:3090

-## Layout
- `api/main.py` — FastAPI (OME poll, chat, SSH bridge, tickets)
- `ui/` — static frontend
- `docker-compose.yml` / `Dockerfile`
+Hot-reload: `ui/` and `api/main.py` are bind-mounted read-only into the container.
+
+---
+
+## Repository layout
+
+```
+ome-cockpit/
+├── api/
+│   ├── main.py              # FastAPI app (OME poll, WS, chat, SSH, tickets)
+│   ├── requirements.txt
+│   └── Dockerfile           # (legacy/alternate; root Dockerfile is used)
+├── ui/
+│   ├── index.html           # Shell + modals
+│   ├── app.js               # Topology canvas, KPIs, filters, inspector
+│   ├── ops.js               # Ops desk, chat drawer, triage, feed collapse
+│   ├── ssh.js               # In-browser SSH client (xterm)
+│   ├── styles.css
+│   ├── vendor/xterm/        # Vendored xterm + fit addon (no CDN dependency)
+│   └── dell*.png|svg        # Branding
+├── data/                    # Runtime SQLite (gitignored)
+├── docker-compose.yml
+├── Dockerfile
+├── .env.example
+└── docs/
+```
+
+---
+
+## Lab topology (reference)
+
+```
+┌────────────────────┐     poll/REST      ┌──────────────────────────┐
+│  ome-cockpit :3090 │ ───────────────►   │ cov-omeprod01 (OME 4.7)  │
+│  atc-portal01      │                    │ 10.0.21.104              │
+└────────┬───────────┘                    └──────────────────────────┘
+         │
+         ├─ chat/completions ──► vLLM atc-gpu-prod :8000 (llama3-70b-gptq)
+         ├─ /api/gpu ──────────► GPU metrics sidecar :9110
+         └─ optional models ───► OpenManage AI Open WebUI :3080
+```
+
+---
+
+## License / ownership
+
+Internal Dell ATC lab tooling. Not for public redistribution of credentials or production secrets.