mirror of
https://github.com/itzg/mc-router.git
synced 2024-11-21 11:25:41 +01:00
docs: add k8s example to the README
This commit is contained in:
parent
cbd92bc5b0
commit
acfe6edd42
19
README.md
19
README.md
@ -28,3 +28,22 @@ Flags:
|
||||
|
||||
* `DELETE /routes/{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
BIN
docs/example-deployment.drawio.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 60 KiB |
Loading…
Reference in New Issue
Block a user