Skip to content

Commit

Permalink
Update: Allocation Overflow Documentation (#3368)
Browse files Browse the repository at this point in the history
* Update: Allocation Overflow Documentation

* updated fleet document

* \n added

* small nit
  • Loading branch information
Kalaiselvi84 committed Sep 12, 2023
1 parent 45e7cb4 commit 963fb15
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
4 changes: 2 additions & 2 deletions examples/fleet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ spec:
maxUnavailable: 25%
# [Stage:Alpha]
# [FeatureFlag:FleetAllocationOverflow]
# Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more
# than the desired replicas on the underlying `GameServerSet`
# Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers exceeds
# the desired replicas in the underlying `GameServerSet`
# Commented out since Alpha, and disabled by default
# allocationOverflow:
# labels:
Expand Down
2 changes: 2 additions & 0 deletions site/content/en/docs/Guides/fleet-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ This provides two useful capabilities:
2. This can also be used to proactively update `GameServer` labels, to effect change in allocation strategy - such as
preferring the newer `GameServers` when allocating, but falling back to the older version if there aren't enough
of the new ones yet spun up.

The labels and/or annotations are applied to `GameServers` in a `Fleet` in the order designated by their configured [Fleet scheduling]({{< ref "/docs/Advanced/scheduling-and-autoscaling#fleet-scheduling">}}).

Example yaml configuration:

Expand Down
5 changes: 4 additions & 1 deletion site/content/en/docs/Reference/fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,13 @@ The `spec` field is the actual `Fleet` specification and it is composed as follo
- `maxSurge` is the amount to increment the new GameServers by. Defaults to 25%
- `maxUnavailable` is the amount to decrements GameServers by. Defaults to 25%
- `allocationOverflow` (Alpha, requires `FleetAllocationOverflow` flag) The labels and/or Annotations to apply to
GameServers when the number of Allocated GameServers drops below the desired replicas on the underlying
GameServers when the number of Allocated GameServers exceeds the desired replicas in the underlying
`GameServerSet`.
- `labels` the map of labels to be applied
- `annotations` the map of annotations to be applied
- `Fleet's Scheduling Strategy`: The GameServers associated with the GameServerSet are sorted based on either `Packed` or `Distributed` strategy.
- `Packed`: Agones maximizes resource utilization by trying to populate nodes that are already in use before allocating GameServers to other nodes.
- `Distributed`: Agones employs this strategy to spread out GameServer allocations, ensuring an even distribution of GameServers across the available nodes.
- `template` a full `GameServer` configuration template.
See the [GameServer]({{< relref "gameserver.md" >}}) reference for all available fields.

Expand Down

0 comments on commit 963fb15

Please sign in to comment.