Skip to content

Flows

A flow is a Camel route, plus its visual layout, plus its parameters. It’s the unit you author in the designer and deploy to a runtime.

PieceWhat it isWhere it lives
YAMLCamel route definition (canonical)flow.camel.yaml on the designer’s disk
LayoutBPMN shapes + edges + extras (visual only)flow.layout.json
Params{{key}} placeholders substituted at deploy timeparams.json

The YAML is the source of truth. Camel reads YAML; the designer reads both YAML and layout to render the canvas.

A flow’s status is derived from its deployment matrix — not stored on the flow itself:

  • Healthy — every registered runtime has the flow in-sync
  • Warning — at least one runtime has the flow stale (local edits not yet redeployed)
  • Failed — every runtime is unreachable or returned an error
  • Draft — the flow exists in the designer but is on no runtime yet
  • Paused — operator manually disarmed it (not automatic)
  1. Create via + New flow — lands as Draft
  2. Edit in the designer — Save writes YAML + layout to disk
  3. Deploy to a runtime — pushes YAML via PUT /_api/flows/:id, runtime hot-reloads the route
  4. Promote to downstream environments — same deploy mechanism, targets a different runtime
  5. Delete — removes from designer disk; cascade-undeploys from every runtime