Sharang Parnerkar b849363b10
ci / shared (pull_request) Successful in 10s
docs(impl-plan): reflect 2026-06-30 cluster split decision
Updates the implementation plan to match the cluster-split decision
landed in platform/orca-platform PR #6 (commit 6be727d4):

§1.1 Repo strategy
  - Adds three cluster repos to the inventory:
    platform/breakpilot-edge   (Identity + Infra, vm-edge)
    platform/breakpilot-control (Control, vm-control)
    platform/breakpilot-app    (App, vm-app-prod + vm-app-stage)
  - Reframes platform/orca-platform as the staging area where the
    cluster manifests live design-only until the legal entity unlocks
    SysEleven / Hetzner business contracts at M1.2.

§1.8 Environments
  - Rewrites the three-clusters-by-env model into three-clusters-by-plane.
  - Stage and prod live in the same breakpilot-app cluster on different
    VMs (vm-app-stage and vm-app-prod); identity and control are NOT
    duplicated for stage.

M0.1 / M0.3 / M1.1 / M1.2 / M1.3
  - M0.1 note: the three cluster repos are NOT created at M0.1; they
    split out of orca-platform at M1.2.
  - M0.3 / M1.3 repo pointers re-targeted to breakpilot-edge.
  - M1.1 updated to describe the cluster-split layout that landed in
    PR #6: clusters/breakpilot-{edge,control,app}/services/ + per-cluster
    node whitelist in scripts/validate.sh.
  - M1.2 rewritten as "Provision VMs + split cluster repos": 4 VMs across
    3 clusters, KC repurposed from CERTifAI, legal-entity gate added,
    sized up to L.

M2.1 / M2.2 / M3.1 / M3.2
  - Fix vm-identity / vm-secrets typos to vm-edge.
  - M2.1 calls out the KC repurpose explicitly + the JVM-pin escape
    hatch (split KC to its own VM if heap fight shows up).
  - M3.2 re-pointed to breakpilot-control.

M8.x / M9.x / M18.x
  - ERPNext + Frappe HD repo pointers re-targeted to breakpilot-control.
  - M18.1 ACME work re-pointed to breakpilot-edge.
  - "data plane" → "app plane" everywhere; data-plane phrasing kept
    only where it refers to per-tenant data isolation as a concept.

PR-10 narrative updated: VM provisioning is a cluster split, gated on
legal entity.

No milestone IDs change; effort estimates change only for M1.2 (M→L)
to reflect the added repo-split + KC realm migration work.
2026-06-30 23:10:07 +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%