Docs: Default Counter Capacity as 1000 #3637
Conversation
github-actions
bot
added
kind/cleanup
|
Build Failed 😱 Build Id: 3bf3f90c-5adc-4780-ad0b-db6eadb274b8 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
| @@ -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). | |||
There was a problem hiding this comment.
I've updated the yaml and .md files to show the default setting of 1000 for counters. Can you please check if these updates are ok or if this Note section in the Agones Game Server Client SDKs documentation covers everything needed?
There was a problem hiding this comment.
Only the capacity defaults to 1000, the count defaults to 0.
|
Build Failed 😱 Build Id: 93dbae7c-236a-4193-af06-6c932d8b9227 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
examples/gameserver.yaml
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
| # capacity: 100 # (Optional) Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended. | |
| # capacity: 100 # (Optional) Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended [#3636](https://github.com/googleforgames/agones/issues/3636) |
There was a problem hiding this comment.
We should link back to the GitHub issue so that people can reference the "why". You may need to run make site-server to make sure the link functions correctly on the Agones website https://agones.dev/site/docs/reference/gameserver/.
|
I have updated the |
|
Build Succeeded 👏 Build Id: 0ed24df2-1812-45d8-ab00-0867f4e96d39 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:
|
| @@ -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). | |||
There was a problem hiding this comment.
Only the capacity defaults to 1000, the count defaults to 0.
|
Build Succeeded 👏 Build Id: fe5ad1dc-20e1-4547-8123-5fec8439ac34 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:
|
What type of PR is this?
What this PR does / Why we need it:
Which issue(s) this PR fixes:
Closes #3579
Special notes for your reviewer: