Agones Kubernetes API

Labels to be applied to the GameServer

Annotations to be applied to the GameServer

Game server supports termination via SIGTERM: - Always: Allow eviction for both Cluster Autoscaler and node drain for upgrades - OnUpgrade: Allow eviction for upgrades alone - Never (default): Pod should run to completion

Replicas are the number of GameServers that should be in this set. Defaults to 0.

Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more than the desired replicas on the underlying GameServerSet

Deployment strategy

Scheduling strategy. Defaults to “Packed”.

[Stage: Beta] [FeatureFlag:CountsAndLists] Priorities configuration alters scale down logic in Fleets based on the configured available capacity order under that key.

Priority of sorting is in descending importance. I.e. The position 0 priority entry is checked first.

For Packed strategy scale down, this priority list will be the tie-breaker within the node, to ensure optimal infrastructure usage while also allowing some custom prioritisation of GameServers.

For Distributed strategy scale down, the entire Fleet will be sorted by this priority list to provide the order of GameServers to delete on scale down.

Template the GameServer template to apply for this Fleet

Replicas the total number of current GameServer replicas

ReadyReplicas are the number of Ready GameServer replicas

ReservedReplicas are the total number of Reserved GameServer replicas in this fleet. Reserved instances won’t be deleted on scale down, but won’t cause an autoscaler to scale up.

AllocatedReplicas are the number of Allocated GameServer replicas

[Stage:Alpha] [FeatureFlag:PlayerTracking] Players are the current total player capacity and count for this Fleet

