35 lines
1.8 KiB
Markdown
35 lines
1.8 KiB
Markdown
# Source & Job Orchestrator agent guide
|
|
|
|
## Mission
|
|
The Orchestrator schedules, observes, and recovers ingestion and analysis jobs across the StellaOps platform.
|
|
|
|
## Key docs
|
|
- [Module README](./README.md)
|
|
- [Architecture](./architecture.md)
|
|
- [Implementation plan](./implementation_plan.md)
|
|
- [Task board](./TASKS.md)
|
|
|
|
## How to get started
|
|
1. Read the design summaries in ./architecture.md (quota governance, job lifecycle, dashboard feeds).
|
|
2. Open sprint file `/docs/implplan/SPRINT_*.md` and locate stories for this component.
|
|
3. Check ./TASKS.md and update status before/after work.
|
|
4. Review ./README.md for responsibilities and ensure changes maintain determinism and offline parity.
|
|
|
|
## Guardrails
|
|
- Uphold Aggregation-Only Contract boundaries when consuming ingestion data.
|
|
- Preserve determinism and provenance in all derived outputs.
|
|
- Document offline/air-gap pathways for any new feature.
|
|
- Update telemetry/observability assets alongside feature work.
|
|
## Required Reading
|
|
- `docs/modules/jobengine/README.md`
|
|
- `docs/modules/jobengine/architecture.md`
|
|
- `docs/modules/jobengine/implementation_plan.md`
|
|
- `docs/modules/platform/architecture-overview.md`
|
|
|
|
## Working Agreement
|
|
- 1. Update task status to `DOING`/`DONE` in both correspoding sprint file `/docs/implplan/SPRINT_*.md` and the local `TASKS.md` when you start or finish work.
|
|
- 2. Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
|
|
- 3. Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
|
|
- 4. Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
|
|
- 5. Revert to `TODO` if you pause the task without shipping changes; leave notes in commit/PR descriptions for context.
|