Skip to content

Commit

Permalink
Add links to Allocator Service APIs (#2023)
Browse files Browse the repository at this point in the history
The gRPC API is defined in a proto and the REST API has a swagger.json file. Since the API differs slightly from the GameServerAllocation CRD, these links are pretty helpful for using the service.

Add tip about passing data using metaPatch.
  • Loading branch information
jhowcrof authored Mar 11, 2021
1 parent c085be2 commit d6b5881
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions site/content/en/docs/Advanced/allocator-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@ You should expect to see the following output:
{"gameServerName":"game-server-name","ports":[{"name":"default","port":7463}],"address":"1.2.3.4","nodeName":"node-name"}
```

### Sending Data to the Game Server

The service accepts a `metaPatch` field, which can be used to apply `labels` and `annotations` to the allocated `GameServer`.

## Secrets Explained

`agones-allocator` has a dependency on three Kubernetes secrets:
Expand Down Expand Up @@ -225,3 +229,7 @@ If you encounter problems, explore the following potential root causes:
kubectl get service agones-allocator -n agones-system
agones-allocator LoadBalancer 10.55.248.14 34.82.195.204 443:32468/TCP 6d23h
```

## API Reference

The AllocationService API is located as a gRPC service {{< ghlink href="proto/allocation/allocation.proto" >}}here{{< /ghlink >}}. Additionally, the REST API is available as a {{< ghlink href="pkg/allocation/go/allocation.swagger.json" >}}Swagger API{{< /ghlink >}}.

0 comments on commit d6b5881

Please sign in to comment.