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
@@ -0,0 +1,75 @@
+# Diagrams
+
+## End-to-end context
+
+```mermaid
+flowchart LR
+  Admin[ATC Admin Browser]
+  Cockpit[OME Cockpit :3090]
+  OME[OpenManage Enterprise]
+  VLLM[vLLM llama3-70b]
+  GPU[GPU metrics :9110]
+  OWUI[OpenManage AI :3080]
+  Node[Server / iDRAC SSH]
+
+  Admin -->|HTTPS/HTTP + WS| Cockpit
+  Cockpit -->|REST session| OME
+  Cockpit -->|chat/completions| VLLM
+  Cockpit -->|models + virtual chat| OWUI
+  Cockpit -->|/api/gpu| GPU
+  Admin -->|xterm WS /ws/ssh| Cockpit
+  Cockpit -->|asyncssh| Node
+```
+
+## Fleet poll sequence
+
+```mermaid
+sequenceDiagram
+  participant P as poll_loop
+  participant O as OME
+  participant S as STATE
+  participant WS as Browser WS clients
+
+  P->>O: Session login
+  P->>O: Devices / Groups / Alerts / Power samples
+  P->>P: Normalize + diff PREV_DEVICES
+  P->>S: Update snapshot + events
+  P->>WS: broadcast snapshot
+  P->>O: Session delete
+```
+
+## SSH session
+
+```mermaid
+sequenceDiagram
+  participant UI as ssh.js / xterm
+  participant API as /ws/ssh
+  participant Target as Device SSHD
+
+  UI->>API: auth JSON (user/pass/host)
+  API->>API: allowlist host in fleet
+  API->>Target: asyncssh connect + shell
+  API-->>UI: ready
+  loop Terminal I/O
+    UI->>API: keystrokes
+    API->>Target: stdin
+    Target-->>API: stdout
+    API-->>UI: terminal text
+  end
+```
+
+## Frontend module map
+
+```mermaid
+flowchart TB
+  HTML[index.html shell]
+  APP[app.js topology + KPI + inspector]
+  OPS[ops.js tickets + chat + triage + feed]
+  SSH[ssh.js terminal]
+  HTML --> APP
+  HTML --> OPS
+  HTML --> SSH
+  APP <-->|window.cockpit| OPS
+  APP --> SSH
+  OPS --> SSH
+```