Packages:
Package v1 is the v1 version of the API.
Resource Types: --
Fleet is the data structure for a Fleet resource
+GameServerAllocation is the data structure for allocating against a set of
+GameServers, defined selectors selectors
-agones.dev/v1
+allocation.agones.dev/v1
|
@@ -59,7 +56,7 @@ Fleet |
+GameServerAllocation |
||||||||||||||||
@@ -79,8 +76,8 @@ Fleet
spec
-
-FleetSpec
+
+GameServerAllocationSpec
|
-replicas
+multiClusterSetting
-int32
+
+MultiClusterSetting
+
|
- Replicas are the number of GameServers that should be in this set. Defaults to 0. +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-allocationOverflow
+required
-
-AllocationOverflow
+
+GameServerSelector
+
+
+ |
+
+ 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. + |
+
+preferred
+
+
+[]GameServerSelector
+
+
+ |
+
+ 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 |
+
+priorities
+
+
+[]Priority
|
(Optional)
- [Stage: Alpha]
-[FeatureFlag:FleetAllocationOverflow]
-Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more
-than the desired replicas on the underlying (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The allocator will use the first priority for sorting GameServers by +available Capacity in the Selector set. Acts as a tie-breaker after sorting the game servers +by State and Strategy Packed. Impacts which GameServer is checked first. |
-strategy
+selectors
-
-Kubernetes apps/v1.DeploymentStrategy
+
+[]GameServerSelector
|
- Deployment strategy +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. |
-priorities
+metadata
-
-[]Priority
+
+MetaPatch
+
+
+ |
+
+ 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 + |
+
+counters
+
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterAction
|
(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers -by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by -State and Strategy. Impacts scale down logic. +(Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. |
-template
+lists
-
-GameServerTemplateSpec
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
|
- Template the GameServer template to apply for this Fleet +(Optional) +(Alpha, CountsAndLists feature flag) List actions to perform during allocation. |
status
-
-FleetStatus
+
+GameServerAllocationStatus
-
GameServer is the data structure for a GameServer resource.
-It is worth noting that while there is a GameServerStatus Status entry for the GameServer, it is not
-defined as a subresource - unlike Fleet and other Agones resources.
-This is so that we can retain the ability to change multiple aspects of a GameServer in a single atomic operation,
-which is particularly useful for operations such as allocation.
+
CounterAction is an optional action that can be performed on a Counter at allocation.
-apiVersion
-string |
-
-
-agones.dev/v1
-
- |
-||||||||||||||||||||||
-kind
-string
- |
-GameServer |
-||||||||||||||||||||||
-metadata
+action
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+(Optional)
+Action must to either “Increment” or “Decrement” the Counter’s Count. Must also define the Amount. |
||||||||||||||||||||||
-spec
-
-
-GameServerSpec
-
-
- |
-
- - -
CounterSelector +++(Appears on: +GameServerSelector) + ++ CounterSelector is the filter options for a GameServer based on the count and/or available capacity. + +
|
-||||||||||||||||||||||
-status
-
-
-GameServerStatus
-
+int64
|
+(Optional)
+ MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which translates to max(int64). |
-
GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Deployments and ReplicaSets
+(Appears on: +GameServerAllocation) + ++
GameServerAllocationSpec is the spec for a GameServerAllocation
-apiVersion
-string |
-
-
-agones.dev/v1
-
+multiClusterSetting
+
+
+MultiClusterSetting
+
+
|
-||||||||
-kind
-string
+MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-GameServerSet |
||||||||
-metadata
+required
-
-Kubernetes meta/v1.ObjectMeta
+
+GameServerSelector
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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. |
||||||||
-spec
+preferred
-
-GameServerSetSpec
+
+[]GameServerSelector
|
- - -
(Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. |
||||||||
-status
+lists
-
-GameServerSetStatus
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
|
+(Optional)
+ (Alpha, CountsAndLists feature flag) List actions to perform during allocation. |
string alias)+(Appears on: +GameServerAllocationStatus) +
++
GameServerAllocationState is the Allocation state
+ +(Appears on: -FleetStatus, -GameServerSetStatus) +GameServerAllocation)
-
AggregatedCounterStatus stores total and allocated Counter tracking values
+GameServerAllocationStatus is the status for an GameServerAllocation resource
-allocatedCount
+state
-int64
+
+GameServerAllocationState
+
|
+ GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated |
-allocatedCapacity
+gameServerName
-int64
+string
|
@@ -579,9 +560,11 @@ AggregatedCounterStatus |
-count
+ports
-int64
+
+[]GameServerStatusPort
+
|
@@ -589,39 +572,21 @@ AggregatedCounterStatus |
-capacity
+address
-int64
+string
|
-(Appears on: -FleetStatus, -GameServerSetStatus) -
--
AggregatedListStatus stores total and allocated List tracking values
- -| Field | -Description | -
|---|---|
-allocatedCount
+addresses
-int64
+
+[]Kubernetes core/v1.NodeAddress
+
|
@@ -629,9 +594,9 @@ AggregatedListStatus |
-allocatedCapacity
+nodeName
-int64
+string
|
@@ -639,19 +604,23 @@ AggregatedListStatus |
-count
+source
-int64
+string
|
+ If the allocation is from a remote cluster, Source is the endpoint of the remote agones-allocator. +Otherwise, Source is “local” |
-capacity
+metadata
-int64
+
+GameServerMetadata
+
|
@@ -659,15 +628,14 @@ AggregatedListStatus |
(Appears on: -FleetStatus, -GameServerSetStatus) +GameServerAllocationStatus)
-
AggregatedPlayerStatus stores total player tracking values
+GameServerMetadata is the metadata from the allocated game server at allocation time
-count
+labels
-int64
+map[string]string
|
@@ -689,9 +657,9 @@ AggregatedPlayerStatus |
-capacity
+annotations
-int64
+map[string]string
|
@@ -699,17 +667,15 @@ AggregatedPlayerStatus |
(Appears on: -FleetSpec, -GameServerSetSpec) +GameServerAllocationSpec)
-
AllocationOverflow specifies what labels and/or annotations to apply on Allocated GameServers
-if the desired number of the underlying GameServerSet drops below the number of Allocated GameServers
-attached to it.
GameServerSelector contains all the filter options for selecting +a GameServer for allocation.
-labels
+LabelSelector
-map[string]string
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+
+(Members of See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + |
+
+gameServerState
+
+
+GameServerState
+
+
+ |
+
+ 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. + |
+
+players
+
+
+PlayerSelector
+
|
(Optional)
- Labels to be applied to the [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. |
-annotations
+counters
-map[string]string
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterSelector
+
|
(Optional)
- Annotations to be applied to the (Alpha, CountsAndLists feature flag) 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. + |
+
+lists
+
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.ListSelector
+
+
+ |
+
+(Optional)
+ (Alpha, CountsAndLists feature flag) 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. |
(Appears on: -GameServerSpec, -GameServerStatus) +GameServerAllocationSpec)
-
CounterStatus stores the current counter values
+ListAction is an optional action that can be performed on a List at allocation.
-count
+addValues
-int64
+[]string
|
+(Optional)
+ AddValues appends values to a List’s Values array. Any duplicate values will be ignored. |
|
+(Optional)
+ Capacity updates the maximum capacity of the Counter to this number. Min 0, Max 1000. |
(Appears on: -GameServerSpec, -GameServerStatus) +GameServerSelector)
-
Eviction specifies the eviction tolerance of the GameServer
+ListSelector is the filter options for a GameServer based on List available capacity and/or the +existence of a value in a List.
-safe
+containsValue
-
-EvictionSafe
-
+string
|
- 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 +(Optional) +ContainsValue says to only match GameServers who has this value in the list. Defaults to “”, which is all. + |
+
+minAvailable
+
+int64
+
+ |
+
+(Optional)
+ MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0. + |
+
+maxAvailable
+
+int64
+
+ |
+
+(Optional)
+ MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which is translated as max(int64). |
string alias)-(Appears on: -Eviction) -
--
EvictionSafe specified whether the game server supports termination via SIGTERM
- -(Appears on: -Fleet) +GameServerAllocationSpec)
-
FleetSpec is the spec for a Fleet
+MetaPatch is the metadata used to patch the GameServer metadata on allocation
-replicas
-
-int32
-
- |
-
- Replicas are the number of GameServers that should be in this set. Defaults to 0. - |
-
-allocationOverflow
+labels
-
-AllocationOverflow
-
+map[string]string
|
-(Optional)
- [Stage: Alpha]
-[FeatureFlag:FleetAllocationOverflow]
-Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more
-than the desired replicas on the underlying |
-strategy
+annotations
-
-Kubernetes apps/v1.DeploymentStrategy
-
+map[string]string
|
- Deployment strategy |
+(Appears on: +GameServerAllocationSpec) +
++
MultiClusterSetting specifies settings for multi-cluster allocation.
+ +
-scheduling
-
-agones.dev/agones/pkg/apis.SchedulingStrategy
-
- |
-
- Scheduling strategy. Defaults to “Packed”. - |
+Field | +Description |
|---|---|---|---|
-priorities
+enabled
-
-[]Priority
-
+bool
|
-(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers -by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by -State and Strategy. Impacts scale down logic. |
||
-template
+policySelector
-
-GameServerTemplateSpec
+
+Kubernetes meta/v1.LabelSelector
|
- Template the GameServer template to apply for this Fleet |
(Appears on: -Fleet, -FleetAutoscaleRequest) +GameServerSelector)
-
FleetStatus is the status of a Fleet
+PlayerSelector is the filter options for a GameServer based on player counts
-replicas
+minAvailable
-int32
+int64
|
- Replicas the total number of current GameServer replicas |
-readyReplicas
+maxAvailable
-int32
+int64
|
- ReadyReplicas are the number of Ready GameServer replicas |
+
Package v1 is the v1 version of the API.
+ +Resource Types: + ++
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
-reservedReplicas
+apiVersion
+string |
+
+
+autoscaling.agones.dev/v1
+
+ |
+||||||
+kind
+string
+ |
+FleetAutoscaler |
+||||||
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
- 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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-allocatedReplicas
+spec
-int32
+
+FleetAutoscalerSpec
+
+
+ |
+
+ + +
|
||||||
-lists
+status
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
+
+FleetAutoscalerStatus
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Lists provides aggregated List capacityv and List values -for this Fleet. |
(Appears on: -GameServerSpec) +FleetAutoscalerPolicy)
-
GameServerPort defines a set of Ports that -are to be exposed via the GameServer
+BufferPolicy controls the desired behavior of the buffer policy.
-name
-
-string
-
- |
-
- Name is the descriptive name of the port - |
-
-portPolicy
-
-
-PortPolicy
-
-
- |
-
- 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 |
-
-container
-
-string
-
- |
-
-(Optional)
- Container is the name of the container on which to open the port. Defaults to the game server container. - |
-
-containerPort
+maxReplicas
int32
|
- ContainerPort is the port that is being opened on the specified container’s process +MaxReplicas is the maximum amount of replicas that the fleet may have. +It must be bigger than both MinReplicas and BufferSize |
-hostPort
+minReplicas
int32
|
- HostPort the port exposed on the host for clients to connect to +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 |
-protocol
+bufferSize
-
-Kubernetes core/v1.Protocol
-
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
- Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. +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) |
(Appears on: -GameServerSet) +FleetAutoscalerPolicy)
-
GameServerSetSpec the specification for GameServerSet
+CounterPolicy controls the desired behavior of the Counter autoscaler policy.
-replicas
-
-int32
-
- |
-
- Replicas are the number of GameServers that should be in this set - |
-
-allocationOverflow
+key
-
-AllocationOverflow
-
+string
|
-(Optional)
- [Stage: Alpha]
-[FeatureFlag:FleetAllocationOverflow]
-Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
-the desired replicas on the underlying Key is the name of the Counter. Required field. |
-scheduling
+maxCapacity
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int64
|
- Scheduling strategy. Defaults to “Packed”. +MaxCapacity is the maximum aggregate Counter total capacity across the fleet. +MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. |
-priorities
+minCapacity
-
-[]Priority
-
+int64
|
-(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers -by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by -State and Strategy. Impacts scale down logic. +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. |
-template
+bufferSize
-
-GameServerTemplateSpec
-
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
- Template the GameServer template to apply for this GameServerSet +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. |
(Appears on: -GameServerSet) +FleetAutoscalerSync)
-
GameServerSetStatus is the status of a GameServerSet
+FixedIntervalSync controls the desired behavior of the fixed interval based sync.
-replicas
+seconds
int32
|
- Replicas is the total number of current GameServer replicas - |
-
-readyReplicas
-
-int32
-
- |
-
- ReadyReplicas is the number of Ready GameServer replicas - |
-
-reservedReplicas
-
-int32
-
- |
-
- ReservedReplicas is the number of Reserved GameServer replicas +Seconds defines how often we run fleet autoscaling in seconds |
+(Appears on: +FleetAutoscaleReview) +
++
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+ +
-allocatedReplicas
-
-int32
-
- |
-
- AllocatedReplicas is the number of Allocated GameServer replicas - |
+Field | +Description |
|---|---|---|---|
-shutdownReplicas
+uid
-int32
+k8s.io/apimachinery/pkg/types.UID
|
- ShutdownReplicas is the number of Shutdown GameServers replicas +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. |
||
-players
+name
-
-AggregatedPlayerStatus
-
+string
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players is the current total player capacity and count for this GameServerSet +Name is the name of the Fleet being scaled |
||
-counters
+namespace
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
-
+string
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter -count for this GameServerSet. +Namespace is the namespace associated with the request (if any). |
||
-lists
+status
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
+
+FleetStatus
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Lists provides aggregated List capacity and List values -for this GameServerSet. +The Fleet’s status values |
(Appears on: -GameServer, -GameServerTemplateSpec) +FleetAutoscaleReview)
-
GameServerSpec is the spec for a GameServer resource
+FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
-container
+uid
-string
+k8s.io/apimachinery/pkg/types.UID
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined +UID is an identifier for the individual request/response. +This should be copied over from the corresponding FleetAutoscaleRequest. |
-ports
+scale
-
-[]GameServerPort
-
+bool
|
- Ports are the array of ports that can be exposed via the game server +Set to false if no scaling should occur to the Fleet |
-health
+replicas
-
-Health
-
+int32
|
- Health configures health checking +The targeted replica count |
+
FleetAutoscaleReview is passed to the webhook with a populated Request value, +and then returned with a populated Response.
+ +| Field | +Description | +
|---|---|
-scheduling
+request
-agones.dev/agones/pkg/apis.SchedulingStrategy
+
+FleetAutoscaleRequest
+
|
- Scheduling strategy. Defaults to “Packed” |
-sdkServer
+response
-
-SdkServer
+
+FleetAutoscaleResponse
|
- SdkServer specifies parameters for the Agones SDK Server sidecar container |
+(Appears on: +FleetAutoscalerSpec) +
++
FleetAutoscalerPolicy describes how to scale a fleet
+ +| Field | +Description | +
|---|---|
-template
+type
-
-Kubernetes core/v1.PodTemplateSpec
+
+FleetAutoscalerPolicyType
|
- Template describes the Pod that will be created for the GameServer +Type of autoscaling policy. |
-players
+buffer
-
-PlayersSpec
+
+BufferPolicy
|
(Optional)
- (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. +Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. |
-counters
+webhook
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
+WebhookPolicy
|
(Optional)
- (Alpha, CountsAndLists feature flag) Counters and Lists provides the configuration for generic tracking features. +Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. |
-lists
+counter
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
+
+CounterPolicy
|
+(Optional)
+ [Stage:Alpha] +[FeatureFlag:CountsAndLists] +Counter policy config params. Present only if FleetAutoscalerPolicyType = Counter. |
-eviction
+list
-
-Eviction
+
+ListPolicy
|
(Optional)
- Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. +[Stage:Alpha] +[FeatureFlag:CountsAndLists] +List policy config params. Present only if FleetAutoscalerPolicyType = List. |
string alias)(Appears on: -GameServerSelector, -GameServerStatus) +FleetAutoscalerPolicy)
-
GameServerState is the state for the GameServer
+FleetAutoscalerPolicyType is the policy for autoscaling +for a given Fleet
-(Appears on: -GameServer) +FleetAutoscaler)
-
GameServerStatus is the status for a GameServer resource
+FleetAutoscalerSpec is the spec for a Fleet Scaler
-state
+fleetName
-
-GameServerState
-
+string
|
- GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-ports
+policy
-
-[]GameServerStatusPort
+
+FleetAutoscalerPolicy
|
+ Autoscaling policy |
-address
-
-string
-
- |
-- | -
-addresses
+sync
-
-[]Kubernetes core/v1.NodeAddress
+
+FleetAutoscalerSync
|
(Optional)
- Addresses is the array of addresses at which the GameServer can be reached; copy of Node.Status.addresses. +Sync defines when FleetAutoscalers runs autoscaling |
-nodeName
-
-string
-
- |
-- | +
+(Appears on: +FleetAutoscaler) +
++
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+ +| Field | +Description |
|---|---|
-reservedUntil
+currentReplicas
-
-Kubernetes meta/v1.Time
-
+int32
|
+ CurrentReplicas is the current number of gameserver replicas +of the fleet managed by this autoscaler, as last seen by the autoscaler |
-players
+desiredReplicas
-
-PlayerStatus
-
+int32
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] +DesiredReplicas is the desired number of gameserver replicas +of the fleet managed by this autoscaler, as last calculated by the autoscaler |
-counters
+lastScaleTime
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
+Kubernetes meta/v1.Time
|
(Optional)
- (Alpha, CountsAndLists feature flag) Counters and Lists provides the configuration for generic tracking features. +lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, |
-lists
+ableToScale
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
-
+bool
|
-(Optional)
+ AbleToScale indicates that we can access the target fleet |
-eviction
+scalingLimited
-
-Eviction
-
+bool
|
-(Optional)
- Eviction specifies the eviction tolerance of the GameServer. +ScalingLimited indicates that the calculated scale would be above or below the range +defined by MinReplicas and MaxReplicas, and has thus been capped. |
(Appears on: -GameServerAllocationStatus, -GameServerStatus) +FleetAutoscalerSpec)
-
GameServerStatusPort shows the port that was allocated to a -GameServer.
+FleetAutoscalerSync describes when to sync a fleet
-name
+type
-string
+
+FleetAutoscalerSyncType
+
|
+ Type of autoscaling sync. |
-port
+fixedInterval
-int32
+
+FixedIntervalSync
+
|
+(Optional)
+ FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval. |
string alias)+(Appears on: +FleetAutoscalerSync) +
++
FleetAutoscalerSyncType is the sync strategy for a given Fleet
+ +(Appears on: -FleetSpec, -GameServerSetSpec) +FleetAutoscalerPolicy)
-
GameServerTemplateSpec is a template for GameServers
+ListPolicy controls the desired behavior of the List autoscaler policy.
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||||||||||||
-spec
-
-
-GameServerSpec
-
-
- |
-
- - -
WebhookPolicy +++(Appears on: +FleetAutoscalerPolicy) + ++ WebhookPolicy controls the desired behavior of the webhook policy. +It contains the description of the webhook autoscaler service +used to form url which is accessible inside the cluster + +
|
-(Appears on: -GameServerSpec) +
Package v1 is the v1 version of the API.
+Resource Types: + +-
Health configures health checking on the GameServer
+GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
-disabled
+apiVersion
+string |
+
+
+multicluster.agones.dev/v1
+
+ |
+||||||
+kind
+string
+ |
+GameServerAllocationPolicy |
+||||||
+metadata
-bool
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Disabled is whether health checking is disabled or not +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-periodSeconds
+spec
+
+
+GameServerAllocationPolicySpec
+
+
+ |
+
+ + +
|
(Appears on: -GameServerSpec, -GameServerStatus) +GameServerAllocationPolicySpec)
-
ListStatus stores the current list values
+ClusterConnectionInfo defines the connection information for a cluster
-capacity
+clusterName
-int64
+string
|
+ Optional: the name of the targeted cluster |
-values
+allocationEndpoints
[]string
|
+ 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 |
-(Appears on: -GameServerStatus) -
--
PlayerStatus stores the current player capacity values
- -| Field | -Description | -
|---|---|
-count
+secretName
-int64
+string
|
+ The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster |
-capacity
+namespace
-int64
+string
|
+ The cluster namespace from which to allocate gameservers |
-ids
+serverCa
-[]string
+[]byte
|
+ The PEM encoded server CA, used by the allocator client to authenticate the remote server. |
-(Appears on: -GameServerSpec) -
--
PlayersSpec tracks the initial player capacity
+ConnectionInfoIterator an iterator on ClusterConnectionInfo
-initialCapacity
+currPriority
-int64
+int
|
+ currPriority Current priority index from the orderedPriorities |
string alias)-(Appears on: -GameServerPort) -
--
PortPolicy is the port policy for the GameServer
- --(Appears on: -FleetSpec, -GameServerAllocationSpec, -GameServerSetSpec) -
--
Priority is a sorting option for GameServers with Counters or Lists based on the Capacity. -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 Capacity is preferred. -“Ascending” would be smaller Capacity is preferred.
- -| Field | -Description | -
|---|---|
-type
+orderedPriorities
-string
+[]int32
|
+ orderedPriorities list of ordered priorities |
-key
+priorityToCluster
-string
+map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
|
+ priorityToCluster Map of priority to cluster-policies map |
-order
+clusterBlackList
-string
+map[string]bool
|
+ clusterBlackList the cluster blacklist for the clusters that has already returned |
(Appears on: -GameServerSpec) +GameServerAllocationPolicy)
-
SdkServer specifies parameters for the Agones SDK Server sidecar container
+GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
-logLevel
+priority
-
-SdkServerLogLevel
-
+int32
|
- LogLevel for SDK server (sidecar) logs. Defaults to “Info” |
-grpcPort
+weight
-int32
+int
|
- GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections |
-httpPort
+connectionInfo
-int32
+
+ClusterConnectionInfo
+
|
- HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections |
string alias)-(Appears on: -SdkServer) -
--
SdkServerLogLevel is the log level for SDK server (sidecar) logs
-
Package v1 is the v1 version of the API.
Resource Types: --
GameServerAllocation is the data structure for allocating against a set of
-GameServers, defined selectors selectors
Fleet is the data structure for a Fleet resource
-allocation.agones.dev/v1
+agones.dev/v1
|
@@ -2216,7 +2202,7 @@ GameServerAllocation |
+Fleet |
||||||||||||||||
@@ -2236,8 +2222,8 @@ GameServerAllocation
spec
-
-GameServerAllocationSpec
+
+FleetSpec
|
-multiClusterSetting
+replicas
-
-MultiClusterSetting
-
-
- |
-
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. - |
-
-required
-
-
-GameServerSelector
-
-
- |
-
- 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. - |
-
-preferred
-
-
-[]GameServerSelector
-
+int32
|
- 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 Replicas are the number of GameServers that should be in this set. Defaults to 0. |
-priorities
+allocationOverflow
-
-[]Priority
+
+AllocationOverflow
|
(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The allocator will use the first priority for sorting GameServers by -available Capacity in the Selector set. Acts as a tie-breaker after sorting the game servers -by State and Strategy Packed. Impacts which GameServer is checked first. +[Stage: Beta]
+[FeatureFlag:FleetAllocationOverflow]
+Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more
+than the desired replicas on the underlying |
-selectors
+strategy
-
-[]GameServerSelector
+
+Kubernetes apps/v1.DeploymentStrategy
|
- 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. +Deployment strategy |
-metadata
-
-
-MetaPatch
-
-
- |
-
- 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 - |
-
-counters
+priorities
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterAction
+
+[]Priority
|
(Optional)
- (Alpha, CountsAndLists feature flag) Counters and Lists provide a set of actions to perform -on Counters and Lists during allocation. +(Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
-lists
+template
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
+
+GameServerTemplateSpec
|
+ Template the GameServer template to apply for this Fleet |
status
-
-GameServerAllocationStatus
+
+FleetStatus
-(Appears on: -GameServerAllocationSpec) -
--
CounterAction is an optional action that can be performed on a Counter at allocation. -Action: “Increment” or “Decrement” the Counter’s Count (optional). Must also define the Amount. -Amount: The amount to increment or decrement the Count (optional). Must be a positive integer. -Capacity: Update the maximum capacity of the Counter to this number (optional). Min 0, Max int64.
+GameServer is the data structure for a GameServer resource.
+It is worth noting that while there is a GameServerStatus Status entry for the GameServer, it is not
+defined as a subresource - unlike Fleet and other Agones resources.
+This is so that we can retain the ability to change multiple aspects of a GameServer in a single atomic operation,
+which is particularly useful for operations such as allocation.
-action
-
-string
-
+apiVersion
+string |
+
+
+agones.dev/v1
+
|
+
+kind
+string
|
+GameServer |
-amount
+metadata
-int64
+
+Kubernetes meta/v1.ObjectMeta
+
|
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
-capacity
+spec
-int64
+
+GameServerSpec
+
|
- | -
-(Appears on: -GameServerSelector) -
--
CounterSelector is the filter options for a GameServer based on the count and/or available capacity. -0 for MaxCount or MaxAvailable means unlimited maximum. Default for all fields: 0
- +| Field | -Description | -
|---|---|
-minCount
+container
-int64
+string
|
+ Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-maxCount
+ports
-int64
+
+[]GameServerPort
+
|
+ Ports are the array of ports that can be exposed via the game server |
-minAvailable
+health
-int64
+
+Health
+
|
+ Health configures health checking |
-maxAvailable
+scheduling
-int64
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed” |
-(Appears on: -GameServerAllocation) -
--
GameServerAllocationSpec is the spec for a GameServerAllocation
- -| Field | -Description | -
|---|---|
-multiClusterSetting
+sdkServer
-
-MultiClusterSetting
+
+SdkServer
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +SdkServer specifies parameters for the Agones SDK Server sidecar container |
-required
+template
-
-GameServerSelector
+
+Kubernetes core/v1.PodTemplateSpec
|
- 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. +Template describes the Pod that will be created for the GameServer |
-preferred
+players
-
-[]GameServerSelector
+
+PlayersSpec
|
- 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 (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
-priorities
+counters
-
-[]Priority
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
|
(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The allocator will use the first priority for sorting GameServers by -available Capacity in the Selector set. Acts as a tie-breaker after sorting the game servers -by State and Strategy Packed. Impacts which GameServer is checked first. +(Alpha, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. +Keys must be declared at GameServer creation time. |
-selectors
+lists
-
-[]GameServerSelector
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
|
- 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
-
-agones.dev/agones/pkg/apis.SchedulingStrategy
-
- |
-
- Scheduling strategy. Defaults to “Packed”. +(Optional) +(Alpha, 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. |
-metadata
+eviction
-
-MetaPatch
+
+Eviction
|
- 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 +(Optional) +Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. |
-counters
-
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterAction
-
-
- |
-
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters and Lists provide a set of actions to perform -on Counters and Lists during allocation. + |
lists
+status
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
+
+GameServerStatus
string alias)-(Appears on: -GameServerAllocationStatus) -
--
GameServerAllocationState is the Allocation state
- --(Appears on: -GameServerAllocation) -
--
GameServerAllocationStatus is the status for an GameServerAllocation resource
+GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Deployments and ReplicaSets
-state
-
-
-GameServerAllocationState
-
-
- |
+
- GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated +
+agones.dev/v1
+
|
|
-gameServerName
-
+kind
string
-
- |
-+ | GameServerSet |
-ports
+metadata
-
-[]GameServerStatusPort
+
+Kubernetes meta/v1.ObjectMeta
|
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
|
-address
+spec
-string
+
+GameServerSetSpec
+
|
- | -
-addresses
+replicas
-
-[]Kubernetes core/v1.NodeAddress
-
+int32
|
+ Replicas are the number of GameServers that should be in this set |
-nodeName
+allocationOverflow
-string
+
+AllocationOverflow
+
|
+(Optional)
+ [Stage: Beta]
+[FeatureFlag:FleetAllocationOverflow]
+Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
+the desired replicas on the underlying |
-source
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- If the allocation is from a remote cluster, Source is the endpoint of the remote agones-allocator. -Otherwise, Source is “local” +Scheduling strategy. Defaults to “Packed”. |
-metadata
+priorities
-
-GameServerMetadata
+
+[]Priority
|
+(Optional)
+ (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
-(Appears on: -GameServerAllocationStatus) -
--
GameServerMetadata is the metadata from the allocated game server at allocation time
- -| Field | -Description | -
|---|---|
-labels
+template
-map[string]string
+
+GameServerTemplateSpec
+
|
+ Template the GameServer template to apply for this GameServerSet + |
+
annotations
+status
-map[string]string
+
+GameServerSetStatus
+
(Appears on: -GameServerAllocationSpec) +FleetStatus, +GameServerSetStatus)
-
GameServerSelector contains all the filter options for selecting -a GameServer for allocation.
+AggregatedCounterStatus stores total and allocated Counter tracking values
-LabelSelector
-
-
-Kubernetes meta/v1.LabelSelector
-
-
- |
-
-
-(Members of See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ - |
-
-gameServerState
+allocatedCount
-
-GameServerState
-
+int64
|
- 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. |
-players
+allocatedCapacity
-
-PlayerSelector
-
+int64
|
-(Optional)
- [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. |
-counters
+count
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterSelector
-
+int64
|
-(Optional)
- (Alpha, CountsAndLists feature flag) 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. |
-lists
+capacity
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.ListSelector
-
+int64
|
-(Optional)
- (Alpha, CountsAndLists feature flag) 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. |
(Appears on: -GameServerAllocationSpec) +FleetStatus, +GameServerSetStatus)
-
ListAction is an optional action that can be performed on a List at allocation. -AddValues: Append values to a List’s Values array (optional). Any duplicate values will be ignored. -Capacity: Update the maximum capacity of the Counter to this number (optional). Min 0, Max 1000.
+AggregatedListStatus stores total and allocated List tracking values
-addValues
+allocatedCount
-[]string
+int64
|
@@ -2946,7 +2776,7 @@ ListAction |
-capacity
+allocatedCapacity
int64
@@ -2954,41 +2784,9 @@ ListAction
|
-(Appears on: -GameServerSelector) -
--
ListSelector is the filter options for a GameServer based on List available capacity and/or the -existence of a value in a List. -0 for MaxAvailable means unlimited maximum. Default for integer fields: 0 -“” for ContainsValue means ignore field. Default for string field: “”
- -| Field | -Description | -
|---|---|
-containsValue
-
-string
-
- |
-- | -
-minAvailable
+count
int64
@@ -2998,7 +2796,7 @@ ListSelector | |
-maxAvailable
+capacity
int64
@@ -3008,14 +2806,15 @@ ListSelector |
(Appears on: -GameServerAllocationSpec) +FleetStatus, +GameServerSetStatus)
-
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+AggregatedPlayerStatus stores total player tracking values
-labels
+count
-map[string]string
+int64
|
@@ -3037,9 +2836,9 @@ MetaPatch |
-annotations
+capacity
-map[string]string
+int64
|
@@ -3047,14 +2846,17 @@ MetaPatch |
(Appears on: -GameServerAllocationSpec) +FleetSpec, +GameServerSetSpec)
-
MultiClusterSetting specifies settings for multi-cluster allocation.
+AllocationOverflow specifies what labels and/or annotations to apply on Allocated GameServers
+if the desired number of the underlying GameServerSet drops below the number of Allocated GameServers
+attached to it.
-enabled
+labels
-bool
+map[string]string
|
+(Optional)
+ Labels to be applied to the |
-policySelector
+annotations
-
-Kubernetes meta/v1.LabelSelector
-
+map[string]string
|
+(Optional)
+ Annotations to be applied to the |
(Appears on: -GameServerSelector) +GameServerSpec, +GameServerStatus)
-
PlayerSelector is the filter options for a GameServer based on player counts
+CounterStatus stores the current counter values and maximum capacity
-minAvailable
+count
int64
@@ -3117,7 +2922,7 @@ PlayerSelector |
-maxAvailable
+capacity
int64
@@ -3127,19 +2932,15 @@ PlayerSelector |
-
Package v1 is the v1 version of the API.
+(Appears on: +GameServerSpec, +GameServerStatus) -Resource Types: - --
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+Eviction specifies the eviction tolerance of the GameServer
-apiVersion
-string |
+
-
-autoscaling.agones.dev/v1
-
+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 |
string alias)+(Appears on: +Eviction) +
++
EvictionSafe specified whether the game server supports termination via SIGTERM
+ ++(Appears on: +Fleet) +
++
FleetSpec is the spec for a Fleet
+ +
-kind
-string
- |
-FleetAutoscaler |
+Field | +Description | ||||
|---|---|---|---|---|---|---|---|
-metadata
+replicas
-
-Kubernetes meta/v1.ObjectMeta
-
+int32
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Replicas are the number of GameServers that should be in this set. Defaults to 0. |
||||||
-spec
+allocationOverflow
-
-FleetAutoscalerSpec
+
+AllocationOverflow
|
- - -
(Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
||||||
-status
+template
-
-FleetAutoscalerStatus
+
+GameServerTemplateSpec
|
+ Template the GameServer template to apply for this Fleet |
(Appears on: -FleetAutoscalerPolicy) +Fleet, +FleetAutoscaleRequest)
-
BufferPolicy controls the desired behavior of the buffer policy.
+FleetStatus is the status of a Fleet
-maxReplicas
+replicas
int32
|
- MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize +Replicas the total number of current GameServer replicas |
-minReplicas
+readyReplicas
int32
|
- 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 +ReadyReplicas are the number of Ready GameServer replicas |
-bufferSize
+reservedReplicas
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+int32
|
- 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) +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. |
-(Appears on: -FleetAutoscalerPolicy) -
--
CounterPolicy controls the desired behavior of the Counter autoscaler policy.
- -| Field | -Description | -
|---|---|
-key
+allocatedReplicas
-string
+int32
|
- Key is the name of the Counter. Required field. +AllocatedReplicas are the number of Allocated GameServer replicas |
-maxCapacity
+players
-int64
+
+AggregatedPlayerStatus
+
|
- MaxCapacity is the maximum aggregate Counter total capacity across the fleet. -MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. +(Optional) +[Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players are the current total player capacity and count for this Fleet |
-minCapacity
+counters
-int64
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
+
|
- 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. +(Optional) +(Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter +count for this Fleet. |
-bufferSize
+lists
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
+
|
- 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. +(Optional) +(Alpha, CountsAndLists feature flag) Lists provides aggregated List capacityv and List values +for this Fleet. |
(Appears on: -FleetAutoscalerSync) +GameServerSpec)
-
FixedIntervalSync controls the desired behavior of the fixed interval based sync.
+GameServerPort defines a set of Ports that +are to be exposed via the GameServer
-seconds
+name
-int32
+string
|
- Seconds defines how often we run fleet autoscaling in seconds +Name is the descriptive name of the port |
-(Appears on: -FleetAutoscaleReview) -
--
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
- -| Field | -Description | +
+portPolicy
+
+
+PortPolicy
+
+
+ |
+
+ 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 |
|---|---|---|---|
-uid
+container
-k8s.io/apimachinery/pkg/types.UID
+string
|
- 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. +(Optional) +Container is the name of the container on which to open the port. Defaults to the game server container. |
||
-name
+containerPort
-string
+int32
|
- Name is the name of the Fleet being scaled +ContainerPort is the port that is being opened on the specified container’s process |
||
-namespace
+hostPort
-string
+int32
|
- Namespace is the namespace associated with the request (if any). +HostPort the port exposed on the host for clients to connect to |
||
-status
+protocol
-
-FleetStatus
+
+Kubernetes core/v1.Protocol
|
- The Fleet’s status values +Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. |
(Appears on: -FleetAutoscaleReview) +GameServerSet)
-
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
+GameServerSetSpec the specification for GameServerSet
-uid
+replicas
-k8s.io/apimachinery/pkg/types.UID
+int32
|
- UID is an identifier for the individual request/response. -This should be copied over from the corresponding FleetAutoscaleRequest. +Replicas are the number of GameServers that should be in this set |
-scale
+allocationOverflow
-bool
+
+AllocationOverflow
+
|
- Set to false if no scaling should occur to the Fleet +(Optional) +[Stage: Beta]
+[FeatureFlag:FleetAllocationOverflow]
+Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
+the desired replicas on the underlying |
-replicas
+scheduling
-int32
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- The targeted replica count +Scheduling strategy. Defaults to “Packed”. |
-
FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.
- -| Field | -Description | -
|---|---|
-request
+priorities
-
-FleetAutoscaleRequest
+
+[]Priority
|
+(Optional)
+ (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
-response
+template
-
-FleetAutoscaleResponse
+
+GameServerTemplateSpec
|
+ Template the GameServer template to apply for this GameServerSet |
(Appears on: -FleetAutoscalerSpec) +GameServerSet)
-
FleetAutoscalerPolicy describes how to scale a fleet
+GameServerSetStatus is the status of a GameServerSet
-type
+replicas
-
-FleetAutoscalerPolicyType
-
+int32
|
- Type of autoscaling policy. +Replicas is the total number of current GameServer replicas |
-buffer
+readyReplicas
-
-BufferPolicy
-
+int32
|
-(Optional)
- Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. +ReadyReplicas is the number of Ready GameServer replicas |
-webhook
+reservedReplicas
-
-WebhookPolicy
-
+int32
|
-(Optional)
- Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. +ReservedReplicas is the number of Reserved GameServer replicas |
-counter
+allocatedReplicas
-
-CounterPolicy
+int32
+
+ |
+
+ AllocatedReplicas is the number of Allocated GameServer replicas + |
+
+shutdownReplicas
+
+int32
+
+ |
+
+ ShutdownReplicas is the number of Shutdown GameServers replicas + |
+
+players
+
+
+AggregatedPlayerStatus
|
(Optional)
[Stage:Alpha] -[FeatureFlag:CountsAndLists] -Counter policy config params. Present only if FleetAutoscalerPolicyType = Counter. +[FeatureFlag:PlayerTracking] +Players is the current total player capacity and count for this GameServerSet |
-list
+counters
-
-ListPolicy
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
|
(Optional)
- [Stage:Alpha] -[FeatureFlag:CountsAndLists] -List policy config params. Present only if FleetAutoscalerPolicyType = List. +(Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter +count for this GameServerSet. |
string alias)-(Appears on: -FleetAutoscalerPolicy) -
--
FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet
- -lists
+
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
+
+
+(Alpha, CountsAndLists feature flag) Lists provides aggregated List capacity and List values +for this GameServerSet.
+(Appears on: -FleetAutoscaler) +GameServer, +GameServerTemplateSpec)
-
FleetAutoscalerSpec is the spec for a Fleet Scaler
+GameServerSpec is the spec for a GameServer resource
-fleetName
+container
string
|
+ Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-policy
+ports
-
-FleetAutoscalerPolicy
+
+[]GameServerPort
|
- Autoscaling policy +Ports are the array of ports that can be exposed via the game server |
-sync
+health
-
-FleetAutoscalerSync
+
+Health
|
-(Optional)
- Sync defines when FleetAutoscalers runs autoscaling +Health configures health checking |
-(Appears on: -FleetAutoscaler) -
--
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
- -| Field | -Description | -
|---|---|
-currentReplicas
+scheduling
-int32
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler +Scheduling strategy. Defaults to “Packed” |
-desiredReplicas
+sdkServer
-int32
+
+SdkServer
+
|
- DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler +SdkServer specifies parameters for the Agones SDK Server sidecar container |
-lastScaleTime
+template
-
-Kubernetes meta/v1.Time
+
+Kubernetes core/v1.PodTemplateSpec
|
-(Optional)
- lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, +Template describes the Pod that will be created for the GameServer |
-ableToScale
+players
-bool
+
+PlayersSpec
+
|
- AbleToScale indicates that we can access the target fleet +(Optional) +(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
-scalingLimited
+counters
-bool
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
|
- ScalingLimited indicates that the calculated scale would be above or below the range -defined by MinReplicas and MaxReplicas, and has thus been capped. +(Optional) +(Alpha, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. +Keys must be declared at GameServer creation time. |
-(Appears on: -FleetAutoscalerSpec) -
--
FleetAutoscalerSync describes when to sync a fleet
- -| Field | -Description | -
|---|---|
-type
+lists
-
-FleetAutoscalerSyncType
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
|
- Type of autoscaling sync. +(Optional) +(Alpha, 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. |
-fixedInterval
+eviction
-
-FixedIntervalSync
+
+Eviction
|
(Optional)
- FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval. +Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. |
string alias)(Appears on: -FleetAutoscalerSync) +GameServerSelector, +GameServerStatus)
-
FleetAutoscalerSyncType is the sync strategy for a given Fleet
+GameServerState is the state for the GameServer
-(Appears on: -FleetAutoscalerPolicy) +GameServer)
-
ListPolicy controls the desired behavior of the List autoscaler policy.
+GameServerStatus is the status for a GameServer resource
-key
+state
-string
+
+GameServerState
+
|
- Key is the name of the List. Required field. +GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-maxCapacity
+ports
-int64
+
+[]GameServerStatusPort
+
|
- MaxCapacity is the maximum aggregate List total capacity across the fleet. -MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. |
-minCapacity
+address
-int64
+string
|
- 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
+addresses
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+
+[]Kubernetes core/v1.NodeAddress
+
|
- 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. +(Optional) +Addresses is the array of addresses at which the GameServer can be reached; copy of Node.Status.addresses. |
-(Appears on: -FleetAutoscalerPolicy) -
--
WebhookPolicy controls the desired behavior of the webhook policy. -It contains the description of the webhook autoscaler service -used to form url which is accessible inside the cluster
- -| Field | -Description | -
|---|---|
-url
+nodeName
string
|
-(Optional)
-
The Please note that using 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
+reservedUntil
-
-Kubernetes admissionregistration/v1.ServiceReference
+
+Kubernetes meta/v1.Time
|
-(Optional)
-
If the webhook is running within the cluster, then you should use |
-caBundle
+players
-[]byte
+
+PlayerStatus
+
|
(Optional)
-
[Stage:Alpha] +[FeatureFlag:PlayerTracking] + |
+
+counters
+
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
+
+ |
+
+(Optional)
+ (Alpha, CountsAndLists feature flag) Counters and Lists provides the configuration for generic tracking features. + |
+
+lists
+
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
+
+
+ |
++(Optional) + | +
+eviction
+
+
+Eviction
+
+
+ |
+
+(Optional)
+ Eviction specifies the eviction tolerance of the GameServer. |
-
Package v1 is the v1 version of the API.
+(Appears on: +GameServerAllocationStatus, +GameServerStatus) -Resource Types: - --
GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
+GameServerStatusPort shows the port that was allocated to a +GameServer.
-apiVersion
-string |
+
-
-multicluster.agones.dev/v1
-
|
|
-kind
-string
+port
+
+int32
+
|
-GameServerAllocationPolicy |
++ | +
+(Appears on: +FleetSpec, +GameServerSetSpec) +
++
GameServerTemplateSpec is a template for GameServers
+ +| Field | +Description | ||||||
|---|---|---|---|---|---|---|---|
metadata
@@ -4071,8 +3878,8 @@ GameServerAllocat
spec
-
-GameServerAllocationPolicySpec
+
+GameServerSpec
|
-priority
+container
-int32
+string
|
+ Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-weight
+ports
-int
+
+[]GameServerPort
+
|
+ Ports are the array of ports that can be exposed via the game server |
-connectionInfo
+health
-
-ClusterConnectionInfo
+
+Health
|
+ Health configures health checking |
scheduling
+
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+Scheduling strategy. Defaults to “Packed”
-(Appears on: -GameServerAllocationPolicySpec) -
--
ClusterConnectionInfo defines the connection information for a cluster
- -| Field | -Description | +
+sdkServer
+
+
+SdkServer
+
+
+ |
+
+ SdkServer specifies parameters for the Agones SDK Server sidecar container + |
|---|---|---|---|
-clusterName
+template
-string
+
+Kubernetes core/v1.PodTemplateSpec
+
|
- Optional: the name of the targeted cluster +Template describes the Pod that will be created for the GameServer |
||
-allocationEndpoints
+players
-[]string
+
+PlayersSpec
+
|
- 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 +(Optional) +(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
||
-secretName
+counters
-string
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
|
- The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster +(Optional) +(Alpha, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. +Keys must be declared at GameServer creation time. |
||
-namespace
+lists
-string
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
+
|
- The cluster namespace from which to allocate gameservers +(Optional) +(Alpha, 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. |
||
-serverCa
+eviction
-[]byte
+
+Eviction
+
|
- The PEM encoded server CA, used by the allocator client to authenticate the remote server. +(Optional) +Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. + |
+
-
ConnectionInfoIterator an iterator on ClusterConnectionInfo
+(Appears on: +GameServerSpec) + ++
Health configures health checking on the GameServer
-currPriority
+disabled
-int
+bool
|
- currPriority Current priority index from the orderedPriorities +Disabled is whether health checking is disabled or not |
-orderedPriorities
+periodSeconds
-[]int32
+int32
|
- orderedPriorities list of ordered priorities +PeriodSeconds is the number of seconds each health ping has to occur in |
-priorityToCluster
+failureThreshold
-map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
+int32
|
- priorityToCluster Map of priority to cluster-policies map +FailureThreshold how many failures in a row constitutes unhealthy |
-clusterBlackList
+initialDelaySeconds
-map[string]bool
+int32
|
- clusterBlackList the cluster blacklist for the clusters that has already returned +InitialDelaySeconds initial delay before checking health |
(Appears on: -GameServerAllocationPolicy) +GameServerSpec, +GameServerStatus)
-
GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
+ListStatus stores the current list values and maximum capacity
-priority
+capacity
-int32
+int64
|
@@ -4281,62 +4118,254 @@ GameServerAll |
-weight
+values
-int
+[]string
|
+(Appears on: +GameServerStatus) +
++
PlayerStatus stores the current player capacity values
+ +| Field | +Description | +
|---|---|
-connectionInfo
+count
-
-ClusterConnectionInfo
+int64
+
+ |
++ | +
+capacity
+
+int64
+
+ |
++ | +
+ids
+
+[]string
+
+ |
++ | +
+(Appears on: +GameServerSpec) +
++
PlayersSpec tracks the initial player capacity
+ +| Field | +Description | +
|---|---|
+initialCapacity
+
+int64
+
+ |
++ | +
string alias)+(Appears on: +GameServerPort) +
++
PortPolicy is the port policy for the GameServer
+ ++(Appears on: +FleetSpec, +GameServerAllocationSpec, +GameServerSetSpec) +
++
Priority is a sorting option for GameServers with Counters or Lists based on the Capacity.
+ +| Field | +Description | +
|---|---|
+type
+
+string
+
+ |
+
+ Type: Sort by a “Counter” or a “List”. + |
+
+key
+
+string
+
+ |
+
+ Key: The name of the Counter or List. If not found on the GameServer, has no impact. + |
+
+order
+
+string
+
+ |
+
+ Order: Sort by “Ascending” or “Descending”. “Descending” a bigger Capacity is preferred. +“Ascending” would be smaller Capacity is preferred. + |
+
+(Appears on: +GameServerSpec) +
++
SdkServer specifies parameters for the Agones SDK Server sidecar container
+ +| Field | +Description | +
|---|---|
+logLevel
+
+
+SdkServerLogLevel
|
+ LogLevel for SDK server (sidecar) logs. Defaults to “Info” + |
+
+grpcPort
+
+int32
+
+ |
+
+ GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections + |
+
+httpPort
+
+int32
+
+ |
+
+ HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections |
string alias)+(Appears on: +SdkServer) +
++
SdkServerLogLevel is the log level for SDK server (sidecar) logs
+
Generated with gen-crd-api-reference-docs.
Packages:
Package v1 is the v1 version of the API.
Resource Types: --
GameServerAllocation is the data structure for allocating against a set of
-GameServers, defined selectors selectors
GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
-allocation.agones.dev/v1
+multicluster.agones.dev/v1
|
@@ -4361,13 +4390,13 @@ GameServerAllocation |
+GameServerAllocationPolicy |
|||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -4381,8 +4410,8 @@ GameServerAllocation
spec
-
-GameServerAllocationSpec
+
+GameServerAllocationPolicySpec
|
-multiClusterSetting
+priority
-
-MultiClusterSetting
-
+int32
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. |
-required
+weight
-
-GameServerSelector
-
+int
|
- 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. |
-preferred
+connectionInfo
-
-[]GameServerSelector
+
+ClusterConnectionInfo
|
- 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 |
-priorities
-
-
-[]Priority
-
-
- |
-
-(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The allocator will use the first priority for sorting GameServers by -available Capacity in the Selector set. Acts as a tie-breaker after sorting the game servers -by State and Strategy Packed. Impacts which GameServer is checked first. + |
+(Appears on: +GameServerAllocationPolicySpec) +
++
ClusterConnectionInfo defines the connection information for a cluster
+ +
-selectors
-
-
-[]GameServerSelector
-
-
- |
-
- 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. - |
+Field | +Description |
|---|---|---|---|
-scheduling
+clusterName
-agones.dev/agones/pkg/apis.SchedulingStrategy
+string
|
- Scheduling strategy. Defaults to “Packed”. +Optional: the name of the targeted cluster |
||
-metadata
+allocationEndpoints
-
-MetaPatch
-
+[]string
|
- 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 +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 |
||
-counters
+secretName
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterAction
-
+string
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. +The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster |
||
-lists
+namespace
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
-
+string
|
-(Optional)
- (Alpha, CountsAndLists feature flag) List actions to perform during allocation. - |
-
The cluster namespace from which to allocate gameservers
status
+serverCa
-
-GameServerAllocationStatus
-
+[]byte
The PEM encoded server CA, used by the allocator client to authenticate the remote server.
-(Appears on: -GameServerAllocationSpec) -
--
CounterAction is an optional action that can be performed on a Counter at allocation.
+ConnectionInfoIterator an iterator on ClusterConnectionInfo
-action
+currPriority
-string
+int
|
-(Optional)
- Action must to either “Increment” or “Decrement” the Counter’s Count. Must also define the Amount. +currPriority Current priority index from the orderedPriorities |
-amount
+orderedPriorities
-int64
+[]int32
|
-(Optional)
- Amount is the amount to increment or decrement the Count. Must be a positive integer. +orderedPriorities list of ordered priorities |
-capacity
+priorityToCluster
-int64
+map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
|
-(Optional)
- Capacity is the amount to update the maximum capacity of the Counter to this number. Min 0, Max int64. +priorityToCluster Map of priority to cluster-policies map + |
+
+clusterBlackList
+
+map[string]bool
+
+ |
+
+ clusterBlackList the cluster blacklist for the clusters that has already returned |
(Appears on: -GameServerSelector) +GameServerAllocationPolicy)
-
CounterSelector is the filter options for a GameServer based on the count and/or available capacity.
+GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
-minCount
-
-int64
-
- |
-
-(Optional)
- MinCount is the minimum current value. Defaults to 0. - |
-
-maxCount
+priority
-int64
+int32
|
-(Optional)
- MaxCount is the maximum current value. Defaults to 0, which translates as max(in64). |
-minAvailable
+weight
-int64
+int
|
-(Optional)
- MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0. |
-maxAvailable
+connectionInfo
-int64
+
+ClusterConnectionInfo
+
|
-(Optional)
- MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which translates to max(int64). |
-(Appears on: -GameServerAllocation) +
Package v1 is the v1 version of the API.
+Resource Types: +-
GameServerAllocationSpec is the spec for a GameServerAllocation
+Fleet is the data structure for a Fleet resource
-multiClusterSetting
-
-
-MultiClusterSetting
-
-
+apiVersion
+string |
+
+
+agones.dev/v1
+
|
+||||||||||
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +kind
+string
|
+Fleet |
||||||||||
-required
+metadata
-
-GameServerSelector
+
+Kubernetes meta/v1.ObjectMeta
|
- 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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||
-preferred
+spec
-
-[]GameServerSelector
+
+FleetSpec
|
- 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 + +
|
||||||||||
-lists
+status
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
+
+FleetStatus
|
-(Optional)
- (Alpha, CountsAndLists feature flag) List actions to perform during allocation. |
string alias)-(Appears on: -GameServerAllocationStatus) -
--
GameServerAllocationState is the Allocation state
- --(Appears on: -GameServerAllocation) -
--
GameServerAllocationStatus is the status for an GameServerAllocation resource
+GameServer is the data structure for a GameServer resource.
+It is worth noting that while there is a GameServerStatus Status entry for the GameServer, it is not
+defined as a subresource - unlike Fleet and other Agones resources.
+This is so that we can retain the ability to change multiple aspects of a GameServer in a single atomic operation,
+which is particularly useful for operations such as allocation.
-state
-
-
-GameServerAllocationState
-
-
- |
+
- GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated +
+agones.dev/v1
+
|
|
-gameServerName
-
+kind
string
-
- |
-+ | GameServer |
-ports
+metadata
-
-[]GameServerStatusPort
+
+Kubernetes meta/v1.ObjectMeta
|
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
|
-address
-
-string
-
- |
-- | -|
-addresses
+spec
-
-[]Kubernetes core/v1.NodeAddress
+
+GameServerSpec
|
- | -|
-nodeName
-
-string
-
- |
-- | -
-source
+container
string
|
- If the allocation is from a remote cluster, Source is the endpoint of the remote agones-allocator. -Otherwise, Source is “local” +Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-metadata
+ports
-
-GameServerMetadata
+
+[]GameServerPort
|
+ Ports are the array of ports that can be exposed via the game server |
-(Appears on: -GameServerAllocationStatus) -
--
GameServerMetadata is the metadata from the allocated game server at allocation time
- -| Field | -Description | -
|---|---|
-labels
+health
-map[string]string
+
+Health
+
|
+ Health configures health checking |
-annotations
+scheduling
-map[string]string
-
- |
-- | -
-(Appears on: -GameServerAllocationSpec) -
--
GameServerSelector contains all the filter options for selecting -a GameServer for allocation.
- -| Field | -Description | +agones.dev/agones/pkg/apis.SchedulingStrategy + + +
+ Scheduling strategy. Defaults to “Packed” + |
|---|---|---|
-LabelSelector
+sdkServer
-
-Kubernetes meta/v1.LabelSelector
+
+SdkServer
|
-
-(Members of See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +SdkServer specifies parameters for the Agones SDK Server sidecar container |
|
-gameServerState
+template
-
-GameServerState
+
+Kubernetes core/v1.PodTemplateSpec
|
- 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. +Template describes the Pod that will be created for the GameServer |
|
players
-
-PlayerSelector
+
+PlayersSpec
|
(Optional)
- [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. +(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
|
counters
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterSelector
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
|
(Optional)
- (Alpha, CountsAndLists feature flag) 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. +(Alpha, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. +Keys must be declared at GameServer creation time. |
|
lists
-
-map[string]agones.dev/agones/pkg/apis/allocation/v1.ListSelector
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
|
(Optional)
- (Alpha, CountsAndLists feature flag) 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. +(Alpha, 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. |
-(Appears on: -GameServerAllocationSpec) -
--
ListAction is an optional action that can be performed on a List at allocation.
- -| Field | -Description | -
|---|---|
-addValues
+eviction
-[]string
+
+Eviction
+
|
(Optional)
- AddValues appends values to a List’s Values array. Any duplicate values will be ignored. +Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. + |
+
capacity
+status
-int64
+
+GameServerStatus
+
Capacity updates the maximum capacity of the Counter to this number. Min 0, Max 1000.
-(Appears on: -GameServerSelector) -
--
ListSelector is the filter options for a GameServer based on List available capacity and/or the -existence of a value in a List.
+GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Deployments and ReplicaSets
-containsValue
-
-string
-
+apiVersion
+string |
+
+
+agones.dev/v1
+
|
+
|
-(Optional)
- ContainsValue says to only match GameServers who has this value in the list. Defaults to “”, which is all. +kind
+string
|
+GameServerSet |
-minAvailable
+metadata
-int64
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(Optional)
- MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-maxAvailable
+spec
-int64
+
+GameServerSetSpec
+
|
-(Optional)
- MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which is translated as max(int64). - |
-
-(Appears on: -GameServerAllocationSpec) -
--
MetaPatch is the metadata used to patch the GameServer metadata on allocation
- +| Field | -Description | -
|---|---|
-labels
+replicas
-map[string]string
+int32
|
+ Replicas are the number of GameServers that should be in this set |
-annotations
+allocationOverflow
-map[string]string
+
+AllocationOverflow
+
|
+(Optional)
+ [Stage: Beta]
+[FeatureFlag:FleetAllocationOverflow]
+Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
+the desired replicas on the underlying |
-(Appears on: -GameServerAllocationSpec) -
--
MultiClusterSetting specifies settings for multi-cluster allocation.
- -| Field | -Description | -
|---|---|
-enabled
+scheduling
-bool
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-policySelector
+priorities
-
-Kubernetes meta/v1.LabelSelector
+
+[]Priority
|
+(Optional)
+ (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
-(Appears on: -GameServerSelector) -
--
PlayerSelector is the filter options for a GameServer based on player counts
- -| Field | -Description | -
|---|---|
-minAvailable
+template
-int64
+
+GameServerTemplateSpec
+
|
+ Template the GameServer template to apply for this GameServerSet + |
+
maxAvailable
+status
-int64
+
+GameServerSetStatus
+
-
Package v1 is the v1 version of the API.
- -Resource Types: - --
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+(Appears on: +FleetStatus, +GameServerSetStatus) + ++
AggregatedCounterStatus stores total and allocated Counter tracking values
-apiVersion
-string |
+
-
-autoscaling.agones.dev/v1
-
|
|
-kind
-string
+allocatedCapacity
+
+int64
+
+ |
+- | FleetAutoscaler |
-metadata
+count
-
-Kubernetes meta/v1.ObjectMeta
-
+int64
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
|
|
-spec
+capacity
-
-FleetAutoscalerSpec
-
+int64
|
- - + |
+
+(Appears on: +FleetStatus, +GameServerSetStatus) +
++
AggregatedListStatus stores total and allocated List tracking values
+| Field | +Description | +
|---|---|
-fleetName
+allocatedCount
-string
+int64
|
@@ -5368,41 +5257,29 @@ FleetAutoscaler |
-policy
+allocatedCapacity
-
-FleetAutoscalerPolicy
-
+int64
|
- Autoscaling policy |
-sync
+count
-
-FleetAutoscalerSync
-
+int64
|
-(Optional)
- Sync defines when FleetAutoscalers runs autoscaling - |
-
status
+capacity
-
-FleetAutoscalerStatus
-
+int64
(Appears on: -FleetAutoscalerPolicy) +FleetStatus, +GameServerSetStatus)
-
BufferPolicy controls the desired behavior of the buffer policy.
+AggregatedPlayerStatus stores total player tracking values
-maxReplicas
-
-int32
-
- |
-
- MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize - |
-
-minReplicas
+count
-int32
+int64
|
- 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
+capacity
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+int64
|
- 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) |
(Appears on: -FleetAutoscalerPolicy) +FleetSpec, +GameServerSetSpec)
-
CounterPolicy controls the desired behavior of the Counter autoscaler policy.
+AllocationOverflow specifies what labels and/or annotations to apply on Allocated GameServers
+if the desired number of the underlying GameServerSet drops below the number of Allocated GameServers
+attached to it.
-key
+labels
-string
+map[string]string
|
- Key is the name of the Counter. Required field. +(Optional) +Labels to be applied to the |
-maxCapacity
+annotations
-int64
+map[string]string
|
- MaxCapacity is the maximum aggregate Counter total capacity across the fleet. -MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. +(Optional) +Annotations to be applied to the |
+(Appears on: +GameServerSpec, +GameServerStatus) +
++
CounterStatus stores the current counter values and maximum capacity
+ +| Field | +Description | +
|---|---|
-minCapacity
+count
int64
|
- 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
+capacity
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+int64
|
- 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. |
(Appears on: -FleetAutoscalerSync) +GameServerSpec, +GameServerStatus)
-
FixedIntervalSync controls the desired behavior of the fixed interval based sync.
+Eviction specifies the eviction tolerance of the GameServer
-seconds
+safe
-int32
+
+EvictionSafe
+
|
- Seconds defines how often we run fleet autoscaling in seconds +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 |
string alias)+(Appears on: +Eviction) +
++
EvictionSafe specified whether the game server supports termination via SIGTERM
+ +(Appears on: -FleetAutoscaleReview) +Fleet)
-
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+FleetSpec is the spec for a Fleet
-uid
-
-k8s.io/apimachinery/pkg/types.UID
-
- |
-
- 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
+replicas
-string
+int32
|
- Name is the name of the Fleet being scaled +Replicas are the number of GameServers that should be in this set. Defaults to 0. |
-namespace
+allocationOverflow
-string
+
+AllocationOverflow
+
|
- Namespace is the namespace associated with the request (if any). +(Optional) +[Stage: Beta]
+[FeatureFlag:FleetAllocationOverflow]
+Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more
+than the desired replicas on the underlying |
-status
+strategy
-
-FleetStatus
+
+Kubernetes apps/v1.DeploymentStrategy
|
- The Fleet’s status values +Deployment strategy |
-(Appears on: -FleetAutoscaleReview) -
--
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
- -| Field | -Description | -
|---|---|
-uid
+scheduling
-k8s.io/apimachinery/pkg/types.UID
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- UID is an identifier for the individual request/response. -This should be copied over from the corresponding FleetAutoscaleRequest. +Scheduling strategy. Defaults to “Packed”. |
-scale
+priorities
-bool
+
+[]Priority
+
|
- Set to false if no scaling should occur to the Fleet +(Optional) +(Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
-replicas
+template
-int32
+
+GameServerTemplateSpec
+
|
- The targeted replica count +Template the GameServer template to apply for this Fleet |
-
FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.
+(Appears on: +Fleet, +FleetAutoscaleRequest) + ++
FleetStatus is the status of a Fleet
-request
+replicas
-
-FleetAutoscaleRequest
-
+int32
|
+ Replicas the total number of current GameServer replicas |
-response
+readyReplicas
-
-FleetAutoscaleResponse
-
+int32
|
+ ReadyReplicas are the number of Ready GameServer replicas |
-(Appears on: -FleetAutoscalerSpec) -
--
FleetAutoscalerPolicy describes how to scale a fleet
- -| Field | -Description | -
|---|---|
-type
+reservedReplicas
-
-FleetAutoscalerPolicyType
-
+int32
|
- Type of autoscaling policy. +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. |
-buffer
+allocatedReplicas
-
-BufferPolicy
-
+int32
|
-(Optional)
- Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. +AllocatedReplicas are the number of Allocated GameServer replicas |
-webhook
+players
-
-WebhookPolicy
+
+AggregatedPlayerStatus
|
(Optional)
- Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. +[Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players are the current total player capacity and count for this Fleet |
-counter
+counters
-
-CounterPolicy
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
|
(Optional)
- [Stage:Alpha] -[FeatureFlag:CountsAndLists] -Counter policy config params. Present only if FleetAutoscalerPolicyType = Counter. +(Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter +count for this Fleet. |
-list
+lists
-
-ListPolicy
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
|
(Optional)
- [Stage:Alpha] -[FeatureFlag:CountsAndLists] -List policy config params. Present only if FleetAutoscalerPolicyType = List. +(Alpha, CountsAndLists feature flag) Lists provides aggregated List capacityv and List values +for this Fleet. |
string alias)-(Appears on: -FleetAutoscalerPolicy) -
--
FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet
- -(Appears on: -FleetAutoscaler) +GameServerSpec)
-
FleetAutoscalerSpec is the spec for a Fleet Scaler
+GameServerPort defines a set of Ports that +are to be exposed via the GameServer
-fleetName
+name
string
|
+ Name is the descriptive name of the port |
-policy
+portPolicy
-
-FleetAutoscalerPolicy
+
+PortPolicy
|
- Autoscaling 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 |
-sync
+container
-
-FleetAutoscalerSync
-
+string
|
(Optional)
- Sync defines when FleetAutoscalers runs autoscaling +Container is the name of the container on which to open the port. Defaults to the game server container. + |
+
+containerPort
+
+int32
+
+ |
+
+ ContainerPort is the port that is being opened on the specified container’s process + |
+
+hostPort
+
+int32
+
+ |
+
+ HostPort the port exposed on the host for clients to connect to + |
+
+protocol
+
+
+Kubernetes core/v1.Protocol
+
+
+ |
+
+ Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. |
(Appears on: -FleetAutoscaler) +GameServerSet)
-
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+GameServerSetSpec the specification for GameServerSet
-currentReplicas
+replicas
int32
|
- CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler +Replicas are the number of GameServers that should be in this set |
-desiredReplicas
+allocationOverflow
-int32
+
+AllocationOverflow
+
|
- DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler +(Optional) +[Stage: Beta]
+[FeatureFlag:FleetAllocationOverflow]
+Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
+the desired replicas on the underlying |
-lastScaleTime
+scheduling
-
-Kubernetes meta/v1.Time
-
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
-(Optional)
- lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, +Scheduling strategy. Defaults to “Packed”. |
-ableToScale
+priorities
-bool
+
+[]Priority
+
|
- AbleToScale indicates that we can access the target fleet +(Optional) +(Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers +by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by +State and Strategy. Impacts scale down logic. |
-scalingLimited
+template
-bool
+
+GameServerTemplateSpec
+
|
- ScalingLimited indicates that the calculated scale would be above or below the range -defined by MinReplicas and MaxReplicas, and has thus been capped. +Template the GameServer template to apply for this GameServerSet |
(Appears on: -FleetAutoscalerSpec) +GameServerSet)
-
FleetAutoscalerSync describes when to sync a fleet
+GameServerSetStatus is the status of a GameServerSet
-type
+replicas
-
-FleetAutoscalerSyncType
-
+int32
|
- Type of autoscaling sync. +Replicas is the total number of current GameServer replicas |
-fixedInterval
+readyReplicas
-
-FixedIntervalSync
-
+int32
|
-(Optional)
- FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval. +ReadyReplicas is the number of Ready GameServer replicas |
string alias)-(Appears on: -FleetAutoscalerSync) -
--
FleetAutoscalerSyncType is the sync strategy for a given Fleet
- --(Appears on: -FleetAutoscalerPolicy) -
--
ListPolicy controls the desired behavior of the List autoscaler policy.
- -| Field | -Description | +
+reservedReplicas
+
+int32
+
+ |
+
+ ReservedReplicas is the number of Reserved GameServer replicas + |
|---|---|---|---|
-key
+allocatedReplicas
-string
+int32
|
- Key is the name of the List. Required field. +AllocatedReplicas is the number of Allocated GameServer replicas |
||
-maxCapacity
+shutdownReplicas
-int64
+int32
|
- MaxCapacity is the maximum aggregate List total capacity across the fleet. -MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. +ShutdownReplicas is the number of Shutdown GameServers replicas |
||
-minCapacity
+players
-int64
+
+AggregatedPlayerStatus
+
|
- 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. +(Optional) +[Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players is the current total player capacity and count for this GameServerSet |
||
-bufferSize
+counters
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
+
|
- 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. +(Optional) +(Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter +count for this GameServerSet. + |
+||
+lists
+
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
+
+
+ |
+
+(Optional)
+ (Alpha, CountsAndLists feature flag) Lists provides aggregated List capacity and List values +for this GameServerSet. |
(Appears on: -FleetAutoscalerPolicy) +GameServer, +GameServerTemplateSpec)
-
WebhookPolicy controls the desired behavior of the webhook policy. -It contains the description of the webhook autoscaler service -used to form url which is accessible inside the cluster
+GameServerSpec is the spec for a GameServer resource
-url
+container
string
|
-(Optional)
-
The Please note that using 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. +Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-service
+ports
-
-Kubernetes admissionregistration/v1.ServiceReference
+
+[]GameServerPort
|
-(Optional)
-
If the webhook is running within the cluster, then you should use Ports are the array of ports that can be exposed via the game server |
-caBundle
+health
-[]byte
+
+Health
+
|
-(Optional)
-
Health configures health checking |
-
Package v1 is the v1 version of the API.
- -Resource Types: - --
GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-apiVersion
-string |
+
-
-multicluster.agones.dev/v1
-
+Scheduling strategy. Defaults to “Packed” |
||||||
-kind
-string
+sdkServer
+
+
+SdkServer
+
+
+ |
+
+ SdkServer specifies parameters for the Agones SDK Server sidecar container |
-GameServerAllocationPolicy |
|||||
-metadata
+template
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.PodTemplateSpec
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Template describes the Pod that will be created for the GameServer |
||||||
-spec
+players
-
-GameServerAllocationPolicySpec
+
+PlayersSpec
|
- - -
Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. |
string alias)+(Appears on: +GameServerSelector, +GameServerStatus) +
++
GameServerState is the state for the GameServer
+ +(Appears on: -GameServerAllocationPolicySpec) +GameServer)
-
ClusterConnectionInfo defines the connection information for a cluster
+GameServerStatus is the status for a GameServer resource
-clusterName
+state
-string
+
+GameServerState
+
|
- Optional: the name of the targeted cluster +GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-allocationEndpoints
+ports
-[]string
+
+[]GameServerStatusPort
+
|
- 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 |
-secretName
+address
string
|
- The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster |
-namespace
+addresses
-string
+
+[]Kubernetes core/v1.NodeAddress
+
|
- The cluster namespace from which to allocate gameservers +(Optional) +Addresses is the array of addresses at which the GameServer can be reached; copy of Node.Status.addresses. |
-serverCa
+nodeName
-[]byte
+string
|
- The PEM encoded server CA, used by the allocator client to authenticate the remote server. |
-
ConnectionInfoIterator an iterator on ClusterConnectionInfo
- -| Field | -Description | +
+reservedUntil
+
+
+Kubernetes meta/v1.Time
+
+
+ |
++ |
|---|---|---|---|
-currPriority
+players
-int
+
+PlayerStatus
+
|
- currPriority Current priority index from the orderedPriorities +(Optional) +[Stage:Alpha] +[FeatureFlag:PlayerTracking] |
||
-orderedPriorities
+counters
-[]int32
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
|
- orderedPriorities list of ordered priorities +(Optional) +(Alpha, CountsAndLists feature flag) Counters and Lists provides the configuration for generic tracking features. |
||
-priorityToCluster
+lists
-map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
+
+map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
+
|
- priorityToCluster Map of priority to cluster-policies map +(Optional) |
||
-clusterBlackList
+eviction
-map[string]bool
+
+Eviction
+
|
- clusterBlackList the cluster blacklist for the clusters that has already returned +(Optional) +Eviction specifies the eviction tolerance of the GameServer. |
(Appears on: -GameServerAllocationPolicy) +GameServerAllocationStatus, +GameServerStatus)
-
GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
+GameServerStatusPort shows the port that was allocated to a +GameServer.
-priority
-
-int32
-
- |
-- | -
-weight
+name
-int
+string
|
@@ -6454,11 +6313,9 @@ GameServerAll |
-connectionInfo
+port
-
-ClusterConnectionInfo
-
+int32
|
@@ -6466,23 +6323,15 @@ GameServerAll |
-
Package v1 is the v1 version of the API.
+(Appears on: +FleetSpec, +GameServerSetSpec) -Resource Types: --
Fleet is the data structure for a Fleet resource
+GameServerTemplateSpec is a template for GameServers
-apiVersion
-string |
+
-
-agones.dev/v1
-
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
|||||||||||||||||||||
-kind
+spec
+
+
+GameServerSpec
+
+
+ |
+
+ + +
|
-
GameServer is the data structure for a GameServer resource.
-It is worth noting that while there is a GameServerStatus Status entry for the GameServer, it is not
-defined as a subresource - unlike Fleet and other Agones resources.
-This is so that we can retain the ability to change multiple aspects of a GameServer in a single atomic operation,
-which is particularly useful for operations such as allocation.
+
Health configures health checking on the GameServer
-apiVersion
-string |
+
-
-agones.dev/v1
-
+Disabled is whether health checking is disabled or not |
|
-kind
-string
+periodSeconds
+
+int32
+
+ |
+
+ PeriodSeconds is the number of seconds each health ping has to occur in |
-GameServer |
-metadata
+failureThreshold
-
-Kubernetes meta/v1.ObjectMeta
-
+int32
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+FailureThreshold how many failures in a row constitutes unhealthy |
|
-spec
+initialDelaySeconds
-
-GameServerSpec
-
+int32
|
- - + InitialDelaySeconds initial delay before checking health + |
+
+(Appears on: +GameServerSpec, +GameServerStatus) +
++
ListStatus stores the current list values and maximum capacity
+| Field | +Description | +
|---|---|
-container
+capacity
-string
+int64
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined |
-ports
+values
-
-[]GameServerPort
-
+[]string
|
- Ports are the array of ports that can be exposed via the game server |
+(Appears on: +GameServerStatus) +
++
PlayerStatus stores the current player capacity values
+ +| Field | +Description | +
|---|---|
-health
+count
-
-Health
-
+int64
|
- Health configures health checking |
-scheduling
+capacity
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int64
|
- Scheduling strategy. Defaults to “Packed” |
-sdkServer
+ids
-
-SdkServer
-
+[]string
|
- SdkServer specifies parameters for the Agones SDK Server sidecar container |
+(Appears on: +GameServerSpec) +
++
PlayersSpec tracks the initial player capacity
+ +| Field | +Description | +
|---|---|
-template
+initialCapacity
-
-Kubernetes core/v1.PodTemplateSpec
-
+int64
|
- Template describes the Pod that will be created for the GameServer |
string alias)+(Appears on: +GameServerPort) +
++
PortPolicy is the port policy for the GameServer
+ ++(Appears on: +FleetSpec, +GameServerAllocationSpec, +GameServerSetSpec) +
++
Priority is a sorting option for GameServers with Counters or Lists based on the Capacity.
+ +| Field | +Description | +
|---|---|
-players
+type
-
-PlayersSpec
-
+string
|
-(Optional)
- (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. +Type: Sort by a “Counter” or a “List”. |
-counters
+key
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
-
+string
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. -Keys must be declared at GameServer creation time. +Key: The name of the Counter or List. If not found on the GameServer, has no impact. + |
+
+order
+
+string
+
|
+
+ Order: Sort by “Ascending” or “Descending”. “Descending” a bigger Capacity is preferred. +“Ascending” would be smaller Capacity is preferred. + |
+
+(Appears on: +GameServerSpec) +
++
SdkServer specifies parameters for the Agones SDK Server sidecar container
+ +| Field | +Description |
|---|---|
-lists
+logLevel
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
+
+SdkServerLogLevel
|
-(Optional)
- (Alpha, 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. +LogLevel for SDK server (sidecar) logs. Defaults to “Info” |
-eviction
+grpcPort
-
-Eviction
-
+int32
|
-(Optional)
- Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”. - |
-
GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections
status
+httpPort
-
-GameServerStatus
-
+int32
HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections
string alias)+(Appears on: +SdkServer) +
++
SdkServerLogLevel is the log level for SDK server (sidecar) logs
+ ++
Package v1 is the v1 version of the API.
+ +Resource Types: + +-
GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Deployments and ReplicaSets
+GameServerAllocation is the data structure for allocating against a set of
+GameServers, defined selectors selectors
-agones.dev/v1
+allocation.agones.dev/v1
|
@@ -6876,13 +6852,13 @@ GameServerSet |
+GameServerAllocation |
||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -6896,8 +6872,8 @@ GameServerSet
spec
-
-GameServerSetSpec
+
+GameServerAllocationSpec
|
-replicas
+multiClusterSetting
-int32
+
+MultiClusterSetting
+
|
- Replicas are the number of GameServers that should be in this set +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-allocationOverflow
+required
-
-AllocationOverflow
+
+GameServerSelector
|
-(Optional)
- [Stage: Beta]
-[FeatureFlag:FleetAllocationOverflow]
-Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
-the desired replicas on the underlying 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. |
-scheduling
+preferred
-agones.dev/agones/pkg/apis.SchedulingStrategy
+
+[]GameServerSelector
+
|
- Scheduling strategy. Defaults to “Packed”. +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 |
|
(Optional)
(Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers -by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by -State and Strategy. Impacts scale down logic. - |
-|
-template
-
-
-GameServerTemplateSpec
-
-
- |
-
- Template the GameServer template to apply for this GameServerSet - |
-
status
+selectors
-
-GameServerSetStatus
+
+[]GameServerSelector
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.
-(Appears on: -FleetStatus, -GameServerSetStatus) -
--
AggregatedCounterStatus stores total and allocated Counter tracking values
- -| Field | -Description | -
|---|---|
-allocatedCount
+scheduling
-int64
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-allocatedCapacity
+metadata
-int64
+
+MetaPatch
+
|
+ 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 |
-count
+counters
-int64
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterAction
+
|
+(Optional)
+ (Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. |
-capacity
+lists
-int64
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
+
|
+(Optional)
+ (Alpha, CountsAndLists feature flag) List actions to perform during allocation. |
-(Appears on: -FleetStatus, -GameServerSetStatus) -
--
AggregatedListStatus stores total and allocated List tracking values
- -| Field | -Description | -
|---|---|
-allocatedCount
-
-int64
-
- |
-- | -
-allocatedCapacity
-
-int64
-
- |
-|
-count
-
-int64
-
- |
-- | -
-capacity
+status
-int64
+
+GameServerAllocationStatus
+
|
@@ -7111,15 +7031,14 @@ AggregatedListStatus |
(Appears on: -FleetStatus, -GameServerSetStatus) +GameServerAllocationSpec)
-
AggregatedPlayerStatus stores total player tracking values
+CounterAction is an optional action that can be performed on a Counter at allocation.
-count
+action
+
+string
+
+ |
+
+(Optional)
+ Action must to either “Increment” or “Decrement” the Counter’s Count. Must also define the Amount. + |
+
+amount
int64
|
+(Optional)
+ Amount is the amount to increment or decrement the Count. Must be a positive integer. |
|
+(Optional)
+ Capacity is the amount to update the maximum capacity of the Counter to this number. Min 0, Max int64. |
(Appears on: -FleetSpec, -GameServerSetSpec) +GameServerSelector)
-
AllocationOverflow specifies what labels and/or annotations to apply on Allocated GameServers
-if the desired number of the underlying GameServerSet drops below the number of Allocated GameServers
-attached to it.
CounterSelector is the filter options for a GameServer based on the count and/or available capacity.
-labels
+minCount
-map[string]string
+int64
|
(Optional)
- Labels to be applied to the MinCount is the minimum current value. Defaults to 0. |
-annotations
+maxCount
-map[string]string
+int64
|
(Optional)
- Annotations to be applied to the MaxCount is the maximum current value. Defaults to 0, which translates as max(in64). |
-(Appears on: -GameServerSpec, -GameServerStatus) -
--
CounterStatus stores the current counter values and maximum capacity
- -| Field | -Description | -
|---|---|
-count
+minAvailable
int64
|
+(Optional)
+ MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0. |
-capacity
+maxAvailable
int64
|
+(Optional)
+ MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which translates to max(int64). |
(Appears on: -GameServerSpec, -GameServerStatus) +GameServerAllocation)
-
Eviction specifies the eviction tolerance of the GameServer
+GameServerAllocationSpec is the spec for a GameServerAllocation
-safe
+multiClusterSetting
-
-EvictionSafe
+
+MultiClusterSetting
|
- 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 +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
string alias)-(Appears on: -Eviction) -
--
EvictionSafe specified whether the game server supports termination via SIGTERM
- --(Appears on: -Fleet) -
--
FleetSpec is the spec for a Fleet
- -| Field | -Description | +
+required
+
+
+GameServerSelector
+
+
+ |
+
+ 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. + |
|---|---|---|---|
-replicas
+preferred
-int32
+
+[]GameServerSelector
+
|
- Replicas are the number of GameServers that should be in this set. Defaults to 0. +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 |
||
-allocationOverflow
+priorities
-
-AllocationOverflow
+
+[]Priority
|
(Optional)
- [Stage: Beta]
-[FeatureFlag:FleetAllocationOverflow]
-Labels and/or Annotations to apply to overflowing GameServers when the number of Allocated GameServers is more
-than the desired replicas on the underlying (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most +important for sorting. The allocator will use the first priority for sorting GameServers by +available Capacity in the Selector set. Acts as a tie-breaker after sorting the game servers +by State and Strategy Packed. Impacts which GameServer is checked first. |
||
-strategy
+selectors
-
-Kubernetes apps/v1.DeploymentStrategy
+
+[]GameServerSelector
|
- Deployment strategy +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. |
||
-priorities
+metadata
-
-[]Priority
+
+MetaPatch
+
+
+ |
+
+ 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 + |
+||
+counters
+
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterAction
|
(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers -by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by -State and Strategy. Impacts scale down logic. +(Alpha, CountsAndLists feature flag) Counter actions to perform during allocation. |
||
-template
+lists
-
-GameServerTemplateSpec
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.ListAction
|
- Template the GameServer template to apply for this Fleet +(Optional) +(Alpha, CountsAndLists feature flag) List actions to perform during allocation. |
string alias)+(Appears on: +GameServerAllocationStatus) +
++
GameServerAllocationState is the Allocation state
+ +(Appears on: -Fleet, -FleetAutoscaleRequest) +GameServerAllocation)
-
FleetStatus is the status of a Fleet
+GameServerAllocationStatus is the status for an GameServerAllocation resource
-replicas
+state
+
+
+GameServerAllocationState
+
+
+ |
+
+ GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated + |
+
+gameServerName
+
+string
+
+ |
++ | +
+ports
+
+
+[]GameServerStatusPort
+
+
+ |
++ | +
+address
-int32
+string
|
- Replicas the total number of current GameServer replicas |
-readyReplicas
+addresses
-int32
+
+[]Kubernetes core/v1.NodeAddress
+
|
- ReadyReplicas are the number of Ready GameServer replicas |
-reservedReplicas
+nodeName
-int32
+string
|
- 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
+source
-int32
+string
|
- AllocatedReplicas are the number of Allocated GameServer replicas +If the allocation is from a remote cluster, Source is the endpoint of the remote agones-allocator. +Otherwise, Source is “local” |
-players
+metadata
-
-AggregatedPlayerStatus
+
+GameServerMetadata
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this Fleet |
+(Appears on: +GameServerAllocationStatus) +
++
GameServerMetadata is the metadata from the allocated game server at allocation time
+ +| Field | +Description | +
|---|---|
-counters
+labels
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
-
+map[string]string
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter -count for this Fleet. |
-lists
+annotations
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
-
+map[string]string
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Lists provides aggregated List capacityv and List values -for this Fleet. |
(Appears on: -GameServerSpec) +GameServerAllocationSpec)
-
GameServerPort defines a set of Ports that -are to be exposed via the GameServer
+GameServerSelector contains all the filter options for selecting +a GameServer for allocation.
-name
+LabelSelector
-string
+
+Kubernetes meta/v1.LabelSelector
+
|
- Name is the descriptive name of the port +
+(Members of See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
-portPolicy
+gameServerState
-
-PortPolicy
+
+GameServerState
|
- 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 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. |
-container
+players
-string
+
+PlayerSelector
+
|
(Optional)
- Container is the name of the container on which to open the port. Defaults to the game server container. - |
-
-containerPort
-
-int32
-
- |
-
- ContainerPort is the port that is being opened on the specified container’s process +[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. |
-hostPort
+counters
-int32
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.CounterSelector
+
|
- HostPort the port exposed on the host for clients to connect to +(Optional) +(Alpha, CountsAndLists feature flag) 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. |
-protocol
+lists
-
-Kubernetes core/v1.Protocol
+
+map[string]agones.dev/agones/pkg/apis/allocation/v1.ListSelector
|
- Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. +(Optional) +(Alpha, CountsAndLists feature flag) 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. |
(Appears on: -GameServerSet) +GameServerAllocationSpec)
-
GameServerSetSpec the specification for GameServerSet
+ListAction is an optional action that can be performed on a List at allocation.
-replicas
-
-int32
-
- |
-
- Replicas are the number of GameServers that should be in this set - |
-
-allocationOverflow
+addValues
-
-AllocationOverflow
-
+[]string
|
(Optional)
- [Stage: Beta]
-[FeatureFlag:FleetAllocationOverflow]
-Labels and Annotations to apply to GameServers when the number of Allocated GameServers drops below
-the desired replicas on the underlying |
-
-scheduling
-
-agones.dev/agones/pkg/apis.SchedulingStrategy
-
- |
-
- Scheduling strategy. Defaults to “Packed”. +AddValues appends values to a List’s Values array. Any duplicate values will be ignored. |
-priorities
+capacity
-
-[]Priority
-
+int64
|
(Optional)
- (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most -important for sorting. The Fleetautoscaler will use the first priority for sorting GameServers -by total Capacity in the Fleet and acts as a tie-breaker after sorting the game servers by -State and Strategy. Impacts scale down logic. - |
-
-template
-
-
-GameServerTemplateSpec
-
-
- |
-
- Template the GameServer template to apply for this GameServerSet +Capacity updates the maximum capacity of the Counter to this number. Min 0, Max 1000. |
(Appears on: -GameServerSet) +GameServerSelector)
-
GameServerSetStatus is the status of a GameServerSet
+ListSelector is the filter options for a GameServer based on List available capacity and/or the +existence of a value in a List.
-replicas
+containsValue
-int32
+string
|
- Replicas is the total number of current GameServer replicas +(Optional) +ContainsValue says to only match GameServers who has this value in the list. Defaults to “”, which is all. |
-readyReplicas
+minAvailable
-int32
+int64
|
- ReadyReplicas is the number of Ready GameServer replicas +(Optional) +MinAvailable specifies the minimum capacity (current capacity - current count) available on a GameServer. Defaults to 0. |
-reservedReplicas
+maxAvailable
-int32
+int64
|
- ReservedReplicas is the number of Reserved GameServer replicas +(Optional) +MaxAvailable specifies the maximum capacity (current capacity - current count) available on a GameServer. Defaults to 0, which is translated as max(int64). |
+(Appears on: +GameServerAllocationSpec) +
++
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+ +| Field | +Description | +
|---|---|
-allocatedReplicas
+labels
-int32
+map[string]string
|
- AllocatedReplicas is the number of Allocated GameServer replicas |
-shutdownReplicas
+annotations
-int32
+map[string]string
|
- ShutdownReplicas is the number of Shutdown GameServers replicas |
+(Appears on: +GameServerAllocationSpec) +
++
MultiClusterSetting specifies settings for multi-cluster allocation.
+ +
-players
-
-
-AggregatedPlayerStatus
-
-
- |
-
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players is the current total player capacity and count for this GameServerSet - |
+Field | +Description |
|---|---|---|---|
-counters
+enabled
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedCounterStatus
-
+bool
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters provides aggregated Counter capacity and Counter -count for this GameServerSet. |
||
-lists
+policySelector
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.AggregatedListStatus
+
+Kubernetes meta/v1.LabelSelector
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Lists provides aggregated List capacity and List values -for this GameServerSet. |
(Appears on: -GameServer, -GameServerTemplateSpec) +GameServerSelector)
-
GameServerSpec is the spec for a GameServer resource
+PlayerSelector is the filter options for a GameServer based on player counts
-container
+minAvailable
-string
+int64
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined |
-ports
+maxAvailable
-
-[]GameServerPort
-
+int64
|
- Ports are the array of ports that can be exposed via the game server |
+
Package v1 is the v1 version of the API.
+ +Resource Types: + ++
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+ +| Field | +Description | +|
|---|---|---|
-health
-
-
-Health
-
-
- |
+
- Health configures health checking +
+autoscaling.agones.dev/v1
+
|
|
-scheduling
-
-agones.dev/agones/pkg/apis.SchedulingStrategy
-
- |
-
- Scheduling strategy. Defaults to “Packed” +kind
+string
|
+FleetAutoscaler |
-sdkServer
+metadata
-
-SdkServer
+
+Kubernetes meta/v1.ObjectMeta
|
- SdkServer specifies parameters for the Agones SDK Server sidecar container +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-template
+spec
-
-Kubernetes core/v1.PodTemplateSpec
+
+FleetAutoscalerSpec
|
- Template describes the Pod that will be created for the GameServer - |
-
-players
+fleetName
-
-PlayersSpec
-
+string
|
-(Optional)
- (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
-counters
+policy
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
+
+FleetAutoscalerPolicy
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters provides the configuration for tracking of int64 values against a GameServer. -Keys must be declared at GameServer creation time. +Autoscaling policy |
-lists
+sync
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
+
+FleetAutoscalerSync
|
(Optional)
- (Alpha, 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. +Sync defines when FleetAutoscalers runs autoscaling + |
+
eviction
+status
-
-Eviction
+
+FleetAutoscalerStatus
Eviction specifies the eviction tolerance of the GameServer. Defaults to “Never”.
string alias)-(Appears on: -GameServerSelector, -GameServerStatus) -
--
GameServerState is the state for the GameServer
- -(Appears on: -GameServer) +FleetAutoscalerPolicy)
-
GameServerStatus is the status for a GameServer resource
+BufferPolicy controls the desired behavior of the buffer policy.
-state
+maxReplicas
-
-GameServerState
-
+int32
|
- GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc +MaxReplicas is the maximum amount of replicas that the fleet may have. +It must be bigger than both MinReplicas and BufferSize |
-ports
+minReplicas
-
-[]GameServerStatusPort
-
+int32
|
+ 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 |
-address
+bufferSize
-string
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
+ 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) |
+(Appears on: +FleetAutoscalerPolicy) +
++
CounterPolicy controls the desired behavior of the Counter autoscaler policy.
+ +
-addresses
-
-
-[]Kubernetes core/v1.NodeAddress
-
-
- |
-
-(Optional)
- Addresses is the array of addresses at which the GameServer can be reached; copy of Node.Status.addresses. - |
+Field | +Description |
|---|---|---|---|
-nodeName
+key
string
|
+ Key is the name of the Counter. Required field. |
||
-reservedUntil
+maxCapacity
-
-Kubernetes meta/v1.Time
-
+int64
|
+ MaxCapacity is the maximum aggregate Counter total capacity across the fleet. +MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. |
||
-players
+minCapacity
-
-PlayerStatus
-
+int64
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] +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. |
||
-counters
+bufferSize
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.CounterStatus
-
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
-(Optional)
- (Alpha, CountsAndLists feature flag) Counters and Lists provides the configuration for generic tracking features. +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. |
+(Appears on: +FleetAutoscalerSync) +
++
FixedIntervalSync controls the desired behavior of the fixed interval based sync.
+ +
-lists
-
-
-map[string]agones.dev/agones/pkg/apis/agones/v1.ListStatus
-
-
- |
--(Optional) - | +Field | +Description |
|---|---|---|---|
-eviction
+seconds
-
-Eviction
-
+int32
|
-(Optional)
- Eviction specifies the eviction tolerance of the GameServer. +Seconds defines how often we run fleet autoscaling in seconds |
(Appears on: -GameServerAllocationStatus, -GameServerStatus) +FleetAutoscaleReview)
-
GameServerStatusPort shows the port that was allocated to a -GameServer.
+FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+uid
+
+k8s.io/apimachinery/pkg/types.UID
+
+ |
+
+ 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
string
|
+ Name is the name of the Fleet being scaled |
-port
+namespace
-int32
+string
+
+ |
+
+ Namespace is the namespace associated with the request (if any). + |
+
+status
+
+
+FleetStatus
+
|
+ The Fleet’s status values |
(Appears on: -FleetSpec, -GameServerSetSpec) +FleetAutoscaleReview)
-
GameServerTemplateSpec is a template for GameServers
+FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
-metadata
+uid
-
-Kubernetes meta/v1.ObjectMeta
-
+k8s.io/apimachinery/pkg/types.UID
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+UID is an identifier for the individual request/response. +This should be copied over from the corresponding FleetAutoscaleRequest. |
||||||||||||||||||||||||
-spec
-
-
-GameServerSpec
-
-
- |
-
- - -
FleetAutoscaleReview +++ FleetAutoscaleReview is passed to the webhook with a populated Request value, +and then returned with a populated Response. + +
FleetAutoscalerPolicy +++(Appears on: +FleetAutoscalerSpec) + ++ FleetAutoscalerPolicy describes how to scale a fleet + +
[Stage:Alpha] +[FeatureFlag:CountsAndLists] +List policy config params. Present only if FleetAutoscalerPolicyType = List. |
string alias)+(Appears on: +FleetAutoscalerPolicy) +
++
FleetAutoscalerPolicyType is the policy for autoscaling +for a given Fleet
+ +(Appears on: -GameServerSpec) +FleetAutoscaler)
-
Health configures health checking on the GameServer
+FleetAutoscalerSpec is the spec for a Fleet Scaler
-disabled
-
-bool
-
- |
-
- Disabled is whether health checking is disabled or not - |
-
-periodSeconds
+fleetName
-int32
+string
|
- PeriodSeconds is the number of seconds each health ping has to occur in |
-failureThreshold
+policy
-int32
+
+FleetAutoscalerPolicy
+
|
- FailureThreshold how many failures in a row constitutes unhealthy +Autoscaling policy |
-initialDelaySeconds
+sync
-int32
+
+FleetAutoscalerSync
+
|
- InitialDelaySeconds initial delay before checking health +(Optional) +Sync defines when FleetAutoscalers runs autoscaling |
(Appears on: -GameServerSpec, -GameServerStatus) +FleetAutoscaler)
-
ListStatus stores the current list values and maximum capacity
+FleetAutoscalerStatus defines the current status of a FleetAutoscaler
-capacity
+currentReplicas
-int64
+int32
|
+ CurrentReplicas is the current number of gameserver replicas +of the fleet managed by this autoscaler, as last seen by the autoscaler |
-values
+desiredReplicas
-[]string
+int32
|
+ DesiredReplicas is the desired number of gameserver replicas +of the fleet managed by this autoscaler, as last calculated by the autoscaler |
-(Appears on: -GameServerStatus) -
--
PlayerStatus stores the current player capacity values
- -| Field | -Description | -
|---|---|
-count
+lastScaleTime
-int64
+
+Kubernetes meta/v1.Time
+
|
+(Optional)
+ lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, |
-capacity
+ableToScale
-int64
+bool
|
+ AbleToScale indicates that we can access the target fleet |
-ids
+scalingLimited
-[]string
+bool
|
+ ScalingLimited indicates that the calculated scale would be above or below the range +defined by MinReplicas and MaxReplicas, and has thus been capped. |
(Appears on: -GameServerSpec) +FleetAutoscalerSpec)
-
PlayersSpec tracks the initial player capacity
+FleetAutoscalerSync describes when to sync a fleet
-initialCapacity
+type
-int64
+
+FleetAutoscalerSyncType
+
+
+ |
+
+ Type of autoscaling sync. + |
+
+fixedInterval
+
+
+FixedIntervalSync
+
|
+(Optional)
+ FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval. |
string alias)(Appears on: -GameServerPort) +FleetAutoscalerSync)
-
PortPolicy is the port policy for the GameServer
+FleetAutoscalerSyncType is the sync strategy for a given Fleet
-(Appears on: -FleetSpec, -GameServerAllocationSpec, -GameServerSetSpec) +FleetAutoscalerPolicy)
-
Priority is a sorting option for GameServers with Counters or Lists based on the Capacity.
+ListPolicy controls the desired behavior of the List autoscaler policy.
-type
+key
string
|
- Type: Sort by a “Counter” or a “List”. +Key is the name of the List. Required field. |
-key
+maxCapacity
-string
+int64
|
- Key: The name of the Counter or List. If not found on the GameServer, has no impact. +MaxCapacity is the maximum aggregate List total capacity across the fleet. +MaxCapacity must be bigger than both MinCapacity and BufferSize. Required field. |
-order
+minCapacity
-string
+int64
|
- Order: Sort by “Ascending” or “Descending”. “Descending” a bigger Capacity is preferred. -“Ascending” would be smaller Capacity is preferred. +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
+
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
+
+ |
+
+ 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. |
(Appears on: -GameServerSpec) +FleetAutoscalerPolicy)
-
SdkServer specifies parameters for the Agones SDK Server sidecar container
+WebhookPolicy controls the desired behavior of the webhook policy. +It contains the description of the webhook autoscaler service +used to form url which is accessible inside the cluster
-logLevel
+url
-
-SdkServerLogLevel
-
+string
|
- LogLevel for SDK server (sidecar) logs. Defaults to “Info” +(Optional) +
The Please note that using 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. |
-grpcPort
+service
-int32
+
+Kubernetes admissionregistration/v1.ServiceReference
+
|
- GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections +(Optional) +
If the webhook is running within the cluster, then you should use |
-httpPort
+caBundle
-int32
+[]byte
|
- HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections +(Optional) +
|
string alias)-(Appears on: -SdkServer) -
--
SdkServerLogLevel is the log level for SDK server (sidecar) logs
-
Generated with gen-crd-api-reference-docs.