Skip to content

Minecraft Operator

Kubernetes operator for managing PaperMC servers with automatic version management for plugins and the server, ensuring compatibility through constraint solving.

Features

  • Automatic Version Management — Four update strategies: latest, auto, pin, build-pin
  • Plugin Compatibility Solver — Constraint solver ensures plugins work with selected Paper version
  • Scheduled Updates — Cron-based maintenance windows with graceful RCON shutdown
  • Declarative Plugin Management — Plugins are matched to servers via label selectors
  • Web UI — Built-in dashboard for monitoring servers and plugins
  • Hangar Integration — Automatic plugin downloads from PaperMC Hangar

Not a High-Availability System

This operator is designed for single-instance Minecraft servers. 5-10 minutes of downtime during updates is acceptable by design.

Quick Start

# Install CRDs
helm install minecraft-operator-crds \
  oci://ghcr.io/lexfrei/minecraft-operator-crds \
  --namespace minecraft-operator-system \
  --create-namespace

# Install operator
helm install minecraft-operator \
  oci://ghcr.io/lexfrei/minecraft-operator \
  --namespace minecraft-operator-system

See Getting Started for detailed setup instructions.

Documentation Sections

  • Getting Started

    Prerequisites, installation, and your first Minecraft server

    Get started

  • Configuration

    CRD reference for PaperMCServer, Plugin, and update strategies

    Configure

  • Architecture

    System design, constraint solver, and update workflow

    Learn more

  • Operations

    Troubleshooting, monitoring, and maintenance

    Operate

  • Development

    Development setup, testing, and contributing

    Develop

  • Reference

    Helm chart values, API reference, and more

    Reference

License

BSD 3-Clause License - see LICENSE for details.