Welcome

Boomerang Flow builds and runs workflows: graphs of tasks that run as containers on Kubernetes. Put tasks from the catalogue, or your own containers and scripts, onto a canvas, then run the workflow by hand, on a schedule, or from a webhook, a CloudEvent or a GitHub event.

Build workflows

This is for you if you build, run and fix workflows in the webapp.

Flow in five minutes

A short tour of Flow's main ideas and how they fit together.

Getting started

Create a workspace, build a workflow with one task and watch it run, in about ten minutes.

Workflows

What a workflow is, and how to find, run and manage the workflows in a workspace.

Create a workflow

Start a workflow from scratch, from a starter or from a file.

Troubleshooting

Common problems, what causes them and how to fix each one.

Run Flow

This is for you if you install, configure and upgrade Flow for other people to use.

Installing

What an install needs, how to try Flow locally with Docker Compose, and how to deploy it to Kubernetes.

Configuring

The properties, routes and probes a deployment needs, and how Flow connects to its dispatcher.

Sign-in and the first admin

Choose how people sign in, make the first admin, and decide who else may sign in.

Upgrading from v3

Upgrade a Flow v3 installation to v5 in place, then roll out each later release.

Run the dispatcher

Deploy Flow's Kubernetes dispatcher, choose its executor and grant the permissions it needs.

Build on Flow

This is for you if you call Flow from another system, write tasks or a dispatcher, or build Flow into your own product.

API reference

How to authenticate to the REST API under /api/v2, how its errors and paging work, and every route.

Webhooks and events

Start and resume runs from other systems, and receive a CloudEvent when a run's status changes.

Task container contract

What Flow hands a task's container and what it takes back.

Write a dispatcher

Build your own dispatcher with the Java dispatcher SDK, following the protocol's rules.

Embed Flow

Use Flow as the workflow engine inside your own product, and call it with the flow-sdk client.

Also useful

What's new in 5.0 · Known issues · Task catalogue · Glossary

Flow is open source under the Apache License 2.0. To get help or report a defect, open an issue in the Flow issue tracker.