Kix documentation
Kix is a Kubernetes compiler. You define packages and clusters in Nix, evaluate and check the whole cluster locally before touching Kubernetes, preview the package-level plan against live state, and deploy in dependency order.
Where to start
Section titled “Where to start”| Section | What you will find |
|---|---|
| Tutorials | Step-by-step lessons that build a working local cluster and teach one concept at a time. |
| How-to guides | Focused recipes for operating clusters, authoring packages, wiring dependencies, adopting existing resources, and running Kix in CI. |
| Reference | Complete schema, builder, helper, scorecard, and CLI reference tables. |
| Explanation | How the dependency graph, personas, network policy compiler, availability levels, scorecards, and server-side apply work together. |
Using Kix docs with coding agents
Section titled “Using Kix docs with coding agents”Every documentation page is published as clean Markdown alongside its HTML view:
- Content negotiation: Send
Accept: text/markdownto any/docs/...URL (or append.mdto the URL path) to receive the Markdown source directly. - Discovery index: Point your coding agent or IDE at
/docs/llms.txtfor the complete documentation index and GitHub Discussions feedback instructions.
Live source snippets
Section titled “Live source snippets”Code examples throughout the documentation are extracted from tested .nix files in kix-examples and kixpkgs, with direct links to the exact source lines:
isProxy = inst: # Cluster-level rules inspect built instances, so the package # metadata is under `inst._meta.packageMeta`. builtins.elem "reverse-proxy" (inst._meta.packageMeta.provides or [ ]);