Keel

Documentation

Reference material for the JailSpec/ServiceSpec/IngressSpec YAML formats, the keelctl CLI, and the keel-agentd / keel-controlplane HTTP APIs, plus an overview of how the crates fit together.

Architecture

The crate map and how keel-agentd's Reconciler, keel-spec, keel-jail, keel-zfs, and keel-net compose, plus the single-worker-thread pattern shared with keel-controlplane.

JailSpec reference

Every field in the JailSpec YAML format: types, meaning, and which fields are immutable after the first apply.

keelctl CLI reference

apply, get, and delete: flags, example invocations, and example output.

HTTP API reference

keel-agentd's Unix-socket API and keel-controlplane's TCP API: routes, request/response bodies, and error cases.

Automatic HTTPS quickstart

A full worked example: a real domain, a real DNS-01 challenge against OVH, and a real Let's Encrypt certificate that issues and renews itself in front of a running Service.