aberration documentation¶

Documentation for the aberration predictive-maintenance platform.

Use the guides below for setup, operation, and development. The Archive retains material from the former GitHub wiki for reference.

When to use this page¶

Use this page as the entry point to choose the right runbook for your role.

Start here¶

• Getting started: first local run from clone to a healthy stack.
• Environment variables: runtime configuration and validation rules.
• Deployment modes: local, cluster, Swarm, and external-ingress operations.

User guide¶

• Web app: account, charger, favorites, services, and anomaly workflows.
• Monitoring: monitoring strategies and workload lifecycle.

Developer guide¶

• Developer setup: supported local toolchain, run modes, and debug workflows.
• Architecture overview: service interplay, data flows, dependencies, and failure paths.
• Monitoring pipelines: graph contracts, numerical ownership, activation, bounded inspection and rollout.
• Backend API guide: endpoint contracts, examples, and errors.
• Data model: core entities and relationships.
• Testing and debugging: test commands, health checks, and triage playbooks.
• Contributing and CI: contribution process and current CI checks.