stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity

docs consolidation work

Browse Source
This commit is contained in:
StellaOps Bot
2025-12-25 10:53:53 +02:00
parent b9f71fc7e9
commit deb82b4f03
117 changed files with 852 additions and 847 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/technical/architecture/component-map.md
View File

@@ -4,7 +4,7 @@ Concise descriptions of every top-level component under `src/`, summarising the
## Advisory & Evidence Services
- **AdvisoryAI** — Experimental intelligence helpers that summarise and prioritise advisory data for humans. Ingests canonical observations from Concelier/Excititor, adds explainable insights, and feeds UI/CLI and Policy workflows. See `docs/modules/advisory-ai/architecture.md`.
- **Concelier** — Canonical advisory ingestion engine enforcing the Aggregation-Only Contract (AOC). Produces immutable observations/linksets consumed by Policy Engine, Graph, Scheduler, and Export Center. Docs in `docs/modules/concelier/architecture.md` and `docs/ingestion/aggregation-only-contract.md`.
- **Concelier** — Canonical advisory ingestion engine enforcing the Aggregation-Only Contract (AOC). Produces immutable observations/linksets consumed by Policy Engine, Graph, Scheduler, and Export Center. Docs in `docs/modules/concelier/architecture.md` and `docs/aoc/aggregation-only-contract.md`.
- **Excititor** — VEX statement normaliser applying AOC guardrails. Supplies VEX observations to Policy Engine, VEX Lens, Scheduler, and UI. Reference `docs/modules/excititor/architecture.md` and `docs/16_VEX_CONSENSUS_GUIDE.md`.
- **VexLens** — Provides focused exploration of VEX evidence, conflict analysis, and waiver insights for UI/CLI. Backed by Excititor and Policy Engine (`docs/modules/vex-lens/architecture.md`).
- **EvidenceLocker** — Long-term store for signed evidence bundles (DSSE, SRM, policy waivers). Integrates with Attestor, Export Center, Policy, and replay tooling (`docs/forensics/evidence-locker.md`).
@@ -40,7 +40,7 @@ Concise descriptions of every top-level component under `src/`, summarising the
- **TimelineIndexer** — Builds timelines of evidence/events for forensics and audit tooling (`docs/forensics/timeline.md`).
## Notification & UI
- **Notifier** — Current notifications studio (WebService + Worker under `src/Notifier/StellaOps.Notifier`) delivering rule evaluation, digests, incidents, and channel plug-ins. Built on the shared `StellaOps.Notify.*` libraries; see `docs/notifications/overview.md` and `src/Notifier/StellaOps.Notifier/docs/NOTIFY-SVC-38-001-FOUNDATIONS.md`.
- **Notifier** — Current notifications studio (WebService + Worker under `src/Notifier/StellaOps.Notifier`) delivering rule evaluation, digests, incidents, and channel plug-ins. Built on the shared `StellaOps.Notify.*` libraries; see `docs/modules/notify/overview.md` and `src/Notifier/StellaOps.Notifier/docs/NOTIFY-SVC-38-001-FOUNDATIONS.md`.
- **Notify (shared libraries / archival hosts)** — The former `StellaOps.Notify.WebService|Worker` hosts were archived on 2025-10-26. The directory now provides the reusable engine, storage, queue, and connector plug-ins that Notifier composes. Legacy guidance in `docs/modules/notify/architecture.md` remains as migration context until the Notifications Studio docs fully supersede it.
- **UI** — Angular console surfacing scans, policy authoring, VEX evidence, runtime posture, and admin flows. Talks to Web gateway, Authority, Policy, Concelier, Scheduler, Notify, etc. (`docs/modules/ui/architecture.md`).
- **DevPortal** — Developer onboarding portal consuming Api definitions, CLI samples, and Authority auth flows (`docs/modules/devops/architecture.md`, dev portal sections).

3
docs/technical/development/README.md
View File

@@ -28,5 +28,4 @@ Resources for contributors building features, plug-ins, connectors, and tests.
- [../examples/policies/README.md](../../examples/policies/README.md) – sample policy bundles.
- Console UI development: `docs/modules/ui/README.md` and `docs/modules/ui/architecture.md`.
- [../task-packs/](../../task-packs/) – reusable task templates for sprints.
- [../faq/policy-faq.md](../../faq/policy-faq.md) – policy author FAQ.
- [../faq/](../../faq/) – additional Q&A sets useful during development.
- [../policy/faq.md](../../policy/faq.md) – policy author FAQ.

4
docs/technical/interfaces/README.md
View File

@@ -28,9 +28,9 @@ Specifications covering APIs, data contracts, event envelopes, and enforcement m
- [../observability/policy.md](../../observability/policy.md) and [../observability/ui-telemetry.md](../../observability/ui-telemetry.md) – telemetry event guidance.
## Ingestion & Evidence Contracts
- [../ingestion/aggregation-only-contract.md](../../ingestion/aggregation-only-contract.md) – Aggregation-Only Contract reference.
- [aggregation-only-contract.md](../../aoc/aggregation-only-contract.md) – Aggregation-Only Contract reference.
- [../aoc/aoc-guardrails.md](../../aoc/aoc-guardrails.md) – guardrails checklist.
- [../advisories/aggregation.md](../../advisories/aggregation.md) – advisory observation schema.
- [observations-linksets.md](../../modules/concelier/observations-linksets.md) – advisory observation schema.
- [../vex/aggregation.md](../../vex/aggregation.md) – VEX observation schema.
- [../../modules/concelier/operations/connectors/](../../modules/concelier/operations/connectors/) – connector-specific payload notes.

8
docs/technical/observability/README.md
View File

