Service Reference
Per-service specs for the 5 most-configured OpenBox services. Each page follows the same template so you can scan predictably across services.
Page template
Every service page has these sections:
| Section | Contents |
|---|---|
| Purpose | 1-2 paragraphs on what this service does, which plane it belongs to |
| Ports & endpoints | Table: internal port, protocol, purpose, how exposed |
| Runtime | Container count, resources (req/lim), HPA config, node placement guidelines |
| Configuration | Values keys (link back to values-reference for authoritative list) + env vars + IRSA/IAM |
| Dependencies | Downstream (what it calls) + upstream (what calls it) |
| Deployment guidelines | Prod recommendations + local PoC tuning |
| Troubleshooting | 3-5 symptom → cause → fix entries |
Services documented (MVP)
The MVP covers the 5 services customers configure most:
- openbox-backend — Platform REST API (control plane)
- openbox-core — Agent orchestration (data plane, 5-container pod)
- openbox-fe — Frontend web app
- guardrails-api — Guardrails orchestrator (guardrails plane)
- identity-service — Keycloak IAM
Services NOT yet documented
These have Helm defaults that work out of the box — deep-dive pages will be added on customer demand:
openbox-core-redis·openbox-core-codec·opa-appmodel-host-detect-pii·model-host-nsfw·model-host-toxicity·llamafirewall-server·vllm- Managed data plane:
openbox-postgresql·openbox-identity-postgresql·openbox-postgres-temporal· Temporal server + Elasticsearch
For their default resource / config values, see values reference.
Cross-references
- Architecture context: component diagram shows how these services connect
- Configuration authority: values reference is the single source of truth for all
values.yamlkeys - Install-time overrides: see customization patterns for common override recipes