Skip to content

Commit

Permalink
Finished relay quickstart.
Browse files Browse the repository at this point in the history
  • Loading branch information
markmandel committed Oct 4, 2023
1 parent 1cc616d commit b70e7ae
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
25 changes: 13 additions & 12 deletions docs/src/deployment/quickstarts/agones-xonotic-relay.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,13 @@ agent agones` instance and passed through the `quilkin relay instance` into each
In another terminal, run: `kubectl port-forward deployments/quilkin-proxies 8000`, to port forward the
[admin endpoint](../admin.md) locally, which we can then query.

Go back to your original terminal and run `curl -s http://localhost:8000/config`
Go back to your original terminal and run `curl -s http://localhost:8001/config`

> If you have [jq](https://stedolan.github.io/jq/) installed, run `curl -s http://localhost:8000/config | jq` for a
> If you have [jq](https://stedolan.github.io/jq/) installed, run `curl -s http://localhost:8001/config | jq` for a
> nicely formatted JSON output.
```shell
$ curl -s http://localhost:8000/config | jq
$ curl -s http://localhost:8001/config | jq
{
"clusters": [
{
Expand Down Expand Up @@ -208,10 +208,10 @@ our authentication and routing token ("NDU2").

> You should use something more cryptographically random than `456` in your application.
Let's run `curl -s http://localhost:8000/config` again, so we can see what has changed!
Let's run `curl -s http://localhost:8001/config` again, so we can see what has changed!

```shell
❯ curl -s http://localhost:8000/config | jq
❯ curl -s http://localhost:8001/config | jq
{
"clusters": [
{
Expand Down Expand Up @@ -291,18 +291,19 @@ with it in `client-token.yaml`.
Run this edited configuration locally with your quilkin binary as `quilkin -c ./client-token.yaml proxy`:

```shell
$ quilkin -c ./client-token.yaml proxy
{"timestamp":"2022-10-07T22:10:47.257635Z","level":"INFO","fields":{"message":"Starting Quilkin","version":"0.4.0-dev","commit":"c77260a2526542c564829a2c66935c60f00adcd2"},"target":"quilkin::cli"}
{"timestamp":"2022-10-07T22:10:47.258273Z","level":"INFO","fields":{"message":"Starting","port":7000,"proxy_id":"markmandel45"},"target":"quilkin::proxy"}
{"timestamp":"2022-10-07T22:10:47.258321Z","level":"INFO","fields":{"message":"Starting admin endpoint","address":"[::]:9092"},"target":"quilkin::admin"}
{"timestamp":"2022-10-07T22:10:47.258812Z","level":"INFO","fields":{"message":"Quilkin is ready"},"target":"quilkin::proxy"}
$ ./quilkin --config ./client-token.yaml proxy
2023-10-04T20:09:07.320780Z INFO quilkin::cli: src/cli.rs: Starting Quilkin version="0.7.0-dev" commit="d42db7e14c2e0e758e9a6eb655ccf4184941066c"
2023-10-04T20:09:07.321711Z INFO quilkin::admin: src/admin.rs: Starting admin endpoint address=[::]:8000
2023-10-04T20:09:07.322089Z INFO quilkin::cli::proxy: src/cli/proxy.rs: Starting port=7777 proxy_id="markmandel45"
2023-10-04T20:09:07.322576Z INFO quilkin::cli::proxy: src/cli/proxy.rs: Quilkin is ready
2023-10-04T20:09:07.322692Z INFO qcmp_task{v4_addr=0.0.0.0:7600 v6_addr=[::]:7600}: quilkin::protocol: src/protocol.rs: awaiting qcmp packets v4_addr=0.0.0.0:7600 v6_addr=[::]:7600
```

Now connect to the local client proxy on "127.0.0.1:7000" via the "Multiplayer > Address" field in the
Now connect to the local client proxy on "[::1]:7777" via the "Multiplayer > Address" field in the
Xonotic client, and Quilkin will take care of appending the routing token to all your UDP packets, which the Quilkin
proxies will route to the Allocated GameServer, and you can play a gamee!

![xonotic-address.png](xonotic-address.png)
![xonotic-address-v6.png](xonotic-address-v6.png)

...And you didn't have to change the client or the dedicated game server 🤸

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion examples/agones-xonotic-relay/client-token.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ filters:
bytes: NDU2 # 456
clusters:
- endpoints:
- address: ${LOADBALANCER_IP}:7777
- address: 34.168.116.70:7777

0 comments on commit b70e7ae

Please sign in to comment.