Envoy
Envoy Documentation
Install, configure, operate, and extend Envoy, the self-hosted data movement and workflow platform from ClonePartner.
Overview
What Envoy is, the problems it solves, and where to start for your role.
Getting Started
Install Envoy, complete first-time setup, and run your first job or task.
Core Concepts
The mental model: architecture, tasks, jobs, templates, connectors, and runs.
Using Envoy
Operate Envoy from the web UI — jobs, runs, connectors, dashboards, and more.
Building Pipelines
Author tasks, job templates, dashboards, and migrations in YAML.
Task Reference
The complete task YAML schema, every step type, and the JSONata reference.
Job & Dashboard Reference
Job template, arguments, job_config, metrics, and dashboard widget schemas.
Connector Reference
Configuration and methods for every built-in and catalog connector.
CLI Reference
The envoy command line: commands, flags, and connectors.yaml.
API Reference
Authenticate with the REST API and browse every endpoint.
Deployment
Run Envoy in production: Docker, Azure, server configuration, and executors.
Security
Harden deployments with RBAC, secret management, and OAuth configuration.
Operations
Monitor runs, collect metrics, manage retention, and ship logs.
Troubleshooting
Diagnose common errors across connectors, runs, and executors.