Introduction
What Kobblestone is, what it manages for you, and how these docs are organized.
Kobblestone is a Kubernetes operator for Minecraft. It adds custom resources to your cluster that describe Minecraft infrastructure: servers, proxies, routing, backups, commands and bots. You write those resources in YAML, and the operator creates and maintains the Kubernetes objects that actually run them.
Kobblestone is in an early alpha phase and highly experimental. All resources use the
v1alpha1API version. Some features and concepts described here are not fully implemented yet, and fields and behavior can change between releases, sometimes with manual migration steps. Read the changelog before upgrading, and keep independent backups of worlds you care about.
The resources at a glance
| Resource | What it is |
|---|---|
Server | A single Minecraft server with its own storage. |
Network | A Velocity proxy that connects several servers. |
Router | A lightweight proxy that sends players to a backend based on the hostname they connect to. |
Route | A hostname on a Router and the backend it leads to. |
BackupRepo | Where backups are stored: an S3-compatible bucket or a volume. |
Backup | A snapshot of a server’s data. |
Restore | Puts a backup back onto a server. |
Command | Runs one RCON command on a server and keeps the response. |
CommandGroup | Runs several commands in order. |
Account | A Microsoft account, signed in once via device code. |
Bot | A Minecraft-Console-Client bot connected to a server or network. |
Every field of every resource is documented in the CRDs themselves. Run kubectl explain server.spec (or any other resource and field) on a cluster with Kobblestone installed, or browse the API reference.
How these docs are organized
- Getting started walks you through the installation and your first server.
- Concepts explains how the resources work and fit together, starting with how Kobblestone works.
- Help collects troubleshooting tips for when something does not behave as expected.