68 lines
3.4 KiB
Markdown
68 lines
3.4 KiB
Markdown
# StellaOps Platform
|
||
|
||
Platform module describes cross-cutting architecture, contracts, and guardrails that bind the services together.
|
||
|
||
## Latest updates (2025-12-29)
|
||
- Added Platform Service definition (`platform-service.md`) and sprint scope for service foundation.
|
||
- README updated to reflect runtime service ownership alongside cross-cutting docs.
|
||
- Platform-facing UI sprints now depend on Platform Service aggregation endpoints.
|
||
|
||
## Responsibilities
|
||
- Maintain the system-wide architecture overview and integration diagrams.
|
||
- Capture Aggregation-Only Contract guidance and migration playbooks.
|
||
- Document shared services such as API gateway, tenancy, quotas, and offline posture.
|
||
- Define and maintain Platform Service API contracts and aggregation behavior.
|
||
- Coordinate platform-wide epics and compliance checklists.
|
||
|
||
## Key components
|
||
- Architecture overview in `architecture-overview.md`.
|
||
- Platform architecture summary in `architecture.md`.
|
||
- High-level reference: `../../07_HIGH_LEVEL_ARCHITECTURE.md`.
|
||
|
||
## Integrations & dependencies
|
||
- All StellaOps services via shared contracts (AOC, telemetry, security).
|
||
- DevOps for release governance.
|
||
- Docs guild for cross-module onboarding.
|
||
|
||
## Operational notes
|
||
- Module spans architecture governance and the Platform Service aggregation APIs.
|
||
- Glossaries and guardrails cross-linked across docs; keep AOC references current.
|
||
- Status mirrors: sprint file and `docs/modules/platform/TASKS.md`.
|
||
|
||
## Backlog references
|
||
- DOCS-AOC-19-002/003 in ../../TASKS.md.
|
||
- Future platform epics under docs/implplan/SPRINTS.md.
|
||
|
||
## Implementation Status
|
||
|
||
### Current Objectives
|
||
- Maintain deterministic behaviour and offline parity across releases
|
||
- Keep documentation, telemetry, and runbooks aligned with latest sprint outcomes
|
||
- Coordinate cross-cutting contracts and guardrails across all modules
|
||
|
||
### Epic Milestones
|
||
- Epic 1 – AOC enforcement: authoritative guardrail docs, schemas, verifier checklists (ongoing maintenance)
|
||
- Epics 2 & 4 – Policy Engine/Studio: platform-wide governance, approvals, tenancy scopes (coordinated)
|
||
- Epic 5 – SBOM Graph Explorer: shared contracts for graph indexing and overlays (defined)
|
||
- Epics 6-11 – Cross-cutting contracts: Explorer, Lens, AI, Orchestrator, Notifications alignment (active)
|
||
|
||
### Coordination Approach
|
||
- Review AGENTS.md before starting new work
|
||
- Sync with cross-cutting teams via sprint files in docs/implplan/SPRINT_*.md
|
||
- Update implementation plan when scope, dependencies, or guardrails change
|
||
- Mirror status across sprint tracker and docs/modules/platform/TASKS.md
|
||
|
||
### Key Documentation Assets
|
||
- architecture-overview.md: system-wide integration diagrams
|
||
- AOC references: aggregation-only contract guidance and migration playbooks
|
||
- Offline guidance: sealed-mode deployments and air-gap operation procedures
|
||
- Glossaries and guardrails: cross-linked across all module documentation
|
||
|
||
### Technical Notes
|
||
- Platform includes the Platform Service runtime plus docs ownership
|
||
- Focus on architectural governance and cross-module aggregation endpoints
|
||
- Ensure discoverability of Offline Kit and AOC references from README/architecture
|
||
|
||
## Epic alignment
|
||
- Aligns with the Aggregation-Only Contract reference, Policy and Policy Studio guides, Graph/Vulnerability Explorer documentation, and the Orchestrator, Advisory AI, and Notifications implementation plans to keep platform guardrails consistent across services.
|