Docs: Default Counter Capacity as 1000

examples/counterfleetautoscaler.yaml

@@ -38,10 +38,11 @@ spec:
       # Value can be an absolute number (ex: 5) or a percentage of the Counter available capacity (ex: 5%).
       # An absolute number is calculated from percentage by rounding up. Must be bigger than 0. Required field.
       bufferSize: 5
-      # MinCapacity is the minimum aggregate Counter total capacity across the fleet.
+      # MinCapacity is the minimum aggregate Counter total capacity across the fleet, defaulting to 1000.
       # If BufferSize is specified as a percentage, MinCapacity is required and cannot be 0.
       # If non zero, MinCapacity must be smaller than MaxCapacity and must be greater than or equal to BufferSize.
       minCapacity: 10
-      # MaxCapacity is the maximum aggregate Counter total capacity across the fleet.
-      # MaxCapacity must be greater than or equal to both MinCapacity and BufferSize. Required field.
+      # MaxCapacity is the maximum aggregate Counter total capacity across the fleet, defaulting to 1000.
+      # MaxCapacity must be greater than or equal to both MinCapacity and BufferSize.
+      # Setting MaxCapacity to max(int64) may result in issues. Required field.
       maxCapacity: 100

examples/gameserver.yaml

@@ -93,9 +93,9 @@ spec:
   # counters: # counters are int64 counters that can be incremented and decremented by set amounts. Keys must be declared at GameServer creation time.
   #   games: # arbitrary key.
   #     count: 1 # initial value.
-  #     capacity: 100 # (Optional) Maximum value for the counter. 0 is max(int64).
+  #     capacity: 100 # (Optional) Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended.
   #   sessions:
-  #     count: 1
+  #     count: 1 # Defaults to 1000 and setting count to max(int64) may lead to issues and is not recommended.
   # lists: # lists are lists of values stored against this GameServer that can be added and deleted from. Keys must be declared at GameServer creation time.
   #   players: # an empty list, with a capacity set to 10.
   #     capacity: 10  # capacity value, defaults to 1000.

examples/gameserverallocation.yaml

@@ -54,10 +54,10 @@ spec:
       # [FeatureFlag:CountsAndLists]
       # 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)
+      #     minCount: 1 # minimum value. Defaults to 1000.
+      #     maxCount: 5 # maximum value. Defaults to 1000 and setting count to max(int64) may lead to issues and is not recommended.
+      #     minAvailable: 1 # minimum available (current capacity - current count). Defaults to 1000.
+      #     maxAvailable: 10 # maximum available (current capacity - current count). Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended.
       # lists:
       #   players:
       #     containsValue: "x6k8z" # only match GameServers who has this value in the list. Defaults to "", which is all.

pkg/apis/allocation/v1/gameserverallocation.go