(Beta, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter count for this Fleet.

(Beta, CountsAndLists feature flag) Lists provides aggregated List capacityv and List values for this Fleet.

Name is the descriptive name of the port

(Alpha, PortRanges feature flag) Range is the port range name from which to select a port when using a ‘Dynamic’ or ‘Passthrough’ port policy.

PortPolicy defines the policy for how the HostPort is populated. Dynamic port will allocate a HostPort within the selected MIN_PORT and MAX_PORT range passed to the controller at installation time. When Static portPolicy is specified, HostPort is required, to specify the port that game clients will connect to Passthrough dynamically sets the containerPort to the same value as the dynamically selected hostPort. None portPolicy ignores HostPort and the containerPort (optional) is used to set the port on the GameServer instance.

Container is the name of the container on which to open the port. Defaults to the game server container.

ContainerPort is the port that is being opened on the specified container’s process

HostPort the port exposed on the host for clients to connect to

Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options.

Replicas are the number of GameServers that should be in this set

Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below the desired replicas on the underlying GameServerSet

Scheduling strategy. Defaults to “Packed”.

[Stage: Beta] [FeatureFlag:CountsAndLists] Priorities configuration alters scale down logic in Fleets based on the configured available capacity order under that key.

Priority of sorting is in descending importance. I.e. The position 0 priority entry is checked first.

For Packed strategy scale down, this priority list will be the tie-breaker within the node, to ensure optimal infrastructure usage while also allowing some custom prioritisation of GameServers.

For Distributed strategy scale down, the entire Fleet will be sorted by this priority list to provide the order of GameServers to delete on scale down.

Template the GameServer template to apply for this GameServerSet

Replicas is the total number of current GameServer replicas

ReadyReplicas is the number of Ready GameServer replicas

ReservedReplicas is the number of Reserved GameServer replicas

AllocatedReplicas is the number of Allocated GameServer replicas

ShutdownReplicas is the number of Shutdown GameServers replicas

[Stage:Alpha] [FeatureFlag:PlayerTracking] Players is the current total player capacity and count for this GameServerSet

(Beta, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter count for this GameServerSet.

(Beta, CountsAndLists feature flag) Lists provides aggregated List capacity and List values for this GameServerSet.

Container specifies which Pod container is the game server. Only required if there is more than one container defined

Ports are the array of ports that can be exposed via the game server

Health configures health checking

Scheduling strategy. Defaults to “Packed”

SdkServer specifies parameters for the Agones SDK Server sidecar container

Template describes the Pod that will be created for the GameServer

(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features.

(Beta, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. Keys must be declared at GameServer creation time.

(Beta, CountsAndLists feature flag) Lists provides the configuration for tracking of lists of up to 1000 values against a GameServer. Keys must be declared at GameServer creation time.

Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”.

GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc

Addresses is the array of addresses at which the GameServer can be reached; copy of Node.Status.addresses.

[Stage:Alpha] [FeatureFlag:PlayerTracking]

(Beta, CountsAndLists feature flag) Counters and Lists provides the configuration for generic tracking features.

Eviction specifies the eviction tolerance of the GameServer.

Disabled is whether health checking is disabled or not

PeriodSeconds is the number of seconds each health ping has to occur in

FailureThreshold how many failures in a row constitutes unhealthy

InitialDelaySeconds initial delay before checking health

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: Sort by “Ascending” or “Descending”. “Descending” a bigger available capacity is preferred. “Ascending” would be smaller available capacity is preferred. The default sort order is “Ascending”

LogLevel for SDK server (sidecar) logs. Defaults to “Info”

GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections

HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections

Action must to either “Increment” or “Decrement” the Counter’s Count. Must also define the Amount.

Amount is the amount to increment or decrement the Count. Must be a positive integer.

Capacity is the amount to update the maximum capacity of the Counter to this number. Min 0, Max int64.

MinCount is the minimum current value. Defaults to 0.

MaxCount is the maximum current value. Defaults to 0, which translates as max(in64).

MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0.

MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which translates to max(int64).

MultiClusterPolicySelector if specified, multi-cluster policies are applied. Otherwise, allocation will happen locally.

Deprecated: use field Selectors instead. If Selectors is set, this field is ignored. Required is the GameServer selector from which to choose GameServers from. Defaults to all GameServers.

Deprecated: use field Selectors instead. If Selectors is set, this field is ignored. Preferred is an ordered list of preferred GameServer selectors that are optional to be fulfilled, but will be searched before the required selector. If the first selector is not matched, the selection attempts the second selector, and so on. If any of the preferred selectors are matched, the required selector is not considered. This is useful for things like smoke testing of new game servers.

[Stage: Beta] [FeatureFlag:CountsAndLists] Priorities configuration alters the order in which GameServers are searched for matches to the configured selectors.

Priority of sorting is in descending importance. I.e. The position 0 priority entry is checked first.

For Packed strategy sorting, this priority list will be the tie-breaker within the least utilised infrastructure, to ensure optimal infrastructure usage while also allowing some custom prioritisation of GameServers.

For Distributed strategy sorting, the entire selection of GameServers will be sorted by this priority list to provide the order that GameServers will be allocated by.

Ordered list of GameServer label selectors. If the first selector is not matched, the selection attempts the second selector, and so on. This is useful for things like smoke testing of new game servers. Note: This field can only be set if neither Required or Preferred is set.

Scheduling strategy. Defaults to “Packed”.

MetaPatch is optional custom metadata that is added to the game server at allocation You can use this to tell the server necessary session data

[Stage: Beta] [FeatureFlag:CountsAndLists] Counter actions to perform during allocation.

[Stage: Beta] [FeatureFlag:CountsAndLists] List actions to perform during allocation.

GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated

If the allocation is from a remote cluster, Source is the endpoint of the remote agones-allocator. Otherwise, Source is “local”

(Members of LabelSelector are embedded into this type.)

See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

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.

[Stage:Alpha] [FeatureFlag:PlayerAllocationFilter] Players provides a filter on minimum and maximum values for player capacity when retrieving a GameServer through Allocation. Defaults to no limits.

[Stage: Beta] [FeatureFlag:CountsAndLists] Counters provides filters on minimum and maximum values for a Counter’s count and available capacity when retrieving a GameServer through Allocation. Defaults to no limits.

[Stage: Beta] [FeatureFlag:CountsAndLists] Lists provides filters on minimum and maximum values for List capacity, and for the existence of a value in a List, when retrieving a GameServer through Allocation. Defaults to no limits.

AddValues appends values to a List’s Values array. Any duplicate values will be ignored.

Capacity updates the maximum capacity of the Counter to this number. Min 0, Max 1000.

ContainsValue says to only match GameServers who has this value in the list. Defaults to “”, which is all.

MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0.

MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which is translated as max(int64).

Timezone to be used for the startCron field. If not set, startCron is defaulted to the UTC timezone.

StartCron defines when the policy should be applied. If not set, the policy is always to be applied within the start and end time. This field must conform to UNIX cron syntax.

Duration is the length of time that the policy is applied. If not set, the duration is indefinite. A duration string is a possibly signed sequence of decimal numbers, (e.g. “300ms”, “-1.5h” or “2h45m”). The representation limits the largest representable duration to approximately 290 years. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

Start is the datetime that the policy is eligible to be applied. This field must conform to RFC3339 format. If this field not set or is in the past, the policy is eligible to be applied as soon as the fleet autoscaler is running.

End is the datetime that the policy is no longer eligible to be applied. This field must conform to RFC3339 format. If not set, the policy is always eligible to be applied, after the start time above.

MaxReplicas is the maximum amount of replicas that the fleet may have. It must be bigger than both MinReplicas and BufferSize

MinReplicas is the minimum amount of replicas that the fleet must have If zero, it is ignored. If non zero, it must be smaller than MaxReplicas and bigger than BufferSize

BufferSize defines how many replicas the autoscaler tries to have ready all the time Value can be an absolute number (ex: 5) or a percentage of desired gs instances (ex: 15%) Absolute number is calculated from percentage by rounding up. Example: when this is set to 20%, the autoscaler will make sure that 20% of the fleet’s game server replicas are ready. When this is set to 20, the autoscaler will make sure that there are 20 available game servers Must be bigger than 0 Note: by “ready” we understand in this case “non-allocated”; this is done to ensure robustness and computation stability in different edge case (fleet just created, not enough capacity in the cluster etc)

ID is the unique identifier for a ChainEntry. If not set the identifier will be set to the index of chain entry.

(Members of FleetAutoscalerPolicy are embedded into this type.)

Policy is the name of the policy to be applied. Required field.

Key is the name of the Counter. Required field.

MaxCapacity is the maximum aggregate Counter total capacity across the fleet. MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field.

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.

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%). An absolute number is calculated from percentage by rounding up. Must be bigger than 0. Required field.

Seconds defines how often we run fleet autoscaling in seconds

UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are otherwise identical (parallel requests, requests when earlier requests did not modify etc) The UID is meant to track the round trip (request/response) between the Autoscaler and the WebHook, not the user request. It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.

Name is the name of the Fleet being scaled

Namespace is the namespace associated with the request (if any).

The Fleet’s status values

UID is an identifier for the individual request/response. This should be copied over from the corresponding FleetAutoscaleRequest.

Set to false if no scaling should occur to the Fleet

The targeted replica count

Type of autoscaling policy.

Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer.

Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook.

[Stage:Beta] [FeatureFlag:CountsAndLists] Counter policy config params. Present only if FleetAutoscalerPolicyType = Counter.

[Stage:Beta] [FeatureFlag:CountsAndLists] List policy config params. Present only if FleetAutoscalerPolicyType = List.

[Stage:Dev] [FeatureFlag:ScheduledAutoscaler] Schedule policy config params. Present only if FleetAutoscalerPolicyType = Schedule.

[Stage:Dev] [FeatureFlag:ScheduledAutoscaler] Chain policy config params. Present only if FleetAutoscalerPolicyType = Chain.

Autoscaling policy

Sync defines when FleetAutoscalers runs autoscaling

CurrentReplicas is the current number of gameserver replicas of the fleet managed by this autoscaler, as last seen by the autoscaler

DesiredReplicas is the desired number of gameserver replicas of the fleet managed by this autoscaler, as last calculated by the autoscaler

lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet,

AbleToScale indicates that we can access the target fleet

ScalingLimited indicates that the calculated scale would be above or below the range defined by MinReplicas and MaxReplicas, and has thus been capped.

Type of autoscaling sync.

FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval.

Key is the name of the List. Required field.

MaxCapacity is the maximum aggregate List total capacity across the fleet. MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field.

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.

BufferSize is the size of a buffer based on the List capacity that is available over the current aggregate List length in the Fleet (available capacity). It can be specified either as an absolute value (i.e. 5) or percentage format (i.e. 5%). Must be bigger than 0. Required field.

Between defines the time period that the policy is eligible to be applied.

ActivePeriod defines the time period that the policy is applied.

Policy is the name of the policy to be applied. Required field.

url gives the location of the webhook, in standard URL form (scheme://host:port/path). Exactly one of url or service must be specified.

The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address.

Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.

The scheme must be “https”; the URL must begin with “https://”.

A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.

Attempting to use a user or basic auth e.g. “user:password@” is not allowed. Fragments (“#…”) and query parameters (“?…”) are not allowed, either.

service is a reference to the service for this webhook. Either service or url must be specified.

If the webhook is running within the cluster, then you should use service.

caBundle is a PEM encoded CA bundle which will be used to validate the webhook’s server certificate. If unspecified, system trust roots on the apiserver are used.

Optional: the name of the targeted cluster

The endpoints for the allocator service in the targeted cluster. If the AllocationEndpoints is not set, the allocation happens on local cluster. If there are multiple endpoints any of the endpoints that can handle allocation request should suffice

The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster

The cluster namespace from which to allocate gameservers

The PEM encoded server CA, used by the allocator client to authenticate the remote server.

currPriority Current priority index from the orderedPriorities

orderedPriorities list of ordered priorities

priorityToCluster Map of priority to cluster-policies map

clusterBlackList the cluster blacklist for the clusters that has already returned