Skip to content

Understand Services

Use this section for integration boundaries and operations. It is not a requirement for ordinary console setup.

User-visible operationServiceSupported caller
Manage product and policy stateAPIConsole BFF, Admin SDK, documented Admin API
Start Sessions or create DelegationsCoordinatorSDK, documented Coordinator API, console operator views
Exchange authority for a mandateSTSSDK, caracal run, Gateway, documented token client
Protect an HTTP upstreamGatewayClient presenting a Caracal mandate
Ingest and retain decision evidenceAuditCaracal stream producers; operators read through console/API
Automate zone management remotelyControlTrusted automation with a scoped Control credential
flowchart LR
  Console --> API
  SDK --> STS
  SDK --> Coordinator
  Client --> Gateway
  Gateway --> STS
  API & STS & Gateway & Coordinator & Audit --> Postgres[(Postgres)]
  API & STS & Gateway & Coordinator & Audit --> Redis[(Redis)]
  Control --> API

The packaged Compose and Helm topologies deploy all five runtime services together with Postgres and Redis; Control is the only optional management surface. All five runtime services expose health and readiness. Health means the process responds. Readiness includes dependencies and service-specific thresholds. Control has no separate process: it is an optional plugin on the API port.

Do not call /internal/* routes, write service tables, publish Redis topics, or manipulate replay directories from application code. Internal routes are authenticated service-to-service contracts. Use the console, SDKs, Admin API, Coordinator API, STS token endpoint, Gateway proxy, or Control API as documented.

Manage Product State for the management path, or Issue Mandates for the authority path.