@@ -148,16 +148,16 @@ type PlayerSelector struct {
 
 // CounterSelector is the filter options for a GameServer based on the count and/or available capacity.
 type CounterSelector struct {
-	// MinCount is the minimum current value. Defaults to 0.
+	// MinCount is the minimum current value. Defaults to 1000.
 	// +optional
 	MinCount int64 `json:"minCount"`
-	// MaxCount is the maximum current value. Defaults to 0, which translates as max(in64).
+	// MaxCount is the maximum current value. Defaults to 1000 and setting count to max(int64) may lead to issues and is not recommended.
 	// +optional
 	MaxCount int64 `json:"maxCount"`
-	// MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0.
+	// MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 1000.
 	// +optional
 	MinAvailable int64 `json:"minAvailable"`
-	// MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which translates to max(int64).
+	// MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended.
 	// +optional
 	MaxAvailable int64 `json:"maxAvailable"`
 }

sdks/go/alpha.go

@@ -96,7 +96,9 @@ func (a *Alpha) GetCounterCount(key string) (int64, error) {
 }
 
 // IncrementCounter increases a counter by the given nonnegative integer amount.
-// Will execute the increment operation against the current CRD value. Will max at max(int64).
+// Will execute the increment operation against the current CRD value.
+// By default, the counter's capacity is set to 1000. Attempting to set the capacity
+// to max(int64) could lead to issues and is not recommended.
 // Will error if the key was not predefined in the GameServer resource on creation.
 // Returns false if the count is at the current capacity (to the latest knowledge of the SDK),
 // and no increment will occur.

site/content/en/docs/Guides/Client SDKs/_index.md

@@ -264,6 +264,8 @@ to the capacity of that Counter or List.
 All functions will return an error if the specified `key` is not predefined in the 
 [`GameServer.Spec.Counters`][gameserverspec] resource configuration.
 
+**Note:** For Counters, the default settings for both capacity and count are preset to 1000. It is recommended to avoid configuring the capacity or count to max(int64), as doing so could cause problems with [JSON Patch operations](https://github.com/googleforgames/agones/issues/3636).
+
 ##### Alpha().GetCounterCount(key)
 
 This function retrieves either the [`GameServer.Status.Counters[key].Count`][gameserverstatus] or the SDK awaiting-batch

site/content/en/docs/Reference/fleet.md

@@ -132,7 +132,7 @@ The `spec` field is the actual `Fleet` specification and it is composed as follo
 - `priorities`: (Alpha, requires `CountsAndLists` feature flag): Defines which gameservers in the Fleet are most important to keep around - impacts scale down logic.
   - `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.
+  - `order`: Order: Sort by “Ascending” or “Descending”. “Descending” a bigger Capacity is preferred. “Ascending” would be smaller Capacity is preferred. Note that the default Counters capacity is 1000 and setting Counters capacity to max(int64) may lead to issues and is not recommended.
 - `template` a full `GameServer` configuration template.
    See the [GameServer]({{< relref "gameserver.md" >}}) reference for all available fields.
 

site/content/en/docs/Reference/fleetautoscaler.md

@@ -82,12 +82,13 @@ spec:
       # Value can be an absolute number (ex: 5) or a percentage of the Counter available capacity (ex: 5%).
       # An absolute number is calculated from percentage by rounding up. Must be bigger than 0. Required field.
       bufferSize: 5
-      # MinCapacity is the minimum aggregate Counter total capacity across the fleet.
+      # MinCapacity is the minimum aggregate Counter total capacity across the fleet, defaulting to 1000.
       # If BufferSize is specified as a percentage, MinCapacity is required and cannot be 0.
       # If non zero, MinCapacity must be smaller than MaxCapacity and must be greater than or equal to BufferSize.
       minCapacity: 10
-      # MaxCapacity is the maximum aggregate Counter total capacity across the fleet.
-      # MaxCapacity must be greater than or equal to both MinCapacity and BufferSize. Required field.
+      # MaxCapacity is the maximum aggregate Counter total capacity across the fleet, defaulting to 1000.
+      # MaxCapacity must be greater than or equal to both MinCapacity and BufferSize.
+      # Setting MaxCapacity to max(int64) may result in issues. Required field.
       maxCapacity: 100
 ```
 
@@ -210,8 +211,8 @@ The `spec` field of the `FleetAutoscaler` is composed as follows:
     - `counter` contains the settings for counter-based autoscaling:
       - `key` is the name of the counter to use for scaling decisions.
       - `bufferSize` is the size of a buffer of counted items that are available in the Fleet (available capacity). Value can be an absolute number or a percentage of desired game server instances. An absolute number is calculated from percentage by rounding up. Must be bigger 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.
-      - `maxCapacity` is the maximum aggregate Counter total capacity across the fleet. It must be bigger than both MinCapacity and BufferSize.
+      - `minCapacity` is the minimum aggregate Counter total capacity across the fleet, defaulting to 1000. If zero, MinCapacity is ignored. If non zero, MinCapacity must be smaller than MaxCapacity and bigger than BufferSize.
+      - `maxCapacity` is the maximum aggregate Counter total capacity across the fleet, defaulting to 1000. It must be bigger than both MinCapacity and BufferSize. Note that setting capacity to max(int64) may lead to issues and is not recommended.
   - `list` parameters of the list policy type
     - `list` contains the settings for list-based autoscaling:
       - `key` is the name of the list to use for scaling decisions.

site/content/en/docs/Reference/gameserver.md

@@ -85,9 +85,9 @@ spec:
   # counters: # counters are int64 counters that can be incremented and decremented by set amounts. Keys must be declared at GameServer creation time.
   #   games: # arbitrary key.
   #     count: 1 # initial value.
-  #     capacity: 100 # (Optional) Maximum value for the counter. 0 is max(int64).
+  #     capacity: 100 # (Optional) Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended.
   #   sessions:
-  #     count: 1
+  #     count: 1 # Defaults to 1000 and setting count to max(int64) may lead to issues and is not recommended.
   # lists: # lists are lists of values stored against this GameServer that can be added and deleted from. Keys must be declared at GameServer creation time.
   #   players: # an empty list, with a capacity set to 10.
   #     capacity: 10 # capacity value, defaults to 1000.
@@ -146,7 +146,7 @@ The `spec` field is the actual GameServer specification and it is composed as fo
   - `grpcPort` the port that the SDK Server binds to for gRPC connections
   - `httpPort` the port that the SDK Server binds to for HTTP gRPC gateway connections
 - `players` (Alpha, behind "PlayerTracking" feature gate), sets this GameServer's initial player capacity
-- `counters` (Alpha, requires "CountsAndLists" feature flag) are int64 counters that can be incremented and decremented by set amounts. Keys must be declared at GameServer creation time.
+- `counters` (Alpha, requires "CountsAndLists" feature flag) are int64 counters with a default capacity of 1000 that can be incremented and decremented by set amounts. Keys must be declared at GameServer creation time. Note that setting the capacity to max(int64) may lead to issues.
 - `lists` (Alpha, requires "CountsAndLists" feature flag) are lists of values stored against this GameServer that can be added and deleted from. Key must be declared at GameServer creation time.
 - `template` the [pod spec template]({{% k8s-api-version href="#podtemplatespec-v1-core" %}}) to run your GameServer containers, [see](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates) for more information.
 

site/content/en/docs/Reference/gameserverallocation.md

@@ -50,10 +50,10 @@ spec:
       # [FeatureFlag:CountsAndLists]
       # 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)
+      #     minCount: 1 # minimum value. Defaults to 1000.
+      #     maxCount: 5 # maximum value. Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended.
+      #     minAvailable: 1 # minimum available (current capacity - current count). Defaults to 1000.
+      #     maxAvailable: 10 # maximum available (current capacity - current count). Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended.
       # lists:
       #   players:
       #     containsValue: "x6k8z" # only match GameServers who has this value in the list. Defaults to "", which is all.
@@ -188,7 +188,7 @@ The `spec` field is the actual `GameServerAllocation` specification, and it is c
   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
+  the minimum and maximum number of active rooms, defaulting to a capacity of 1000. 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.