docs: clarify allocation sidecar payload flow and limitations#314
Merged
Hauke Löffler (hloeffler) merged 9 commits intoJun 26, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the Allocation Sidecar’s allocation payload flow in the Multiplayer Services documentation, including the two payload directions and a limitation around setting allocation attributes at runtime.
Changes:
- Documented that allocation attributes (
allocator.nitrado.net/labels) cannot be set from game server code via the Agones SDK prefixing behavior. - Added a dataflow table and a Mermaid sequence diagram describing matchmaker → game server payload delivery and game server → allocator callback payload return.
- Expanded the callback payload warning to explain Ready-time caching and the need to ensure annotations are visible before calling
Ready().
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Nicholas Wiersma (nrwiersma)
approved these changes
Jun 26, 2026
Christian R (antiphp)
approved these changes
Jun 26, 2026
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Christian R (antiphp)
approved these changes
Jun 26, 2026
Hauke Löffler (hloeffler)
deleted the
docs/clarify-allocation-sidecar-limitations
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies the allocation sidecar's payload mechanism and documents a limitation around setting attributes from game server code.
Changes
Attributes warning: Added a note that allocation attributes (
allocator.nitrado.net/labels) cannot be set from game server code via the Agones SDK, since the SDK always prefixes withagones.dev/sdk-. Attributes must be configured statically via the GameFabric UI or API.Payload dataflow overview: Added a table and sequence diagram to the "Game server integration" section showing the two data directions (matchmaker → game server, game server → allocator) and which environment variables control each.
Callback timing warning: Expanded the existing danger box under "Return a payload to the Allocator" to explain that the sidecar reads callback annotations once at Ready time and caches the result. It does not re-read at allocation time. Also notes that the Agones SDK does not guarantee immediate visibility of
SetAnnotation, so annotations should be confirmed before callingReady().