Doc system test

UL

Words: coordinator

Namespace: durian.cloud/cyanprint/coordinator

The coordinator service (boron) that runs artifact containers in Docker for one template run, and routes calls to them

WordMeaning
CoordinatorThe HTTP service on port 9000 that pulls images, starts artifact containers, routes calls to them, and builds a template's files.
DaemonThe coordinator run as a local Docker container by cyanprint daemon start and removed by cyanprint daemon stop.
SessionA run-scoped id, made by the CLI, that owns one template run's processor, plugin and merger containers and work volume.
Shared containerA template or resolver container started once per version id, with no session, and reused by every run.
Container namecyan--[-]; it is also the DNS name on the cyanprint Docker network.
Blob imageA template version's second image, holding its files as cyan.tar.gz; unpacked once into the blob volume.
Blob volumeThe shared volume cyan- with a template version's files, mounted read-only at /workspace/cyanprint.
Work volumeThe session volume cyan--, mounted at /workspace/area, where processors write and the merge happens.
Warm-upMaking a template version ready - pull images, fill the blob volume, start shared template and resolver containers, health-check.
BootstrapStarting one session's processor, plugin and merger containers on the work volume (POST /executor).
Build phasePOST /executor/{session} - run processors, merge their outputs, run plugins, and return the files as tar.gz.
Merger containerA session container running the coordinator image that does the processor output merge and packs the result.
Processor output mergeJoining one template's processor folders; a path two processors wrote goes to the one matching resolver, else last wins.
Proxy routeA coordinator route that forwards a CLI call to a shared container by version id - template init, template validate, resolver resolve.
Try setupPreparing an unpublished template for cyanprint try - a blob volume from a local image or a folder under DEV_ROOT.

Coordinator

The HTTP service on port 9000 that pulls images, starts artifact containers, routes calls to them, and builds a template's files.

  • Do not say: boron, executor, server
  • See: Daemon, Session

Repo sulfone.boron (Go). The CLI calls it CyanCoordinatorClient. Runs hosted or locally as the daemon.

Daemon

The coordinator run as a local Docker container by cyanprint daemon start and removed by cyanprint daemon stop.

Session

A run-scoped id, made by the CLI, that owns one template run's processor, plugin and merger containers and work volume.

  • Do not say: executor session, try session

Example: session s1 gives containers like cyan-processor-2222…-s1 and volume cyan-1111…-s1. DELETE /executor/s1 removes them.

Shared container

A template or resolver container started once per version id, with no session, and reused by every run.

Example: cyan-template-1111… answers every user's question loop for that template version.

Container name

cyan--[-]; it is also the DNS name on the cyanprint Docker network.

  • Do not say: container id, address

Blob image

A template version's second image, holding its files as cyan.tar.gz; unpacked once into the blob volume.

  • See: Blob volume

Blob volume

The shared volume cyan- with a template version's files, mounted read-only at /workspace/cyanprint.

Work volume

The session volume cyan--, mounted at /workspace/area, where processors write and the merge happens.

Warm-up

Making a template version ready - pull images, fill the blob volume, start shared template and resolver containers, health-check.

  • Do not say: warm, warn

Two calls: template warm (POST /template/warm) and session warm (POST /executor/{session}/warm).

Bootstrap

Starting one session's processor, plugin and merger containers on the work volume (POST /executor).

Build phase

POST /executor/{session} - run processors, merge their outputs, run plugins, and return the files as tar.gz.

  • Do not say: build, generation

Not a Docker image build (that is cyanprint build).

Merger container

A session container running the coordinator image that does the processor output merge and packs the result.

  • Do not say: merger

Processor output merge

Joining one template's processor folders; a path two processors wrote goes to the one matching resolver, else last wins.

  • Do not say: merge, merging
  • See: Merger container

Two matching resolvers fail the build. Not the three-way merge and not dependency layering.

Proxy route

A coordinator route that forwards a CLI call to a shared container by version id - template init, template validate, resolver resolve.

  • Do not say: proxy

Try setup

Preparing an unpublished template for cyanprint try - a blob volume from a local image or a folder under DEV_ROOT.