Skip to content

Add selectable fields to gameserver crd #4542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swermin wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add selectable fields to gameserver crd #4542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26d9e66
Add selectable fields to gameserver crd
swermin Apr 29, 2026
01bb3ff
run make gen-install
swermin Apr 29, 2026
84dcbc0
make the selectable fields configurable
swermin May 5, 2026
c9170ba
add documentation for new selectable fields
swermin May 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions install/helm/agones/templates/crds/gameserver.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ spec:
- name: v1
served: true
storage: true
{{- with .Values.gameservers.selectableFields }}
selectableFields:
{{- range . }}
- jsonPath: {{ . }}
{{- end }}
{{- end }}
additionalPrinterColumns:
- jsonPath: .status.state
name: State
Expand Down
3 changes: 3 additions & 0 deletions install/helm/agones/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,9 @@ gameservers:
# requires feature gate PortRanges to be enabled
# game: [9000, 10000]
podPreserveUnknownFields: false
selectableFields:
- .status.state
- .status.nodeName
lists:
maxItems: 1000

Expand Down
3 changes: 3 additions & 0 deletions install/yaml/install.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7397,6 +7397,9 @@ spec:
- name: v1
served: true
storage: true
selectableFields:
- jsonPath: .status.state
- jsonPath: .status.nodeName
additionalPrinterColumns:
- jsonPath: .status.state
name: State
Expand Down
19 changes: 11 additions & 8 deletions site/content/en/docs/Installation/Install Agones/helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,14 +390,17 @@ The following tables lists the configurable parameters of the Agones chart and t

### GameServers

| Parameter | Description | Default |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `gameservers.namespaces` | a list of namespaces you are planning to use to deploy game servers | `["default"]` |
| `gameservers.minPort` | Minimum port to use for dynamic port allocation | `7000` |
| `gameservers.maxPort` | Maximum port to use for dynamic port allocation | `8000` |
| `gameservers.additionalPortRanges` | Port ranges from which to do named dynamic port allocation. Example: <br /> additionalPortRanges: <br />&nbsp;&nbsp;game: [9000, 10000] | `{}` |
| `gameservers.podPreserveUnknownFields` | Disable [field pruning][pruning] and schema validation on the Pod template for a [GameServer][gameserver] definition | `false` |
| `gameservers.lists.maxItems` | The maximum number of items that can be specified for a list. | `1000` |
| Parameter | Description | Default |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------|
| `gameservers.namespaces` | a list of namespaces you are planning to use to deploy game servers | `["default"]` |
| `gameservers.minPort` | Minimum port to use for dynamic port allocation | `7000` |
| `gameservers.maxPort` | Maximum port to use for dynamic port allocation | `8000` |
| `gameservers.additionalPortRanges` | Port ranges from which to do named dynamic port allocation. Example: <br /> additionalPortRanges: <br />&nbsp;&nbsp;game: [9000, 10000] | `{}` |
| `gameservers.podPreserveUnknownFields` | Disable [field pruning][pruning] and schema validation on the Pod template for a [GameServer][gameserver] definition | `false` |
{{% feature publishVersion="1.58.0" %}}
| `gameservers.selectableFields` | spec fields available or querying [GameServer][gameserver] resources based | `[".status.state", "status.nodeName"]` |
{{% /feature %}}
| `gameservers.lists.maxItems` | The maximum number of items that can be specified for a list. | `1000` |


### Helm Installation
Expand Down
11 changes: 11 additions & 0 deletions site/content/en/docs/Reference/gameserver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,17 @@ The `spec` field is the actual GameServer specification and it is composed as fo
The GameServer resource does not support updates. If you need to make regular updates to the GameServer spec, consider using a [Fleet]({{< ref "/docs/Reference/fleet.md" >}}).
{{% /alert %}}

{{% feature publishVersion="1.58.0" %}}
## Selectable fields

Agones supports selectable fields for querying `GameServer` resources based on spec field values. This feature enables efficient server-side filtering of `GameServer` resources.

The following spec fields are available for field selectors in `GameServer` resources:
- status.state - The lifecycle of the `GameServer` (See **GameServer State Diagram**)
- status.nodeName - The node which the `GameServer` is running on

{{% /feature %}}

## Sidecar Containers

Agones supports the use of [Sidecar Containers](https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/) with exposed ports.
Expand Down
Loading