layline.io Documentation
Everything you need to build, deploy, and operate data pipelines with layline.io.
layline.io is a low-code platform for real-time and batch event data processing. This documentation mirrors the four main sections of the Configuration Center — the web interface you use to work with layline.io day to day.
How This Documentation Is Organized
The app has four top-level tabs. Each one maps to a section of this documentation:
🗂️ Project — Working with Projects
The Project tab is where you build. A Project contains all the Assets and Workflows that define how your data pipelines work — what data comes in, how it's processed, and where results go.
What you'll find here:
- Assets Overview — All asset types: Sources, Sinks, Processors, Formats, Services, Connections, and more
- Workflow Assets — The building blocks of a Workflow: input, flow, and output processors
- Deployment Assets — Engine deployments, schedulers, tags, and cluster configuration
Key concepts:
- A Workflow has exactly one Input Processor as its driver, plus any number of Flow Processors and Output Processors
- Assets are reusable components — a Format, a Source, a Service — shared across Workflows within a Project
- A Deployment packages Workflows with their Environment and Secret Assets and ships them to a Reactive Engine
⚙️ Operations — Cluster Operations and Monitoring
The Operations tab is your mission control. Once workflows are deployed and running, this is where you monitor them, investigate issues, and manage the live system.
What you'll find here:
- Operations Overview — Introduction to the Operations section
- Cluster Management — Nodes, alarms, scheduler, stream monitor, and storage systems
- Engine State — Live view of what's running: workflows, services, connections, sources, sinks
- Audit Trail — History of workflow executions and stream events
Key concepts:
- Cluster = infrastructure (nodes, network, storage)
- Engine = the layline.io runtime process running on a cluster node
- Live State in Operations reflects what's actually running now — not what's configured
→ Go to Operations documentation
📚 Shelf — Asset Library and Organization
The Shelf tab is your reusable asset library. Assets published to the Shelf can be shared across Projects, enabling teams to standardize on common configurations.
What you'll find here:
- Asset categories and folders
- Shared elements available across projects
- How to publish assets to the Shelf and import them into a project
Shelf documentation is in progress. See LAY-69 for status.
🔧 Settings — Users, Roles, and System Settings
The Settings tab is for administrators. This is where you manage who can access the system, what they can do, and how the overall system is configured.
What you'll find here:
- User management and role assignment
- Cluster configuration
- Application-level settings
Users & Roles documentation is in progress. See LAY-70 for status.
→ Go to Settings documentation
Quick Links
New to layline.io?
| Goal | Start Here |
|---|---|
| Install and run your first pipeline | Quickstart Overview |
| Install locally | Local Installation |
| Install with Docker | Docker Deployment |
| Understand the core concepts | Core Concepts |
Building Workflows
| Goal | Start Here |
|---|---|
| Understand all asset types | Assets Overview |
| Learn about Workflow Assets | Workflow Assets |
| Configure a deployment | Deployment Assets |
| Choose a data source | Sources |
| Define a data format | Formats |
| Connect to external systems | Connections |
Operating the System
| Goal | Start Here |
|---|---|
| Log in to a cluster | Cluster Login |
| Monitor a live workflow | Engine State |
| Investigate an alarm | Alarm Center |
| Review execution history | Audit Trail |
Reference
| Goal | Start Here |
|---|---|
| JavaScript API reference | JavaScript Language Reference |
| Python API reference | Python Language Reference |
| Core concepts and architecture | Concepts |
| Release notes | Release Notes |
See Also
- Corporate website — Product overview, pricing, and case studies
- Quickstart — Install and run your first pipeline
- Core Concepts — Mental models that make everything else click