A kubernetes automated dashboard to deploy your Minecraft servers.
When deploying a Minecraft server, we often use the same tools : hosting providers, bare bones linux server, docker container, Pterodactyl instance, etc. What i'm looking for, is something similar to what we know with Pterodactyl : a good and simple to use web dashboard to deploy servers but, this time, inside a Kubernetes cluster.
This mainly answer a personal desire to take the advantage of my own Kubernetes cluster to deploy any kind of Minecraft servers.
The project is divived in 4 sub-projects: api, operator, download and webui.
- Operator handles all the deployment logic on the
Kubernetes side. This means that, when we will deploy a custom resource (i.e.
MinecraftServer
), the operator will translate it into Kubernetes primitives kinds (StatefulSet
,Pods
,Service
, etc.). - Download is a small tool used to download required
files and ensure the hash match with the one expected. It is useful to
download Minecraft required files like the
server.jar
, mods/plugins or even extra resources. - api is the actual HTTP API of the kubestro dashboard. The API will handle all the interaction and then process the deployment of custom resources on the cluster.
- webui is the dashboard itself. It will be served through the same container as the API, and will be presented to the user to interact with the cluster.
Contributions are always welcome!
See contributing.md for ways to get started.
Please also adhere to this project's CODE OF CONDUCT
This project is under MIT license. It can be found here or on https://opensource.org/license/mit.
- Kubebuilder
- Kubecraft and kubernetes-minecraft-operator for the inspirations for my own operator implementation.