gameplane / docs
DOCUMENTATION

Architecture

Gameplane splits control across an operator, REST API, in-cluster agent sidecars, and the browser dashboard.

BrowserUser
APIGateway
OperatorController
KubernetesCluster
AgentSidecar

Console and log traffic flow API ↔ Agent directly over mTLS; the Operator provisions and reconciles both.

Why two control planes

The Operator reconciles CRDs declaratively; the API layer handles sessions, RBAC, and audit. kubectl and the dashboard always agree.

Data flow

A dashboard action cascades: API → Operator → StatefulSet → Agent → heartbeat → status → browser refresh.

Module system

ModuleSource CRs declare where templates come from — OCI registry, git, HTTP, local, or dashboard upload.

Optional components

Beyond the core operator, API, and agent, Gameplane ships optional services for specialized tasks. Optional components (mcp-server, telemetry-receiver, audit-syslog-bridge) are covered in Extension services. For a full catalog of all CRDs and their fields, see the CRD catalog.

The full component reference — data-flow walkthroughs, CRD relationships, and security boundaries — lives in the architecture doc on GitHub.