gameplane / docs
DEVELOP

Local development setup

Build Gameplane on a host or devcontainer, then run the full stack against kind or a selected remote cluster.

Local Developmentv0.214 MIN
Desired state vs. observed state

Desired state belongs in CRD spec; observed state and conditions belong to controllers.

Workspace map

The workspace joins runtime components, shared libraries, optional services, packaging, e2e infrastructure, and two submodules.

Go modulesgo.work joins operator, API, agent, shared Go modules, MCP, and tests.
Web dashboardweb is React; charts and deploy own packaging and local orchestration.
Submodulesmodules and website are separately versioned gitlink repositories.

Cluster development loop

The Make targets create local infrastructure, build and load images, push modules, install the chart, and run the web UI.

make dev-upCreates kind and the local OCI registry.
make web-devRuns Vite on 5173 with REST and WebSocket proxying.
make dev-downRemoves kind; CLUSTER=remote runs `helm uninstall` instead.

Debug the environment

Keep host and cluster registry addresses, kube context, namespaces, image tags, and Helm values aligned.

LOCAL LOOP

01   01 git submodule update --init --recursive
02   02 make dev-up && make web-dev
03   03 make dev-down # or CLUSTER=remote make dev-up