@@ -16,10 +16,10 @@ Guides for capturing metrics, logs, traces, and delivering notifications.
- [../../modules/export-center/provenance-and-signing.md](../../modules/export-center/provenance-and-signing.md) – provenance event integration.
## Notifications Studio
- [../notifications/overview.md](../../notifications/overview.md) – architecture and channels.
- [../notifications/rules.md](../../notifications/rules.md) – rule authoring.
- [../notifications/templates.md](../../notifications/templates.md) – template management.
- [../notifications/digests.md](../../notifications/digests.md) – digest scheduling.
- [../../modules/notify/overview.md](../../modules/notify/overview.md) – architecture and channels.
- [../../modules/notify/rules.md](../../modules/notify/rules.md) – rule authoring.
- [../../modules/notify/templates.md](../../modules/notify/templates.md) – template management.
- [../../modules/notify/digests.md](../../modules/notify/digests.md) – digest scheduling.
- [../../modules/notify/architecture.md](../../modules/notify/architecture.md) & [../../modules/notify/implementation_plan.md](../../modules/notify/implementation_plan.md) – implementation detail.
## Metrics & Dashboards

6
docs/technical/operations/README.md
View File

@@ -4,7 +4,7 @@ Deployment, runtime operations, and air-gap playbooks for running Stella Ops i
## Install & Upgrade
- [../21_INSTALL_GUIDE.md](../../21_INSTALL_GUIDE.md) – canonical install guide (Docker, air-gap considerations).
- [../install/docker.md](../../install/docker.md) – Docker install recipes.
- [../operations/console-docker-install.md](../../operations/console-docker-install.md) – Docker install recipes.
- [../deploy/containers.md](../../deploy/containers.md) – container deployment guidance for AOC environments.
- [../deploy/console.md](../../deploy/console.md) – console deployment specifics.
- [../13_RELEASE_ENGINEERING_PLAYBOOK.md](../../13_RELEASE_ENGINEERING_PLAYBOOK.md) – release automation, signing, reproducibility.
@@ -31,8 +31,8 @@ Deployment, runtime operations, and air-gap playbooks for running Stella Ops i
## Module Runbooks & Ops Guides
- Module operations directories under [../../modules/](../../modules/) (Authority backups/monitoring, Concelier connectors, Scanner analyzers, Scheduler worker dashboards, Export Center runbook, DevOps launch readiness, Telemetry collector/storage, etc.).
- [../runtime/SCANNER_RUNTIME_READINESS.md](../../runtime/SCANNER_RUNTIME_READINESS.md) – runtime readiness checklist.
- Notifications Studio operations: see [../notifications/architecture.md](../../notifications/architecture.md), [../notifications/overview.md](../../notifications/overview.md), [../notifications/rules.md](../../notifications/rules.md), [../notifications/templates.md](../../notifications/templates.md), [../notifications/digests.md](../../notifications/digests.md).
- Additional notification flows: [../notifications/pack-approvals-integration.md](../../notifications/pack-approvals-integration.md).
- Notifications Studio operations: see [../modules/notify/architecture.md](../../modules/notify/architecture.md), [../modules/notify/overview.md](../../modules/notify/overview.md), [../modules/notify/rules.md](../../modules/notify/rules.md), [../modules/notify/templates.md](../../modules/notify/templates.md), [../modules/notify/digests.md](../../modules/notify/digests.md).
- Additional notification flows: [../modules/notify/pack-approvals-integration.md](../../modules/notify/pack-approvals-integration.md).
- Observability operations: [../observability/observability.md](../../observability/observability.md), [../observability/ui-telemetry.md](../../observability/ui-telemetry.md).
## DevOps & Release Automation

4
docs/technical/process/README.md
View File

@@ -15,8 +15,8 @@ Use these artefacts to understand team ownership, active workstreams, and histor
## Communication & Updates
- Architecture decision records: [../adr/index.md](../../adr/index.md) (template in [../adr/0000-template.md](../../adr/0000-template.md)).
- RFCs in flight: [../rfcs/authority-plugin-ldap.md](../../rfcs/authority-plugin-ldap.md).
- Release notes & updates: [../updates/](../../updates/).
- Frequently asked questions: [../faq/](../../faq/).
- Release notes & updates: [../implplan/archived/updates/](../../implplan/archived/updates/).
- Policy FAQ: [../policy/faq.md](../../policy/faq.md).
- Examples and golden data: [../examples/](../../examples/), [../events/samples/](../../events/samples/).
## Supporting References

2
docs/technical/security/README.md
View File

@@ -32,4 +32,4 @@ Authoritative sources for threat models, governance, compliance, and security op
## Supporting Material
- Module operations security notes: [../../modules/authority/operations/key-rotation.md](../../modules/authority/operations/key-rotation.md), [../../modules/concelier/operations/authority-audit-runbook.md](../../modules/concelier/operations/authority-audit-runbook.md), [../../modules/zastava/README.md](../../modules/zastava/README.md) (runtime enforcement).
- [../observability/policy.md](../../observability/policy.md) – security-relevant telemetry for policy.
- [../updates/2025-10-27-console-security-signoff.md](../../updates/2025-10-27-console-security-signoff.md) & [../updates/2025-10-31-console-security-refresh.md](../../updates/2025-10-31-console-security-refresh.md) – recent security sign-offs.
- [../implplan/archived/updates/2025-10-27-console-security-signoff.md](../../implplan/archived/updates/2025-10-27-console-security-signoff.md) & [../implplan/archived/updates/2025-10-31-console-security-refresh.md](../../implplan/archived/updates/2025-10-31-console-security-refresh.md) – recent security sign-offs.