CountersAndLists in Reference Documentation #3529
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Kalaiselvi84 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Build Failed 😱 Build Id: 72445e26-0c22-4e97-95e2-8af9f524886f To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
|
@markmandel, We have two YAML files for |
|
Looks like a weird flake in the integration tests: |
|
A good start!
Ah - good question. We should have a separate file for each - for example we have https://github.com/googleforgames/agones/blob/main/examples/webhookfleetautoscaler.yaml for the webhook autoscaler type autoscaling.
Ah also a good question - we'll also want new sections in the FleetAutoscaler documentation as well - much like we have a new section for the "Or for Webhook FleetAutoscaler below and in example folder :" section.
You can ignore that section for now, that can be integrated into some more advanced usage documentation in the future. For now we'll focus on just reference documentation for the yaml files. |
Included counters and lists based Fleetautoscaler specifications.👍🏻 |
|
Build Succeeded 👏 Build Id: 5e84c4b1-d9b3-4938-9c7b-25a656c8114b The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
|
Build Failed 😱 Build Id: 5c757714-16d9-459b-9a8f-065989ae08ef To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
|
I think I fixed this flake in #3534 |
This reverts commit 59900ca.
|
Build Failed 😱 Build Id: 4fc319ec-12c7-403d-91f5-f386a87f8615 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
| @@ -47,6 +47,65 @@ spec: | |||
| seconds: 30 | |||
| ``` | |||
|
|
|||
| {{% feature publishVersion="1.37.0" %}} | |||
There was a problem hiding this comment.
In terms of ordering the page, the Counters and Lists examples should probably go after the webhook autoscaling example since they're still in Alpha.
There was a problem hiding this comment.
Similar comment to what Mark mentioned in fleet.md. Mention Counters and Lists in the bullet point notes below the examples
There was a problem hiding this comment.
Went through the listed items, and checked to see if everything was there, and did a review of the existing language we had.
@igooch would love your extra review, see if I missed anything, anything needs adding or wrote anything weird 😄
I've also got a PR incoming, with some tweaks to the Go CRD datasture comments to reflect some of these changes, need to make a couple more tweaks and will then submit it.
|
Build Succeeded 👏 Build Id: 00dbfe2a-5406-4bb2-9a6f-35969da61f92 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
|
@markmandel I've added the |
|
Build Failed 😱 Build Id: 284911a3-79ce-4757-8075-07744eaf3770 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
|
Build Failed 😱 Build Id: a7dddac9-ce8b-468d-a744-81940fc9ce97 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
| - `type: List`: Sorts GameServers based on a list metric. | ||
| - `key`: The name of the List. No impact if no GameServer found. | ||
| - `order`: The sort order, default is "Ascending" so smaller capacity will be removed first on downscaling. |
There was a problem hiding this comment.
| - `type: List`: Sorts GameServers based on a list metric. | |
| - `key`: The name of the List. No impact if no GameServer found. | |
| - `order`: The sort order, default is "Ascending" so smaller capacity will be removed first on downscaling. |
| - `type: Counter`: Sorts GameServers by a "counter". | ||
| - `key`: The name of the Counter. No impact if no GameServer found. | ||
| - `order`: The sort order, default is "Ascending" so smaller capacity will be removed first on down scaling. |
There was a problem hiding this comment.
Lifting from http://localhost:1313/docs/reference/agones_crd_api_reference/#agones.dev/v1.Priority
| - `type: Counter`: Sorts GameServers by a "counter". | |
| - `key`: The name of the Counter. No impact if no GameServer found. | |
| - `order`: The sort order, default is "Ascending" so smaller capacity will be removed first on down scaling. | |
| - `type`: Sort by a “Counter” or a “List”. | |
| - `key`: The name of the Counter or List. If not found on the GameServer, has no impact. | |
| - `order`: Order: Sort by “Ascending” or “Descending”. “Descending” a bigger Capacity is preferred. “Ascending” would be smaller Capacity is preferred. |
| @@ -226,6 +238,13 @@ The `spec` field is the actual `Fleet` specification and it is composed as follo | |||
| - `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. | |||
| - `priorities` (Alpha, requires `CountsAndLists` feature flag): Defines which gameservers in the Fleet are most important to keep around - impacts scale down logic. | |||
There was a problem hiding this comment.
Tweaking some formatting and docs, but this is exactly what we need here and in the other .md files in this PR 👍🏻
| - `priorities` (Alpha, requires `CountsAndLists` feature flag): Defines which gameservers in the Fleet are most important to keep around - impacts scale down logic. | |
| - `priorities`: (Alpha, requires `CountsAndLists` feature flag): Defines which gameservers in the Fleet are most important to keep around - impacts scale down logic. |
| # nodeSelector: | ||
| # kubernetes.io/os: windows | ||
| ``` | ||
| {{% /feature %}} |
There was a problem hiding this comment.
Same as the markdown files - need each of the fields described below please (line 219 onwards)
There was a problem hiding this comment.
I think you intended for the counters and lists fields to be included within the spec field?
| maxCapacity: 100 | ||
| ``` | ||
| {{% /feature %}} | ||
|
|
There was a problem hiding this comment.
Same as you did in fleet.md - need the fields desribed in the section from 144 onwards.
There was a problem hiding this comment.
same doubt, the fields in the counter and list for the autoscaling to be included in the spec field?
| # containsValue: "x6k8z" # only match GameServers who has this value in the list. Defaults to "", which is all. | ||
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | ||
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to 0, which translates to max(int64) | ||
| # |
There was a problem hiding this comment.
| # | |
| # counters: # (Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. | |
| # rooms: | |
| # action: increment # Either “Increment” or “Decrement” the Counter’s Count. | |
| # amount: 1 # Amount is the amount to increment or decrement the Count. Must be a positive integer. | |
| # capacity: 5 # Amount to update the maximum capacity of the Counter to this number. Min 0, Max int64. | |
| # lists: # (Alpha, CountsAndLists feature flag) List actions to perform during allocation. | |
| # players: | |
| # addValues: # appends values to a List’s Values array. Any duplicate values will be ignored | |
| # - x7un | |
| # - 8inz | |
| # capacity: 40 # Updates the maximum capacity of the Counter to this number. Min 0, Max 1000. | |
| # |
Please add this in (this was the actions mentioned previously) - and also make sure it shows up in the field description section below.
@igooch did I mess anything up there?
| - `CountsAndLists` has two key elements for game server allocation process. | ||
| - `counters` allows setting limits on game server, such as the minimum and maximum number of active rooms. This helps in selecting game servers based on their current activity or capacity. | ||
| - `lists` enables game server allocation based on specific player lists, allowing for inclusion or exclusion of specific players. |
There was a problem hiding this comment.
| - `CountsAndLists` has two key elements for game server allocation process. | |
| - `counters` allows setting limits on game server, such as the minimum and maximum number of active rooms. This helps in selecting game servers based on their current activity or capacity. | |
| - `lists` enables game server allocation based on specific player lists, allowing for inclusion or exclusion of specific players. | |
| - `counters` (Alpha, CountsAndLists feature flag) allows setting limits on game server, such as the minimum and maximum number of active rooms. This helps in selecting game servers based on their current activity or capacity. | |
| - `lists` (Alpha, CountsAndLists feature flag) enables game server allocation based on specific player lists, allowing for inclusion or exclusion of specific players. |
Also these new property values will need to have feature shortcodes please as well everywhere.
|
Please feel free to resolve the conversations if you're satisfied with the changes😅 |
|
Build Succeeded 👏 Build Id: c6e8bb7c-733b-4611-b8bb-3184e02ddfaa The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
|
Build Succeeded 👏 Build Id: 7b6fa25b-a946-4864-8ca2-905a2ef1cb43 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
examples/counterfleetautoscaler.yaml
Outdated
| # bufferSize can be specified either in absolute (i.e. 5) or percentage format (i.e. 5%). | ||
| # Required. | ||
| # BufferSize is the size of a buffer of counted items that are available in the Fleet (available capacity). | ||
| # Value can be an absolute number (ex: 5) or a percentage of desired gs instances (ex: 5%). |
There was a problem hiding this comment.
The percentage buffer refers to the Counter available capacity, not the number of game server instances.
There was a problem hiding this comment.
I have updated both the counterfleetautoscaler.yaml and fleetautoscaler.md files with this information
examples/counterfleetautoscaler.yaml
Outdated
| # When bufferSize in percentage format is used, minCapacity should be set and more than 0. | ||
| # MinCapacity is the minimum aggregate Counter total capacity across the fleet. | ||
| # If zero, MinCapacity is ignored. | ||
| # If non zero, MinCapacity must be smaller than MaxCapacity and bigger than BufferSize. |
There was a problem hiding this comment.
MinCapacity can be >= BufferSize.
examples/counterfleetautoscaler.yaml
Outdated
| # If minCapacity is not specified, the effective minimum capacity will be bufferSize. | ||
| # When bufferSize in percentage format is used, minCapacity should be set and more than 0. | ||
| # MinCapacity is the minimum aggregate Counter total capacity across the fleet. | ||
| # If zero, MinCapacity is ignored. |
There was a problem hiding this comment.
If BufferSize is a percentage MinCapacity is required and cannot be 0.
examples/counterfleetautoscaler.yaml
Outdated
| # Maximum aggregate counter capacity that can be provided by this FleetAutoscaler. | ||
| # Required. | ||
| # MaxCapacity is the maximum aggregate Counter total capacity across the fleet. | ||
| # MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. |
There was a problem hiding this comment.
MaxCapacity can be >= BufferSize and MinCapacity.
examples/listfleetautoscaler.yaml
Outdated
| # When bufferSize in percentage format is used, minCapacity should be set and more than 0. | ||
| # MinCapacity is the minimum aggregate List total capacity across the fleet. | ||
| # If zero, it is ignored. | ||
| # If non zero, it must be smaller than MaxCapacity and bigger than BufferSize. |
There was a problem hiding this comment.
MinCapacity can be >= BufferSize.
examples/listfleetautoscaler.yaml
Outdated
| # Maximum aggregate list capacity that can be provided by this FleetAutoscaler. | ||
| # Required. | ||
| # MaxCapacity is the maximum aggregate List total capacity across the fleet. | ||
| # MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. |
There was a problem hiding this comment.
MaxCapacity can be >= BufferSize and MinCapacity.
| # counters: # (Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. | ||
| # rooms: | ||
| # action: increment # Either "Increment" or "Decrement" the Counter’s Count. | ||
| # amount: 1 # Amount is the amount to increment or decrement the Count. Must be a positive integer. | ||
| # capacity: 5 # Amount to update the maximum capacity of the Counter to this number. Min 0, Max int64. | ||
| # lists: # (Alpha, CountsAndLists feature flag) List actions to perform during allocation. | ||
| # players: | ||
| # addValues: # appends values to a List’s Values array. Any duplicate values will be ignored | ||
| # - x7un | ||
| # - 8inz | ||
| # capacity: 40 # Updates the maximum capacity of the Counter to this number. Min 0, Max 1000. | ||
| # |
There was a problem hiding this comment.
| # counters: # (Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. | |
| # rooms: | |
| # action: increment # Either "Increment" or "Decrement" the Counter’s Count. | |
| # amount: 1 # Amount is the amount to increment or decrement the Count. Must be a positive integer. | |
| # capacity: 5 # Amount to update the maximum capacity of the Counter to this number. Min 0, Max int64. | |
| # lists: # (Alpha, CountsAndLists feature flag) List actions to perform during allocation. | |
| # players: | |
| # addValues: # appends values to a List’s Values array. Any duplicate values will be ignored | |
| # - x7un | |
| # - 8inz | |
| # capacity: 40 # Updates the maximum capacity of the Counter to this number. Min 0, Max 1000. | |
| # |
| # priorities: | ||
| # counters: # selector for counter current values of a GameServer count | ||
| # rooms: | ||
| # minCount: 1 # minimum value. Defaults to 0. | ||
| # maxCount: 5 # maximum value. Defaults to max(int64) | ||
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | ||
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to max(int64) | ||
| # lists: | ||
| # players: | ||
| # containsValue: "x6k8z" # only match GameServers who has this value in the list. Defaults to "", which is all. | ||
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | ||
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to 0, which translates to max(int64) |
There was a problem hiding this comment.
| # priorities: | |
| # counters: # selector for counter current values of a GameServer count | |
| # rooms: | |
| # minCount: 1 # minimum value. Defaults to 0. | |
| # maxCount: 5 # maximum value. Defaults to max(int64) | |
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | |
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to max(int64) | |
| # lists: | |
| # players: | |
| # containsValue: "x6k8z" # only match GameServers who has this value in the list. Defaults to "", which is all. | |
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | |
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to 0, which translates to max(int64) | |
| # counters: # selector for counter current values of a GameServer count | |
| # rooms: | |
| # minCount: 1 # minimum value. Defaults to 0. | |
| # maxCount: 5 # maximum value. Defaults to max(int64) | |
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | |
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to max(int64) | |
| # lists: | |
| # players: | |
| # containsValue: "x6k8z" # only match GameServers who has this value in the list. Defaults to "", which is all. | |
| # minAvailable: 1 # minimum available (current capacity - current count). Defaults to 0. | |
| # maxAvailable: 10 # maximum available (current capacity - current count) Defaults to 0, which translates to max(int64) |
There was a problem hiding this comment.
Add below suggested code after (and inline with) "metadata".
# [Stage:Alpha]
# [FeatureFlag:CountsAndLists]
# The first Priority on the array of Priorities is the most important for sorting. The allocator will
# use the first priority for sorting GameServers by available Capacity in the Selector set. Acts as a
# tie-breaker after sorting the game servers by State and Strategy Packed. Impacts which GameServer
# is checked first. Optional.
# priorities:
# - type: List # Whether a Counter or a List.
# key: rooms # The name of the Counter or List.
# order: Ascending # "Ascending" lists smaller available capacity first.
# [Stage:Alpha]
# [FeatureFlag:CountsAndLists]
# Counter actions to perform during allocation. Optional.
# counters:
# rooms:
# action: increment # Either "Increment" or "Decrement" the Counter’s Count.
# amount: 1 # Amount is the amount to increment or decrement the Count. Must be a positive integer.
# capacity: 5 # Amount to update the maximum capacity of the Counter to this number. Min 0, Max int64.
# List actions to perform during allocation. Optional.
# lists:
# players:
# addValues: # appends values to a List’s Values array. Any duplicate values will be ignored
# - x7un
# - 8inz
# capacity: 40 # Updates the maximum capacity of the Counter to this number. Min 0, Max 1000.
There was a problem hiding this comment.
Under "selectors is an ordered list of..." add:
- `matchLabels` is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value".
The requirements are ANDed. Optional.
- `matchExpressions` is a list of label selector requirements. The requirements are ANDed. Optional.
- `gameServerState` GameServerState specifies which State is the filter to be used when attempting to retrieve a
GameServer via Allocation. Defaults to "Ready". The only other option is "Allocated", which can be used in
conjunction with label/annotation/player selectors to retrieve an already Allocated GameServer.
- `counters` (Alpha, "CountsAndLists" feature flag) enables filtering based on game server Counter status, such as
the minimum and maximum number of active rooms. This helps in selecting game servers based on their current activity
or capacity. Optional.
- `lists` (Alpha, "CountsAndLists" feature flag) enables filtering based on game server List status, such as allowing
for inclusion or exclusion of specific players. Optional.
| - `priorities` (Alpha, requires `CountsAndLists` feature flag) manages counters and lists for game servers, setting limits on room counts and player inclusion/exclusion. | ||
| - `counters` (Alpha, "CountsAndLists" feature flag) allows setting limits on game server, such as the minimum and maximum number of active rooms. This helps in selecting game servers based on their current activity or capacity. | ||
| - `lists` (Alpha, "CountsAndLists" feature flag) enables game server allocation based on specific player lists, allowing for inclusion or exclusion of specific players. |
There was a problem hiding this comment.
| - `priorities` (Alpha, requires `CountsAndLists` feature flag) manages counters and lists for game servers, setting limits on room counts and player inclusion/exclusion. | |
| - `counters` (Alpha, "CountsAndLists" feature flag) allows setting limits on game server, such as the minimum and maximum number of active rooms. This helps in selecting game servers based on their current activity or capacity. | |
| - `lists` (Alpha, "CountsAndLists" feature flag) enables game server allocation based on specific player lists, allowing for inclusion or exclusion of specific players. | |
| - `priorities` (Alpha, requires `CountsAndLists` feature flag) manages counters and lists for game servers, setting limits on | |
| room counts and player inclusion/exclusion. | |
| - `counters` (Alpha, "CountsAndLists" feature flag) Counter actions to perform during allocation. | |
| - `lists` (Alpha, "CountsAndLists" feature flag) List actions to perform during allocation. |
|
Build Succeeded 👏 Build Id: e778c69f-0c7e-41b4-b561-4e05387b7f0c The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
| # When bufferSize in percentage format is used, minCapacity should be set and more than 0. | ||
| # MinCapacity is the minimum aggregate Counter total capacity across the fleet. | ||
| # If BufferSize is specified as a percentage, MinCapacity is required and cannot be 0. | ||
| # If non zero, MinCapacity must be smaller than MaxCapacity and it can be greater than or equal to BufferSize. |
There was a problem hiding this comment.
| # If non zero, MinCapacity must be smaller than MaxCapacity and it can be greater than or equal to BufferSize. | |
| # If non zero, MinCapacity must be smaller than MaxCapacity and must be greater than or equal to BufferSize. |
| # If zero, it is ignored. | ||
| # If non zero, it must be smaller than MaxCapacity and can be greater than or equal to BufferSize. |
There was a problem hiding this comment.
| # If zero, it is ignored. | |
| # If non zero, it must be smaller than MaxCapacity and can be greater than or equal to BufferSize. | |
| # If BufferSize is specified as a percentage, MinCapacity is required must be greater than 0. | |
| # If non zero, MinCapacity must be smaller than MaxCapacity and must be greater than or equal to BufferSize. |
| bufferSize: 5 | ||
| # MinCapacity is the minimum aggregate Counter total capacity across the fleet. | ||
| # If BufferSize is specified as a percentage, MinCapacity is required and cannot be 0. | ||
| # If non zero, MinCapacity must be smaller than MaxCapacity and it can be greater than or equal to BufferSize. |
There was a problem hiding this comment.
| # If non zero, MinCapacity must be smaller than MaxCapacity and it can be greater than or equal to BufferSize. | |
| # If non zero, MinCapacity must be smaller than MaxCapacity and must be greater than or equal to BufferSize. |
| # If zero, it is ignored. | ||
| # If non zero, it must be smaller than MaxCapacity and can be greater than or equal to BufferSize. |
There was a problem hiding this comment.
| # If zero, it is ignored. | |
| # If non zero, it must be smaller than MaxCapacity and can be greater than or equal to BufferSize. | |
| # If BufferSize is specified as a percentage, MinCapacity is required must be greater than 0. | |
| # If non zero, MinCapacity must be smaller than MaxCapacity and must be greater than or equal to BufferSize. |
| @@ -61,6 +224,31 @@ spec: | |||
| mode: deathmatch | |||
| annotations: | |||
| map: garden22 | |||
| # [Stage:Alpha] | |||
There was a problem hiding this comment.
| # [Stage:Alpha] | |
| # [Stage:Alpha] |
|
I have made changes based on your suggestion, Ivy. |
|
Build Succeeded 👏 Build Id: 5a674c54-ffe3-4b62-a19b-699d6646e1d3 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
|
@gongmax please hold on, the last commit is still in processing |
|
Will close this PR since it is being handled in #3552 |
What type of PR is this?
What this PR does / Why we need it:
Which issue(s) this PR fixes:
Work on #2716
Special notes for your reviewer: