Skip to content

Commit

Permalink
Explain how namespaces work with allocations (#2257)
Browse files Browse the repository at this point in the history
* Add section explaining namespaces in the allocation reference

* Clean up code

* Make documentation changes based on PR comments

Co-authored-by: Emily Nguyen <eminguyen@google.com>
  • Loading branch information
eminguyen and Emily Nguyen committed Sep 9, 2021
1 parent 155f58b commit 85a6917
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion site/content/en/docs/Reference/gameserverallocation.md
Expand Up @@ -150,5 +150,10 @@ The `spec` field is the actual `GameServerAllocation` specification, and it is c
- `metadata` is an optional list of custom labels and/or annotations that will be used to patch
the game server's metadata in the moment of allocation. This can be used to tell the server necessary session data

[gameserverselector]: {{% ref "/docs/Reference/agones_crd_api_reference.html#allocation.agones.dev/v1.GameServerSelector" %}}
Each `GameServerAllocation` will allocate from a single [namespace][namespace]. The namespace can be specified outside of
the spec, either with the `--namespace` flag when using the command line / `kubectl` or
[in the url]({{% ref "/docs/Guides/access-api.md#allocate-a-gameserver-from-a-fleet-named-simple-game-server-with-gameserverallocation" %}})
when using an API call. If not specified when using the command line, the [namespace][namespace] will be automatically set to `default`.

[gameserverselector]: {{% ref "/docs/Reference/agones_crd_api_reference.html#allocation.agones.dev/v1.GameServerSelector" %}}
[namespace]: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

0 comments on commit 85a6917

Please sign in to comment.