Documentation

Open-M Docs

Everything you need to build, deploy, and operate integration pipelines with Open-M. Start with the getting-started guide or dive into the reference docs.

🚀

Getting started

Install Open-M and run your first pipeline end-to-end in under 10 minutes.

QUICKSTART 📦

MPPM Envelope

The standard message contract — correlation ID, schema ref, delivery guarantee, step window.

CORE CONCEPT ⚡

UTL-X Mapping

Inline mapping on the arrow (Mode 2) vs full mapping components (Mode 3). N-input fan-in.

MAPPING 📄

Pipeline YAML

Full reference for the open-m/v1 Pipeline descriptor — all stanzas, all fields.

REFERENCE 🔌

Connector registry

All 160+ connectors with status, strategy, authentication, and configuration reference.

160+ CONNECTORS 🛠️

Build a connector

Step-by-step guide for contributing a new connector adapter to Open-M.

CONTRIBUTING

Key concepts

Open-M is built around a small set of core ideas. Understanding these makes everything else — YAML syntax, connector behaviour, IDE rendering — immediately legible.

MPPM Envelope Every message on the Pulsar bus is wrapped in a standard envelope. It carries a correlation_id, a schema_ref, a delivery guarantee, and a step window — an ordered history of the last N payloads the message has been through.

Pipeline A directed graph of components connected by arrows. Defined in YAML (apiVersion: open-m/v1, kind: Pipeline). Deployed as a Kubernetes workload by the Open-M operator.

Component A connector adapter pod. References a versioned component from the registry (namespace.category.name:version). Has typed input/output ports with schema references.

Connection (Arrow) A directed edge between two component ports. Auto-generates a Pulsar topic, subscription name, and error routing topic. Can carry a UTL-X transform inline (Mode 2).

UTL-X Open-M's native mapping language. Pure, stateless, deterministic. Mode 1 = no transform (schemas match). Mode 2 = inline or ref transform on the arrow. Mode 3 = full mapping component for complex cases.

Schema Registry Centralised store for all schemas used in pipelines — JSON Schema, XML Schema, Protobuf, Avro, TSCH (tabular). Referenced by namespace.schemas.name:version.

📌 NOTE — ALPHA STATUS

Open-M is currently in early alpha. APIs and YAML schema may change between versions. Check the changelog before upgrading. Documentation coverage is actively growing — if you find a gap, open an issue or a PR on GitHub.