ServiceDef

Defined in: src/Workflow.ts:41

A long-running sidecar started before the DAG and stopped after it, living OUTSIDE the DAG flow (never a node, never an entry node). The canonical use is a network proxy that holds a provider API key (env) so a workload node can reach another provider by hostname without the secret ever entering the workload container. Nodes reach a service by its id via ${service:<id>}.

Properties

entrypoint?

optional entrypoint?: string;

Defined in: src/Workflow.ts:53

Command override; omitted uses the image default.

env?

optional env?: string[];

Defined in: src/Workflow.ts:47

Host env var names injected into the service container (e.g. the API key).

files?

optional files?: Record<string, string>;

Defined in: src/Workflow.ts:49

Extra files written into the service container (e.g. a proxy config).

id

id: string;

Defined in: src/Workflow.ts:42

image

image: string;

Defined in: src/Workflow.ts:43

networks?

optional networks?: string[];

Defined in: src/Workflow.ts:45

Networks the service attaches to (aliases resolved like node networks).

ready?

optional ready?: {
  log?: string;
};

Defined in: src/Workflow.ts:58

Readiness gate before the DAG starts. { log } waits for that line in the service logs; omitted falls back to a short fixed delay.

log?

optional log?: string;

setup?

optional setup?: string[];

Defined in: src/Workflow.ts:51

Build steps before the entrypoint.

timeout?

optional timeout?: number;

Defined in: src/Workflow.ts:55

Timeout in ms; 0/omitted means no timeout.