Sharang Parnerkar 8b27ca688b
ci / shared (pull_request) Successful in 12s
docs(arch): align INFRASTRUCTURE + PLATFORM_ARCHITECTURE to cluster split
Aligns the two remaining architecture docs with the 2026-06-30 cluster-split decision now reflected in IMPLEMENTATION_PLAN.md (PR #6, sha a8593091) and platform/orca-platform PR #6 (sha 6be727d4). Same 4 VMs in the same flavors; what changes is the operational organization (3 clusters, 1 per plane, Identity + Infra co-tenant) and the naming (vm-data → vm-app-prod, stage → vm-app-stage, Data plane → App plane).

INFRASTRUCTURE.md
- Prelude block under title summarises the cluster split + legal-entity gate, and notes SLA targets in §6/§7 are unaffected (they apply at plane level).
- §1 VM Inventory: rewritten box adds a Cluster column; 4 VMs across 3 clusters (vm-edge, vm-control, vm-app-prod, vm-app-stage). Bullet list of "critical isolations preserved" updated for vm-app-prod / vm-app-stage and JVM-pin phrasing.
- §2 Service-to-VM Mapping: each VM block now carries its cluster name in the header; KC repurpose called out on the keycloak-26 line; vm-app-stage block updated to explain it shares a cluster with vm-app-prod, and the "calls OUT" list now names which cluster each prod dependency lives in.
- §5 Backup table: "Data Plane" → "App Plane" in the owner column.
- §6 Plane ownership boxes: each box now names its cluster + VMs. Identity box gets the JVM-pin escape hatch + the CERTifAI-KC repurpose note. Control box notes vm-app-stage callers go through the same tenant-registry under tenant.kind = "stage". App Plane box (was Data Plane) covers both vm-app-prod and vm-app-stage and the cluster-sharing model. Infra box notes per-cluster backup buckets.
- §10 Scenario E header: "Stage VM compromised or buggy" → "vm-app-stage compromised or buggy".
- All mechanical vm-data → vm-app-prod renames across the rest of the doc.

PLATFORM_ARCHITECTURE.md
- Prelude block summarises the cluster split and explicitly preserves the plane vocabulary as the SLA + ownership abstraction.
- §3 The Four Planes: diagram annotated with cluster + VM per plane; Plane 3 relabeled "APP (was DATA)"; closing paragraph explains the stage/prod sharing within the App cluster.
- §6 renamed "Plane 3 — Data" → "Plane 3 — App (was 'Data')" with the rationale (carries product workloads, not just storage).
- §7 Plane 4 — Infra: leading paragraph spells out Identity+Infra co-tenancy on vm-edge, the JVM-pin invariant, and the escape hatch. Orchestration bullet rewritten for per-node ingress + 3 clusters + per-cluster IaC repo.

No changes to product semantics, JWT shape, role definitions, RPO/RTO numbers, or the dependency graph. Only the operational organization + naming.
2026-06-30 23:29:27 +02:00

docs

Platform-wide architecture, integration spec, runbooks.

Part of the Breakpilot Platform. For the big picture see platform/docs: Architecture · Infrastructure · Product Integration Spec · Implementation Plan

What this is

Platform-wide architecture, integration spec, runbooks. Scaffolded under milestone M0.1. See platform/docs for the full architecture context.

Plane: Control Owner: @sharang Status: pre-alpha Linked milestone: M0.1

Run locally

# prerequisites: see CONTRIBUTING.md for tooling once code lands
make dev          # starts dependencies + this service on http://localhost:3000
make test         # unit + integration
make e2e          # only if this repo ships user-facing flows

Local secrets come from .env.local (gitignored). Template at .env.example.

Endpoints / surface

{{For services: list the top-level routes or commands. For libraries: list the public API entry points. For IaC: list the make targets.}}

Deployment

Env URL How
dev http://localhost:3000 make dev
stage https://docs.stage.breakpilot.com auto on merge to main
prod https://docs.breakpilot.com manual: tag vX.Y.Z + sign-off

Rollback: orca rollout undo docs --env={{env}}.

Observability

  • Traces, logs, metrics: SigNoz — service name docs
  • Audit events: Tenant Registry /audit (Retraced-shape schema)
  • On-call: oncall@breakpilot.com · runbook at platform/docs/runbooks/docs.md

Contributing

See CONTRIBUTING.md. TL;DR: branch from main, open a PR, 1 review + green CI, squash-merge.

License

Proprietary — all rights reserved. Copyright (c) 2026 Sharang Parnerkar and Benjamin Boenisch. See LICENSE.

S
Description
Platform-wide architecture, integration spec, runbooks.
Readme
292 KiB
Languages
JavaScript 100%