itzg/mc-router
Routes Minecraft client connections to backend servers based upon the requested server address.
500K+
Routes Minecraft client connections to backend servers based upon the requested server address.
Flags:
--help Show context-sensitive help (also try --help-long
and --help-man).
--port=25565 The port bound to listen for Minecraft client
connections
--api-binding=API-BINDING The host:port bound for servicing API requests
--mapping=MAPPING,MAPPING Where MAPPING is externalHostname=host:port
GET /routes
Retrieves the currently configured routesPOST /routes
Registers a route given a JSON body structured like:{
"serverAddress": "CLIENT REQUESTED SERVER ADDRESS",
"backend": "HOST:PORT"
}
POST /defaultRoute
Registers a default route to the given backend. JSON body is structured as:{
"backend": "HOST:PORT"
}
DELETE /routes/{serverAddress}
Deletes an existing route for the given serverAddress
The following diagram shows how the example docker-compose.yml
configures two Minecraft server services named vanilla
and forge
, which also become the internal
network aliases. Notice those services don't need their ports exposed since the internal
networking allows for the inter-container access.
The router
service is only one of the services that needs to exposed on the external
network. The --mapping
declares how the hostname users will enter into their Minecraft client
will map to the internal services.
To test out this example, I added these two entries to my "hosts" file:
127.0.0.1 vanilla.example.com
127.0.0.1 forge.example.com
When running mc-router
as a kubernetes pod and you pass the --in-kube-cluster
command-line argument, then
it will automatically watch for any services annotated with
mc-router.itzg.me/externalServerName
: The value of the annotation will be registered as the external hostname Minecraft clients would used to connect to the
routed service. The service's clusterIP and target port are used as the routed backend.mc-router.itzg.me/defaultServer
: The service's clusterIP and target port are used as the default if
no other externalServiceName
annotations applies.For example, start mc-router
's container spec with
image: itzg/mc-router
name: mc-router
args: ["--in-kube-cluster"]
and configure the backend minecraft server's service with the annotation:
apiVersion: v1
kind: Service
metadata:
name: mc-forge
annotations:
"mc-router.itzg.me/externalServerName": "external.host.name"
mc-router
service that exposes a node port 25565--in-kube-cluster
in the mc-router
container arguments"mc-router.itzg.me/externalServerName"
annotation that declares their external server namekubectl apply -f https://raw.githubusercontent.com/itzg/mc-router/master/docs/k8s-example-auto.yaml
Notes
mc-stable
and mc-snapshot
--service-node-port-range=25000-32767
to /etc/kubernetes/manifests/kube-apiserver.yaml
docker pull itzg/mc-router