Skip to content

MeshFlows Documentation

MeshFlows Logo

MeshFlows is a workflow orchestration and integration platform built for Kubernetes and local development.

Start Here

Platform Operator Path

  1. Engine Overview
  2. Prerequisites
  3. Kubernetes Deployment
  4. Operations
  5. CI/CD Pipeline

Workflow Developer Path

  1. Develop and Test — end-to-end local → CI loop
  2. Flows Overview
  3. First Workflow
  4. Script Steps — JavaScript, Python, Bash
  5. Connections
  6. Deployment

Troubleshooting Path

  1. Observability
  2. Scheduler Operations
  3. Orchestrator API
  4. Error Handling

Components

Engine

Backend services for execution, APIs, data transformation, storage, scheduling, and security.

Flows

Workflow artifacts and runtime configuration.

Quick Actions

Run Locally

cd engine
cp .env.example .env   # fill secrets first
docker-compose up -d

Validate Workflow Runtime Health

curl http://localhost:8080/v1/status
curl http://localhost:8083/readyz

Execute a Workflow

curl -X POST http://localhost:8080/v1/run/demo \
    -H "Content-Type: application/json" \
    -d '{"xml":"<root/>"}'

Documentation Map

  • Engine How-to: deployment, secrets, operations, scheduler ops, develop & test.
  • Engine Reference: architecture, APIs, observability, security, CI/CD.
  • Flows How-to: authoring, script steps, scheduling, deployment, testing.
  • Flows Reference: YAML schema, step types, context, policies.

Internal docs published to wiki

Internal path Wiki page
internal/lab-https-setup.md Lab HTTPS Setup
internal/k8s-gateway-api-migration.md Gateway API Migration
internal/scheduler-operations.md Scheduler Operations
internal/SCRIPT_STEPS_GUIDE.md Script Steps
internal/message-size-scaling-plan.md Tuning — Message size limits

Support

Last updated: July 2026