Getting started

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 v1alpha1 API 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

ResourceWhat it is
ServerA single Minecraft server with its own storage.
NetworkA Velocity proxy that connects several servers.
RouterA lightweight proxy that sends players to a backend based on the hostname they connect to.
RouteA hostname on a Router and the backend it leads to.
BackupRepoWhere backups are stored: an S3-compatible bucket or a volume.
BackupA snapshot of a server’s data.
RestorePuts a backup back onto a server.
CommandRuns one RCON command on a server and keeps the response.
CommandGroupRuns several commands in order.
AccountA Microsoft account, signed in once via device code.
BotA 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