Skip to content

Commit 8c583b3

Browse files
committed
docs: add TOPOLOGY.md
1 parent 37fbb5d commit 8c583b3

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
3+
4+
# TOPOLOGY.md — verisimdb-data
5+
6+
## Purpose
7+
8+
VeriSimDB Data Repository is a git-backed flat-file storage system for scan results and drift detection data. Receives panic-attack scan results, hardware-crash-team findings, and drift detection snapshots via GitHub Actions workflow_dispatch events. Maintains master index and enables historical analysis of repository health and compliance drift over time.
9+
10+
## Module Map
11+
12+
```
13+
verisimdb-data/
14+
├── scans/ # panic-attack scan results per repo
15+
├── hardware/ # hardware-crash-team findings
16+
├── drift/ # drift detection snapshots
17+
├── index.json # Master index of all stored data
18+
└── .github/workflows/ # Ingest workflows (receive results)
19+
```
20+
21+
## Data Flow
22+
23+
```
24+
[Workflow Dispatch] ──► [Ingest Handler] ──► [JSON Validation] ──► [File Storage]
25+
26+
[Index Update] ──► [Query Ready]
27+
```
28+
29+
## Integration Points
30+
31+
- **panic-attack**: Upstream scanner sending results
32+
- **hardware-crash-team**: Hardware failure analysis
33+
- **Drift detection**: Compliance change tracking
34+
- **Hyperpolymath CI/CD**: Automated data aggregation

0 commit comments

Comments
 (0)