From cc5eb811edb17422c434514f75aa5443682905fb Mon Sep 17 00:00:00 2001 From: Derek Date: Tue, 17 Nov 2026 14:34:18 +1100 Subject: [PATCH] docs(diagrams): drop per-diagram config from 12 non-flowchart diagrams Twelve sequence, state, class and ER diagrams had a partial copy of the house flowchart frontmatter. The house block is for flowcharts only, so diagram-check flagged each one under R9. The frontmatter is removed and the diagram bodies are unchanged. diagram-check reports 0 findings across the engine's 62 diagrams. The gitcrud package docstring pointed at a "Governed Ops" section of docs/architecture.md that no longer exists. It points at docs/control-plane/governed-ops-design.md. --- docs/control-plane/governed-ops-design.md | 176 ---------------------- docs/control-plane/idp-setup/entra.md | 44 ------ docs/control-plane/idp-setup/google.md | 44 ------ docs/control-plane/rbac-groups.md | 44 ------ docs/control-plane/rbac.md | 88 ----------- docs/data-plane/query-api.md | 44 ------ docs/data-plane/source-flow.md | 44 ------ docs/data-plane/source-registry.md | 44 ------ src/dfe_engine/gitcrud/__init__.py | 4 +- 9 files changed, 2 insertions(+), 530 deletions(-) diff --git a/docs/control-plane/governed-ops-design.md b/docs/control-plane/governed-ops-design.md index 86a28a6f1..38d4fdb90 100644 --- a/docs/control-plane/governed-ops-design.md +++ b/docs/control-plane/governed-ops-design.md @@ -117,50 +117,6 @@ Every mutation ends in one commit through `GitopsRepo`, which uses dulwich rathe A Tier 1 var write is checked for the grant and the protected-var policy, then committed, against its `If-Match` base when the caller sends one. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- Writing a helm var accDescr: The Helm vars router checks the caller's grant, validates the write and the protected-var policy, then GitCrud sets the key against the If-Match base and GitopsRepo commits. Argo CD reconciles the commit. @@ -193,50 +149,6 @@ An `ActionDef` (`src/dfe_engine/governance/`) is a name, the permission needed t An action invoke checks the caller's grant and every change, then writes them all in one commit. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- Invoking an action accDescr: The governance router loads the action and checks the caller holds that action's required_action. ActionStore checks every change against the protected-var policy and writes them all in one commit through GitCrud. @@ -464,50 +376,6 @@ To claim, a worker reads the hunt free, inserts a lease row and a marker for its A fire goes from due to running to done, and an expired lease sends it back to due. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- stateDiagram-v2 direction LR accTitle: L4 Detail -- Hunt fire lifecycle @@ -528,50 +396,6 @@ Each run is incremental and crash-safe. Every statement holds a `{window}` place Three ReplacingMergeTree tables in the effective data database, keyed by `hunt_id`, coordinate the runners. `hunt_run` (one row per fire) and `hunt_runner_heartbeat` (one row per runner) sit beside them. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- erDiagram accTitle: L4 Detail -- Hunt coordination tables accDescr: hunt_lease holds the owner and lease expiry of each hunt's current fire, hunt_watermark how far each hunt has run, and hunt_state its overrun count and too_aggressive flag. All three are keyed by hunt_id. diff --git a/docs/control-plane/idp-setup/entra.md b/docs/control-plane/idp-setup/entra.md index 94584ad86..0c9723d5a 100644 --- a/docs/control-plane/idp-setup/entra.md +++ b/docs/control-plane/idp-setup/entra.md @@ -17,50 +17,6 @@ Once you turn on the groups claim, Entra puts each user's group object ids in th DFE signs in with Entra ID by code exchange, and reads the groups of a user in more than 200 from Microsoft Graph. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- Entra sign-in accDescr: The browser opens DFE sign-in and DFE redirects to Entra ID. Entra returns a code, which DFE exchanges for an ID token with the groups claim. For a user in more than 200 groups DFE reads the groups from Microsoft Graph with the user's token. diff --git a/docs/control-plane/idp-setup/google.md b/docs/control-plane/idp-setup/google.md index 20c2871d1..4d413799d 100644 --- a/docs/control-plane/idp-setup/google.md +++ b/docs/control-plane/idp-setup/google.md @@ -17,50 +17,6 @@ Google puts no groups in its sign-in token. So DFE asks for a read-only groups s DFE signs in with Google by code exchange, then reads the user's groups from the Cloud Identity API with the user's token. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- Google sign-in accDescr: The browser opens DFE sign-in and DFE redirects to Google with the Cloud Identity groups scope. DFE exchanges the code for an ID token and the user's access token, then searches the user's groups in the Cloud Identity API with that token. diff --git a/docs/control-plane/rbac-groups.md b/docs/control-plane/rbac-groups.md index 320668636..eeb3b5efe 100644 --- a/docs/control-plane/rbac-groups.md +++ b/docs/control-plane/rbac-groups.md @@ -7,50 +7,6 @@ This page is section 4.4 of [rbac.md](rbac.md), kept under that number so sectio A sync run for an api-mode provider lists every remote group and updates, creates or skips each one (`src/dfe_engine/auth/oidc/sync.py`). ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- OIDC group sync accDescr: The sync reads the provider from the registry, lists every group through the provider's adapter, and reads the stored groups. Each remote group then updates, creates or is skipped, and the sync writes the run's time and status back to the registry. diff --git a/docs/control-plane/rbac.md b/docs/control-plane/rbac.md index 2594fa3cc..43aa033c0 100644 --- a/docs/control-plane/rbac.md +++ b/docs/control-plane/rbac.md @@ -487,50 +487,6 @@ which the error handler converts to HTTP 403. Three YAML-backed stores hold accounts, groups and API keys, and the local login provider reads the first two. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- classDiagram accTitle: L4 Detail -- Auth stores accDescr: AccountStore, GroupStore and APIKeyStore are YAML-backed stores with one file per entity. LocalAuthProvider verifies a password through AccountStore and resolves roles through GroupStore. @@ -933,50 +889,6 @@ YAML-backed CRUD via `OrgRegistry`, one file per org in `orgs/` under `DFE_CONFI `POST /api/v1/orgs` stores the org's tenant ids in its hunts, creates the org, then reconciles ClickHouse RBAC and asks dfe-hyperdx for a team (`src/dfe_engine/api/v1/orgs.py`, `src/dfe_engine/orgs/lifecycle.py`). ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- Org creation accDescr: The orgs API stores the org's tenant ids in every hunt naming it, then creates the org in the registry. The registry's change requests a ClickHouse RBAC reconcile, and the API asks dfe-hyperdx for its team, where a failure is logged and the org stands. diff --git a/docs/data-plane/query-api.md b/docs/data-plane/query-api.md index fe11c82de..4bc4a71e6 100644 --- a/docs/data-plane/query-api.md +++ b/docs/data-plane/query-api.md @@ -28,50 +28,6 @@ A label-based query interface over ClickHouse parameterised views, with multi-te The route checks `query:execute` and fetches the view through the executor. The executor then keeps the declared parameters, injects `org_id` and runs the view on ClickHouse. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- View execution accDescr: The client posts to a view's execute route. The API asks the executor for the view, which reads it from the catalog. The API then calls execute, and the executor keeps the declared parameters, injects org_id and runs the view on ClickHouse. The rows return to the executor, the result to the API and JSON to the client. diff --git a/docs/data-plane/source-flow.md b/docs/data-plane/source-flow.md index bfad9c732..58d692c63 100644 --- a/docs/data-plane/source-flow.md +++ b/docs/data-plane/source-flow.md @@ -255,50 +255,6 @@ A transform can be a pipeline you run yourself. `engine: external` deploys nothi A source change is compiled, committed and applied by Argo CD, and Kubernetes rolls the pods. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- sequenceDiagram accTitle: L4 Detail -- A source change reaching a pod accDescr: A caller writes a source. The engine compiles every derived config and commits it to the deploy repo. Argo CD reads the commit and applies the ConfigMap and the Deployment, and Kubernetes rolls the app pods. diff --git a/docs/data-plane/source-registry.md b/docs/data-plane/source-registry.md index dbacdce44..d640e9025 100644 --- a/docs/data-plane/source-registry.md +++ b/docs/data-plane/source-registry.md @@ -25,50 +25,6 @@ A source has a tri-state lifecycle, not a boolean toggle: A source moves freely between active, dormant and disabled, and its table stays in every state. ```mermaid ---- -config: - theme: base - fontFamily: Inter, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif - themeVariables: - fontSize: 15px - lineColor: "#64748B" - primaryTextColor: "#0F172A" - clusterBorder: "#0072B2" - edgeLabelBackground: "#FFFFFF" - primaryColor: "#FFFFFF" - primaryBorderColor: "#334155" - secondaryColor: "#F8FAFC" - tertiaryColor: "#FFFFFF" - textColor: "#0F172A" - actorBkg: "#FFFFFF" - actorBorder: "#334155" - actorTextColor: "#0F172A" - actorLineColor: "#94A3B8" - signalColor: "#64748B" - signalTextColor: "#0F172A" - sequenceNumberColor: "#FFFFFF" - labelBoxBkgColor: "#FFFFFF" - labelBoxBorderColor: "#64748B" - labelTextColor: "#0F172A" - loopTextColor: "#0F172A" - noteBkgColor: "#FFFFFF" - noteBorderColor: "#94A3B8" - noteTextColor: "#0F172A" - transitionColor: "#64748B" - transitionLabelColor: "#0F172A" - stateLabelColor: "#0F172A" - stateBkg: "#FFFFFF" - labelBackgroundColor: "#FFFFFF" - compositeBackground: "#FFFFFF" - attributeBackgroundColorOdd: "#FFFFFF" - attributeBackgroundColorEven: "#F8FAFC" - themeCSS: >- - p{margin:0} - .node rect,.node polygon,.outer-path{filter:drop-shadow(0 1px 2px rgba(15,23,42,.10)) drop-shadow(0 6px 14px rgba(15,23,42,.10))!important} - .messageText,.loopText,.loopText tspan,.labelText,.labelText tspan{stroke:#FFFFFF!important;stroke-width:3px!important;paint-order:stroke;stroke-linejoin:round} - .edgeLabel,.edgeLabel p,.labelBkg{background:#FFFFFF!important} - .edgeLabel span{background:#FFFFFF!important;color:#1E293B} ---- stateDiagram-v2 direction LR accTitle: L4 Detail -- Source lifecycle diff --git a/src/dfe_engine/gitcrud/__init__.py b/src/dfe_engine/gitcrud/__init__.py index 20f697ed3..e94fabacb 100644 --- a/src/dfe_engine/gitcrud/__init__.py +++ b/src/dfe_engine/gitcrud/__init__.py @@ -8,8 +8,8 @@ """Governed Ops: one generic git-native CRUD engine for every YAML resource class. Every CRUD resource in DFE is YAML in git, so a single engine handles them all the -same way and RBAC is bound once at the class level. See docs/architecture.md -("Governed Ops") and docs/control-plane/gitops-commit-standard.md. +same way and RBAC is bound once at the class level. See +docs/control-plane/governed-ops-design.md and docs/control-plane/gitops-commit-standard.md. """ from .engine import (