Reference

API reference

Every field of every Kobblestone resource, generated from the CustomResourceDefinitions.

All resources are in the API group kobblestone.io, version v1alpha1. The same documentation is available on any cluster with Kobblestone installed: run kubectl explain server.spec (or any other resource and field).

ResourceDescription
Account

Account represents a Microsoft account that can be used to authenticate against online Minecraft servers. They can be referenced by Bots to connect to online servers.

Backup

A Backup defines a request for a snapshot of a Server.

BackupRepo

A BackupRepo defines where Backups store their snapshots.

Bot

A Bot is a single Minecraft-Console-Client (MCC) instance connected to exactly one target.

Command

A Command object executes an arbitrary command on a Minecraft server via RCON.

CommandGroup

A CommandGroup manages a set of Command objects that are created/executed in sequential order.

Network

A Network runs a Velocity proxy and the Servers behind it.

Restore

A Restore restores the data of a Backup into a Server.

Route

A Route defines a mapping from a hostname (e.g. server.example.com) to a Minecraft backend (Server, Network,RouterorService`).

Router

A Router defines a lightweight proxy routing Minecraft traffic based on the Server Address field of handshakes.

Server

A Server runs a single Minecraft server.