Upstream/mc-router
1
0
Fork 0
mirror of https://github.com/itzg/mc-router.git synced 2024-12-21 16:07:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add k8s example to the README

Browse Source
This commit is contained in:
Geoff Bourne 2018-05-24 20:19:14 -05:00
parent cbd92bc5b0
commit acfe6edd42
2 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -27,4 +27,23 @@ Flags:
```
* `DELETE /routes/{serverAddress}`
Deletes an existing route for the given `serverAddress`
Deletes an existing route for the given `serverAddress`
## Example kubernetes deployment
[These deployments](docs/k8s-example.yaml) 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.
```bash
kubectl apply -f https://raw.githubusercontent.com/itzg/mc-router/master/docs/k8s-example.yaml
```
![](docs/example-deployment.drawio.png)
**Note**: this deployment assumes two persistent volume claims: `mc-stable` and `mc-snapshot`
## Coming Soon
* Make `mc-router` kubernetes service aware. It would watch for backend instances with well known annotations
and dynamically create/remove routes accordingly

BIN
docs/example-deployment.drawio.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB