fabianvf/game-server-operator repository overview

⁠game-server-operator

This operator deploys game servers to OpenShift or Kubernetes

Currently supported games are:

• minecraft

⁠Deploying the Operator

To deploy it, ensure your kubeconfig is properly set up (ie, that you can use kubectl or oc to connect to it), ensure you have cluster-admin permissions (you will need this to create CustomResourceDefinitions), install ansible⁠ and the openshift python client⁠, and run

ansible-playbook deploy.yml

If you'd rather deploy it by hand, you can instead run:

kubectl apply -f deploy/crds/games_v1alpha1_minecraft_crd.yaml
kubectl apply -f deploy/role.yaml
kubectl apply -f deploy/role_binding.yaml
kubectl apply -f deploy/service_account.yaml
kubectl apply -f deploy/operator.yaml

Once this is done, your operator will be running.

⁠Deploying a Minecraft server

The minecraft operator is built on top of the fantastic minecraft-server image⁠ provided by @itzg.

All you need to do is create an instance of the games.fabianism.us/v1alpha1 Minecraft resource. A basic example Minecraft definition exists in deploy/crds/minecraft.yaml. You can create it with

kubectl apply -f deploy/crds/minecraft.yaml

This will kick off the deployment of the Minecraft server. To monitor the status of the deployment, run

kubectl describe minecraft

and monitor the status field. After some amount of time, a field called URL should appear in the status, this is the URL that the operator has generated for your server. You should be able to access the minecraft server by connecting to that URL.

⁠Deployment Options

The example deployment will only give you a very basic, ephemeral, vanilla Minecraft. In order to get a real deployment, you will at least need to add storage options. The following options are supported in the Minecraft spec:

⁠VolumeSpec

The volumes field is a map of key:value pairs, where each key is a volume name and the value is a map of key:value pairs defining how the volume is to be created/mounted/accessed.

For configuration persistence, only one volume is required, the data volume. It must be mounted to /data with read-write permissions.

All volumes accept the following options:

⁠ServerSpec

The server field contains configuration options for server administration.

⁠WorldSpec

The world field contains options for generating or loading your world.

⁠ModSpec

The mods field contains options for loading and configuring your modpacks. Bukkit, Spigot, Paper, Forge, Feed The Beast, CurseForge, Vanilla, SpongeVanilla and Custom modpacks are all supported. The configuration options that will be loaded are based on the spec.server.type field.

⁠JvmSpec

The jvm field contains options for configuring the JVM. These include memory/heap settings as well as arbitrary arguments you may want to pass to the JVM.

⁠Examples

TODO