Routes Minecraft client connections to backend servers based upon the requested server address
Go to file
2018-05-26 12:42:41 -05:00
.circleci ci: abstract glide into makefile 2018-05-26 12:42:41 -05:00
cmd/mc-router Auto-register routes based on kubernetes service annotations 2018-05-26 12:31:40 -05:00
docs docs: add k8s example to the README 2018-05-24 20:19:14 -05:00
mcproto Initial commit 2018-05-07 22:16:01 -05:00
server Auto-register routes based on kubernetes service annotations 2018-05-26 12:31:40 -05:00
.gitignore Initial commit 2018-05-07 22:16:01 -05:00
.goreleaser.yml ci: install glide 2018-05-26 12:35:11 -05:00
Dockerfile Setup CircleCI and goreleaser 2018-05-09 18:37:15 -05:00
glide.lock Auto-register routes based on kubernetes service annotations 2018-05-26 12:31:40 -05:00
glide.yaml Auto-register routes based on kubernetes service annotations 2018-05-26 12:31:40 -05:00
LICENSE.txt Initial commit 2018-05-07 22:16:01 -05:00
Makefile ci: abstract glide into makefile 2018-05-26 12:42:41 -05:00
README.md docs: noted the extended service node port range 2018-05-24 20:26:33 -05:00

Routes Minecraft client connections to backend servers based upon the requested server address.

Usage

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 of external hostname to internal server
                             host:port

REST API

  • GET /routes Retrieves the currently configured routes
  • POST /routes Registers a route given a JSON body structured like:
{
  "serverAddress": "CLIENT REQUESTED SERVER ADDRESS",
  "backend": "HOST:PORT"
}
  • DELETE /routes/{serverAddress} Deletes an existing route for the given serverAddress

Example kubernetes deployment

These deployments declare an mc-router that exposes a node port service on the standard Minecraft server port 25565. Two "backend" Minecraft servers are declared as example where users can choose stable/vanilla or snapshot simply based on the hostname they used.

kubectl apply -f https://raw.githubusercontent.com/itzg/mc-router/master/docs/k8s-example.yaml

Notes

  • This deployment assumes two persistent volume claims: mc-stable and mc-snapshot
  • I extended the allowed node port range by adding --service-node-port-range=25000-32767 to /etc/kubernetes/manifests/kube-apiserver.yaml

Coming Soon

  • Make mc-router kubernetes service aware. It would watch for backend instances with well known annotations and dynamically create/remove routes accordingly