Docs: Default Counter Capacity as 1000 (#3637)

* Docs: Default Counter Capacity as 1000 * update docs * Review changes * direct url to the github issue * review change --------- Co-authored-by: igooch <[email protected]>
googleforgames · Feb 13, 2024 · db90b21 · db90b21
1 parent 8b2c442
commit db90b21
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/examples/gameserver.yaml b/examples/gameserver.yaml
@@ -93,7 +93,7 @@ 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. See GitHub issue https://github.com/googleforgames/agones/issues/3636 for more details.
   #   sessions:
   #     count: 1
   # 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.

diff --git a/site/content/en/docs/Guides/Client SDKs/_index.md b/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 setting for the capacity is preset to 1000. It is recommended to avoid configuring the capacity 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

diff --git a/site/content/en/docs/Reference/gameserver.md b/site/content/en/docs/Reference/gameserver.md
@@ -85,7 +85,7 @@ 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. See GitHub issue https://github.com/googleforgames/agones/issues/3636 for more details.
   #   sessions:
   #     count: 1
   # 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.
@@ -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.