Doc system test

coordinator map

Coordinator: map

The service that runs artifact containers in Docker for one template run and routes the CLI's calls to them.

domain/

feature

  • Blob volume - A shared, read-only Docker volume holding a template version's files, filled once from its blob image.
  • Container naming - How a container or volume name is built from kind, version id and session, and why names are the routing table.
  • Session - A run-scoped id that owns one template run's processor, plugin and merger containers and its work volume.

surface

  • Daemon - The coordinator run on the user's own machine as a Docker container, started and stopped by cyanprint daemon.

architecture/

design

  • Coordinator hosting - Where the shared coordinator runs: OpenTofu code for a host on AWS, DigitalOcean or Vultr, and DNS for coord.cyanprint.dev.

flow

  • Template run on the coordinator - The calls one template run makes: template warm and session warm, bootstrap, the question loop through the proxy, then the build phase.

surface

  • Coordinator API - Every HTTP route the coordinator serves on port 9000, one line each.
  • Proxy routing - How a CLI call reaches a shared template or resolver container by version id, through the coordinator.

implementation/

algorithm

  • Build phase - What POST /executor/{session} does: run processors, merge their outputs, run plugins, return a tar.gz of the files.
  • Cleanup - How one session, or the whole pool, of coordinator containers, volumes and images is removed.
  • Processor output merge - How the merger container joins the output folders of one template's processors, and settles a path two processors both wrote.
  • Readiness checks - How the coordinator waits for containers to answer, and the case where it reports ready without an answer.
  • Try setup - How the coordinator prepares a local, unpublished template for cyanprint try: a blob volume from an image or a folder under DEV_ROOT.
  • Warm-up - How the coordinator makes a template version ready: pull images, fill the blob volume once, start shared template and resolver containers, health-check.