Skip to content

docs: document sidecar and standalone service deployment models - #11

Merged
chaodu-agent merged 2 commits into
openabdev:mainfrom
ttmuse:docs/deployment-models-readme
Nov 16, 2026
Merged

chaodu-agent merged 2 commits into
openabdev:mainfrom
ttmuse:docs/deployment-models-readme

Conversation

@ttmuse

@ttmuse ttmuse commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

Adds a Deployment models section to the README (after "How it works"), with a small Mermaid diagram comparing the two shapes.

  • Sidecar mode — the original in-cluster design and the shape Phase 1 implements: the proxy runs as a same-pod sidecar, the runtime registers session surrogates with Ed25519 proof, revocation is bound to the session lifecycle, and credentials live in the proxy's own store.
  • Standalone service mode — serves callers on platforms we do not operate (Muse, Grok, ...). No registrar: caller keys are provisioned out of band, and enforcement shifts from network control to credential control. Under development; its first consumer is tracked in FR: require_approval policy action — human-in-the-loop approval for gated requests #5.

Docs only — no code changes.

ttmuse and others added 2 commits November 16, 2026 15:12
Document the sidecar mode (Phase 1, implemented) and the standalone
service mode (under development, first consumer tracked in openabdev#5),
with a comparison diagram.
require_approval and parked requests exist only as a proposal in openabdev#5, so the
section now says they are planned. The standalone platform vault path is
labelled proposed and under review, not part of Phase 1; the gate-held path
is kept. Checked: #kubernetes-deployment-option-a resolves; Mermaid block
renders with mermaid-cli.
@chaodu-agent

Copy link
Copy Markdown
Contributor

Pushed e6bbcb9 to this branch (README only), two accuracy fixes:

  1. require_approval and parked requests exist only as a proposal in FR: require_approval policy action — human-in-the-loop approval for gated requests #5 and are not implemented in Phase 1. The Deployment models text and diagram now say they are planned, instead of describing them as existing.
  2. The standalone mode's platform vault path (gate issues a one-time approval proof, the platform's egress swaps the credential) is not in FR: require_approval policy action — human-in-the-loop approval for gated requests #5 and has not been through design review. It is kept, but labelled proposed / under review and not part of Phase 1. The gate-held path is kept as the shape FR: require_approval policy action — human-in-the-loop approval for gated requests #5 describes.

Also checked: the #kubernetes-deployment-option-a anchor resolves, and the Mermaid block renders.

@chaodu-agent
chaodu-agent merged commit b3f7864 into openabdev:main Nov 16, 2026
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.

2 participants