feat(docs): Add comprehensive documentation for Vexer, Vulnerability Explorer, and Zastava modules
- Introduced AGENTS.md, README.md, TASKS.md, and implementation_plan.md for Vexer, detailing mission, responsibilities, key components, and operational notes. - Established similar documentation structure for Vulnerability Explorer and Zastava modules, including their respective workflows, integrations, and observability notes. - Created risk scoring profiles documentation outlining the core workflow, factor model, governance, and deliverables. - Ensured all modules adhere to the Aggregation-Only Contract and maintain determinism and provenance in outputs.
This commit is contained in:
34
docs/modules/telemetry/README.md
Normal file
34
docs/modules/telemetry/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# StellaOps Telemetry
|
||||
|
||||
Telemetry module captures deployment and operations guidance for the shared observability stack (collectors, storage, dashboards).
|
||||
|
||||
## Responsibilities
|
||||
- Deploy and operate OpenTelemetry collectors for StellaOps services.
|
||||
- Provide storage configuration for Prometheus/Tempo/Loki stacks.
|
||||
- Document smoke tests and offline bootstrapping steps.
|
||||
- Align metrics and alert packs with module SLOs.
|
||||
|
||||
## Key components
|
||||
- Collector deployment guide (./operations/collector.md).
|
||||
- Storage deployment guide (./operations/storage.md).
|
||||
- Smoke tooling in `ops/devops/telemetry/`.
|
||||
|
||||
## Integrations & dependencies
|
||||
- DevOps pipelines for packaging telemetry bundles.
|
||||
- Module-specific dashboards (scheduler, scanner, etc.).
|
||||
- Security/Compliance for retention policies.
|
||||
|
||||
## Operational notes
|
||||
- Smoke script references (../../ops/devops/telemetry).
|
||||
- Bundle packaging instructions in ops/devops/telemetry.
|
||||
|
||||
## Related resources
|
||||
- ./operations/collector.md
|
||||
- ./operations/storage.md
|
||||
|
||||
## Backlog references
|
||||
- TELEMETRY-OBS-50-001 … 50-004 in ../../TASKS.md.
|
||||
- Collector/storage automation tracked in ops/devops/TASKS.md.
|
||||
|
||||
## Epic alignment
|
||||
- **Epic 15 – Observability & Forensics:** deliver collector/storage deployments, forensic evidence retention, and observability bundles with deterministic configuration.
|
||||
Reference in New Issue
Block a user