Skip to content

docs: add system architecture, threat model, and data pipeline documentation#15

Open
TrishaG189 wants to merge 1 commit intoc2siorg:mainfrom
TrishaG189:docs/architecture-threat-model
Open

docs: add system architecture, threat model, and data pipeline documentation#15
TrishaG189 wants to merge 1 commit intoc2siorg:mainfrom
TrishaG189:docs/architecture-threat-model

Conversation

@TrishaG189
Copy link
Copy Markdown

Summary

Adds a foundational architecture.md document to the repository. As the project scales across multiple clouds (AWS, GCP) and contributors, it is critical to have a single source of truth explaining how the pieces fit together and the security boundaries we are enforcing.

What this adds

  • Mermaid.js System Diagram: Visually maps out the multi-cloud sensor nodes feeding back into the centralized AWS management plane.
  • Network Philosophy: Explicitly documents our "contain, don't propagate" egress rules.
  • Threat Model: A table detailing the assets we are protecting (Log integrity, TF state, Cloud IAM) and the mitigations we have put in place (append-only logs, least-privilege SA, DynamoDB locking).

Why this matters

New contributors need to understand why we build things a certain way (e.g., why we need remote state, why egress is restricted). This document serves as the onboarding blueprint and the standard against which future architectural decisions can be reviewed.

Resolves #12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Add System Architecture, Threat Model, and Data Pipeline Docs

1 participant