Files
electric-cherry/docs/provisioning.md
T
josh cfed584614 feat: add provisioning lifecycle actions
Rename Deployments to Provisioning with compatible redirects and APIs. Add durable Start, Restart, Stop, and Rebuild operations alongside Create and Destroy; rebuild wipes the instance and recreates it in the same slot and port.

Add lifecycle, migration, recovery, and Komodo command tests. Type checks and production build pass; the full suite retains a telemetry assertion failure reproduced on the unchanged branch.

Refs #39
2026-09-27 14:20:04 -04:00

4.0 KiB

Provisioning

Open Operations → Provisioning for instance lifecycle work, blueprints, and persistent activity. Create a server using Create server. For an existing server, choose Manage server or open its Server actions menu.

Action Behavior
Create Create a new instance using the latest promoted files and verify container health, RCON, and the selected map.
Start Start the existing container and verify container health and RCON.
Restart Wait until empty, restart the existing container, and verify container health and RCON.
Rebuild Wait until empty, destroy the instance, delete all server files and its registration, then create a fresh instance in the same server slot and port. Verify container health, RCON, and map.
Stop Wait until empty, stop the container, and verify that Komodo reports it stopped. Keep the instance for a later Start.
Destroy Wait until empty, remove the container and Komodo deployment, then delete server files and registration.

Rebuild requires confirmation because no instance data is preserved. Its fresh files come from the latest promoted setup when creation begins, including changes promoted while waiting. The independently saved key in Keys must exist before teardown. Blueprint definitions, promoted artifacts, saved keys, and historical activity belong to Electric Cherry, and are not instance files.

Rebuild reserves the original ID and port throughout teardown and creation, even when a lower lobby is available. It shares the existing creation queue and startup limit. A failed removal never proceeds to creation. Once Komodo deletion is confirmed, failed local cleanup offers Resume rebuild cleanup; creation cannot proceed until the old files are fully removed. An interrupted fresh startup can resume health verification, without repeating teardown or creation. Inspect other failures before making another request.

Start and Restart share the rolling restart limit with campaigns, betas, and maintenance. A successful API reply is followed by a recovery delay and actual container/RCON checks. Failed or ambiguous restart requests retain their recovery slot and are not automatically replayed. Automated restart submissions also appear in Provisioning history. Stop requires an explicit stopped container state; an unreachable Komodo API is not evidence that a stop succeeded.

Disruptive operations require a fresh zero-player RCON result, unless Komodo positively reports a stopped container. Runtime actions wait for conflicting campaign, beta, maintenance, or provisioning work. Duplicate pending requests for the same action return the existing operation; a different action returns a conflict. Requests and events survive application restarts.

Routes and compatibility

  • /provisioning: active operations, blueprints, and history filtered by action.
  • /provisioning/:id: operation stages, errors, timestamps, and activity.
  • /provisioning/collections/:id: collection progress.
  • GET /api/provisioning: lifecycle history (deployments response property).
  • POST /api/provisioning: queue { "server": "t5_zombie_theater_1", "action": "start" }. Supported actions are start, restart, rebuild, and stop. Returns HTTP 202 with deploymentId. Create continues through POST /api/servers; Destroy uses DELETE /api/servers/:name.
  • /api/provisioning/:id, /:id/resume, /:id/cancel, /preview, and /house-party preserve the existing operation, recovery, removal cancellation, launch preview, and fleet destruction APIs.

Old /deployments pages redirect to their /provisioning equivalents, preserving query parameters. /api/deployments remains compatible, including old campaign detail endpoints. No history or IDs are renamed or discarded.

Start and Stop use Komodo's corresponding runtime commands. Rebuild uses full destruction and creation, not Komodo's redeploy command. See the Komodo execute API for the underlying container operations.