F Forge DocsRepository ↗FeaturesUser manual

Workloads

How pipelines work

Reusable multi-stage delivery definitions, runs, and triggers.

Repository-validated operator guidance View source ↗

#Definitions and runs

A pipeline definition names ordered stages (pull, build, deploy, compose, health_check, notify, approval, sleep, script), each with timeouts, retries with doubling backoff, and continue-on-failure flags. Triggering a run freezes a stage snapshot, so later definition edits cannot rewrite history. Runs report queued, running, completed, failed, cancelled, or awaiting_approval with progress and per-stage logs and artifacts (capped at 64 MiB).

FLOW

Pipeline execution

01Definition savedfreeze snapshot
02Run triggeredrun
03Stages executepause
04Approval gaterecord
05Completed or failed

#Actions

ActionDoes
pullFetch a repository into a workdir.
buildBuild an image from a source (Dockerfile or builder).
deployExecute an existing deployment record.
composeDeploy inline YAML or a repository Compose file to a node.
health_checkPoll a URL or host:port until a threshold passes.
notifyPOST to a URL with run variables.
approvalPause the run until a human approves or rejects.
sleepWait a fixed duration.
scriptExecute a command inside a node container — never on the control plane.

#Triggers

Manual is the default. Webhook triggers mount a public HMAC-signed endpoint only when PIPELINE_WEBHOOK_SECRET is set. Schedule triggers evaluate cron each minute. Concurrency defaults to 2 workers.

Under /api/v1 (admin)
GET|POST /pipelines            definitions
GET|PUT|DELETE /pipelines/:id
POST /pipelines/:id/runs        trigger
GET  /pipeline-runs            list (?pipelineId&status)
POST /pipeline-runs/:id/cancel|/retry
POST /pipeline-runs/stages/:stageId/approve|/reject
Made by Riyaz with love