SwarmCracker Documentation¶

Firecracker microVM orchestration with SwarmKit — no Docker, no Kubernetes required.

How Docs Are Organized¶

docs/
├── user/           # 👤 If you're running SwarmCracker, start here
├── dev/            # 🔧 If you're contributing or hacking on the code
├── planning/       # 📋 Implementation plans & roadmap
├── research/       # 🔬 Research notes & archived docs
└── site/           # 🌐 GitHub Pages website

Find What You Need¶

For Users (Running SwarmCracker)¶

You want to...	Go here
Install SwarmCracker	User Docs → Getting Started
Set up your cluster	User Docs → Configuration
Deploy services	User Docs → SwarmKit
Look up commands	User Docs → CLI Reference
Understand how it works	User Docs → Architecture

For Developers (Contributing Code)¶

You want to...	Go here
Contribute	Dev Docs → Contributing
Run tests	Dev Docs → Testing
Follow code style	Dev Docs → Conventions

Planning & Research¶

You want to...	Go here
See what's planned	Planning → TODO Implementation
Read research notes	Research → Image Preparation

Versions (What's What)¶

Component	Version
SwarmCracker	v0.6.0
Firecracker	v1.15.1
SwarmKit	v2.1.1
Go	1.21+

Useful Links¶

GitHub Repo — source code, issues, PRs
Firecracker Docs — the VM engine we use
SwarmKit Docs — the orchestration layer
Report a Bug — found something? tell us!

Last updated: 2026-04-19 | Doc version: 3.0