logpile no longer carries its own archive/vendor parsers or Redfish raw-payload replay/analysis engine. Both now live in git.mchus.pro/reanimator/parser/v13 (already used by the sibling `core` project), reached through parser.NewService().AnalyzeArchivePayload / AnalyzeRedfishRawPayloads. logpile keeps live BMC/Redfish collection, the DB, exporter, server and UI. - Deleted internal/parser/ (interface, registry, archive extraction, all vendor packages), internal/collector/redfish_replay*.go (replay engine, confirmed near-identical to the module's redfish/ package), internal/ingest/ (pure duplicate of the module's Service), internal/models/ (repointed every import to the module's models package instead), and internal/rar5 (only used by the deleted archive extractor). Removed the now-unused third_party/pciids submodule. - internal/collector/redfish.go: Collect() now calls parser.NewService().AnalyzeRedfishRawPayloads(...) at the one place it used to call the local ReplayRedfishFromRawPayloads (an existing "unified tunnel" between live collection and raw import). A deadcode-driven pass then removed ~150 doc-to-model conversion helpers in redfish.go that duplicated the module's redfish/ package and were already unreachable before this change; kept the small generic dedup/scoring helpers the live crawler still calls. - internal/collector/redfishprofile/ stays whole: Collect() depends on it directly for acquisition-time tuning. Its analysis-only methods (ApplyAnalysisProfiles/PostAnalyze) are now dead but left in place rather than splitting the package's single Profile interface. - pciids moved with the module (now a public package there); logpile's live collector and exporter import it from there instead of keeping a local copy. - go.mod: new require on git.mchus.pro/reanimator/parser/v13 v13.0.0 (plain module dependency, not a submodule like reanimator/chart, since this module is independently versioned and shared with core). - bible-local docs rewritten for the new boundary; see ADL-080. See also the companion change in git.mchus.pro/reanimator/parser (tagged v13.0.0): new top-level exports (IsSupportedArchiveFilename/SupportedArchiveExtensions/ ParseInDefaultArchiveLocation/PrivacyScanEnabled) and pciids moved to a public package, both needed to complete this migration. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
45 lines
2.0 KiB
Markdown
45 lines
2.0 KiB
Markdown
# LOGPile Bible
|
|
|
|
`bible-local/` is the project-specific source of truth for LOGPile.
|
|
Keep top-level docs minimal and put maintained architecture/API contracts here.
|
|
|
|
## Rules
|
|
|
|
- Documentation language: English only
|
|
- Update relevant bible files in the same change as the code
|
|
- Record significant architectural decisions in [`10-decisions.md`](10-decisions.md)
|
|
- Do not duplicate shared rules from `bible/`
|
|
|
|
## Read order
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [01-overview.md](01-overview.md) | Product scope, modes, non-goals |
|
|
| [02-architecture.md](02-architecture.md) | Runtime structure, state, main flows |
|
|
| [04-data-models.md](04-data-models.md) | Stable data contracts and canonical inventory |
|
|
| [03-api.md](03-api.md) | HTTP endpoints and response contracts |
|
|
| [05-collectors.md](05-collectors.md) | Live collection behavior |
|
|
| [06-parsers.md](06-parsers.md) | Archive parser framework and vendor coverage |
|
|
| [07-exporters.md](07-exporters.md) | Raw export, Reanimator export, batch convert |
|
|
| [docs/hardware-ingest-contract.md](docs/hardware-ingest-contract.md) | Reanimator ingest schema mirrored locally |
|
|
| [docs/privacy-scan.md](docs/privacy-scan.md) | Customer-data / anonymization scan of ingested sources |
|
|
| [docs/log-sanitization.md](docs/log-sanitization.md) | In-place, length-preserving redaction of customer data |
|
|
| [08-build-release.md](08-build-release.md) | Build and release workflow |
|
|
| [09-testing.md](09-testing.md) | Test expectations and regression rules |
|
|
| [10-decisions.md](10-decisions.md) | Architectural Decision Log |
|
|
|
|
## Fast orientation
|
|
|
|
- Entry point: `cmd/logpile/main.go`
|
|
- HTTP layer: `internal/server/`
|
|
- Core contracts: `git.mchus.pro/reanimator/parser/v13/models`
|
|
- Live collection: `internal/collector/`
|
|
- Archive parsing and Redfish analysis: external module `git.mchus.pro/reanimator/parser/v13` (see `06-parsers.md`)
|
|
- Export conversion: `internal/exporter/`
|
|
- Frontend consumer: `web/static/js/app.js`
|
|
|
|
## Maintenance rule
|
|
|
|
If a document becomes stale, either fix it immediately or delete it.
|
|
Stale docs are worse than missing docs.
|