Elchi Documentation
Elchi is a visual control plane for Envoy proxy fleets: a central xDS control plane with a typed, validated editor for every Envoy resource, plus edge agents that deploy and operate Envoy on your hosts (VMs, bare metal or appliances), with GSLB, ACME certificates, API discovery and API security (a WAF with the OWASP Core Rule Set) built in. New here? Read What is Elchi?.
Start here
- Introduction — what Elchi is and how the pieces fit together.
- Architecture — the processes, the edge node, and how every wire connects.
- Quick Start — get the platform running on Kubernetes in four steps.
Install it
Pick the deployment substrate that fits — all bring up the same control plane:
- Helm — on an existing Kubernetes cluster.
- Docker Swarm — one command, container-based, single-node or HA, online or air-gapped.
- Single-Host (kind) — the whole stack on one VM for evaluation.
- Bare-Metal — plain VMs with systemd, no containers.
- Elchi Client — then install the edge agent (+ bundled Shield) next to Envoy.
- Elchi OS Appliance — or run the edge as a ready-made appliance image with the agent and Shield built in.
Configure & operate
- The Dashboard — the landing screen: resource counts, error summary, health at a glance.
- Configuring — the resource model: build, validate, publish. Or generate config with the Scenario wizard.
- API Security (Shield) — API-security enforcement at the edge: the WAF, auth, rate limiting, DLP.
- GSLB, Certificates (ACME) — traffic and certificates.
- API Discovery — a live, risk-scored inventory of every API your gateways serve.
- Fleet Operations — manage running Envoy services and connected edge clients.
- Edge HA Pairs — two Elchi OS appliances sharing VIPs active/passive, with automatic failover.
- Observability — metrics, logs, audit, and jobs.
Administer
- Authentication & Access — projects, RBAC, tokens, LDAP, 2FA.
- Registry & High Availability — scaling the control plane (for the edge, see Edge HA Pairs).
- Troubleshooting — when something doesn't work.
Automate and learn more
- Automation API — the public REST API with project tokens: drain an upstream endpoint, switch an EDS cluster blue/green. OpenAPI spec.
- How-to guides — short answers: Envoy without hand-written xDS, a WAF with ext_proc, multi-version upgrades, GSLB failover, shadow APIs, blue/green.
- Blog — engineering notes on Envoy control planes, xDS and running Envoy on VMs.
Running Envoy in production across many edges? See plans or book a demo.