docs: update architecture documentation and manifests
Refine technical documentation to reflect current architecture, component structure, and routing conventions for the vcon console.
This commit is contained in:
1 parent
bb938c33c0
commit
367dd819f8
64 files changed
+910
-2661
No files matched your search
+14
-13
@@ -1,16 +1,17 @@
|
||||
# VCON Admin Console Manifest
|
||||
# Admin Console (`/vcon/*`) Manifest
|
||||
|
||||
## Purpose
|
||||
The `/vcon/*` route hosts the full administration control center for DataStack:
|
||||
- **dashboard**: Realtime metrics, buffer queue, disk usage, quick simulation trigger
|
||||
- **clients**: SDK registration, JWT handshake token creation, rate limits
|
||||
- **data**: Live incoming stream inspector with client filters and search
|
||||
- **export**: CSV dataset exporter and streaming downloads
|
||||
- **storage**: Disk inspection of `/storage/data/{clientId}/{YYYY-MM-DD}.csv` partitions and flush triggers
|
||||
- **settings**: Platform limits, rotation sizes, buffer thresholds, and JWT secret management
|
||||
- **sdk**: Pip-installable Python SDK guide and pre-configured client code generator
|
||||
- **simulator**: In-browser event emission and batch bursting tester.
|
||||
The `/vcon/*` routes provide the administration interface for managing DataStack clients, inspecting event streams, configuring runtime parameters, and exporting stored CSV datasets.
|
||||
|
||||
## Conventions
|
||||
- Standard URL handler for all inner pages so page refreshes never redirect to home.
|
||||
- Zero-radius, zero-shadow compact UI styling using global tokens.
|
||||
## Routes
|
||||
- `dashboard/page.tsx`: Live ingestion metrics, active Socket.IO connection count, buffer utilization, and recent events table.
|
||||
- `clients/page.tsx`: Client SDK registration, JWT credential issuance, key rotation, status revocation, and permanent client deletion.
|
||||
- `data/page.tsx`: Paginated CSV event browser with client filtering, keyword search, and JSON payload inspection.
|
||||
- `export/page.tsx`: Dataset export builder with date-range presets (`Today`, `7d`, `30d`, `All`) and streaming CSV/JSON downloads.
|
||||
- `storage/page.tsx`: On-disk CSV partition inspector (`/storage/data/{clientId}/{YYYY-MM-DD}.csv`) with manual buffer flush controls.
|
||||
- `settings/page.tsx`: Runtime configuration for rate limits, payload size bounds, buffer thresholds, file rotation size, retention pruning (`autoPruneDays`), and JWT secret.
|
||||
- `sdk/page.tsx`: Python SDK integration guide that populates ready-to-run code snippets with any registered client's signed JWT token.
|
||||
- `simulator/page.tsx`: Browser-based event generator for testing single and batch event ingestion pipelines.
|
||||
- `profile/page.tsx`: Administrator email and password management with current-password verification.
|
||||
- `login/page.tsx`: Administrator sign-in screen with brute-force lockout protection and optional 30-day session persistence.
|
||||
- `setup/page.tsx`: First-run administrator initialization screen protected by `DATASTACK_ADMIN_SETUP_KEY`.
|
||||
Reference in new issue
Block a user