Packages:
Package v1 is the v1 version of the API.
Resource Types: --
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+GameServerAllocation is the data structure for allocating against a set of
+GameServers, defined selectors selectors
-autoscaling.agones.dev/v1
+allocation.agones.dev/v1
|
@@ -55,13 +56,13 @@ FleetAutoscaler |
+GameServerAllocation |
|||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -75,8 +76,8 @@ FleetAutoscaler
spec
-
-FleetAutoscalerSpec
+
+GameServerAllocationSpec
|
-fleetName
+multiClusterSetting
-string
+
+MultiClusterSetting
+
|
+ MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-policy
+required
-
-FleetAutoscalerPolicy
+
+GameServerSelector
|
- Autoscaling policy +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. |
-sync
+preferred
-
-FleetAutoscalerSync
+
+[]GameServerSelector
|
-(Optional)
- [Stage:Beta] -[FeatureFlag:CustomFasSyncInterval] -Sync defines when FleetAutoscalers runs autoscaling - |
-
Deprecated: use field Selectors instead. If Selectors is set, this field is ignored.
+Preferred is an ordered list of preferred GameServer selectors
+that are optional to be fulfilled, but will be searched before the required selector.
+If the first selector is not matched, the selection attempts the second selector, and so on.
+If any of the preferred selectors are matched, the required selector is not considered.
+This is useful for things like smoke testing of new game servers.
status
+selectors
-
-FleetAutoscalerStatus
+
+[]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: -FleetAutoscalerPolicy) -
--
BufferPolicy controls the desired behavior of the buffer policy.
- -| Field | -Description | -
|---|---|
-maxReplicas
+scheduling
-int32
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize +Scheduling strategy. Defaults to “Packed”. |
-minReplicas
+metadata
-int32
+
+MetaPatch
+
|
- 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 +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 + |
+
bufferSize
+status
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+
+GameServerAllocationStatus
+
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: -FleetAutoscalerSync) +GameServerAllocation)
-
FixedIntervalSync controls the desired behavior of the fixed interval based sync.
+GameServerAllocationSpec is the spec for a GameServerAllocation
-seconds
+multiClusterSetting
-int32
+
+MultiClusterSetting
+
|
- Seconds defines how often we run fleet autoscaling in seconds +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-(Appears on: -FleetAutoscaleReview) -
--
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
- -| 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. + |
|---|---|---|---|
-uid
+preferred
-k8s.io/apimachinery/pkg/types.UID
+
+[]GameServerSelector
+
|
- 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. +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 |
||
-name
+selectors
-string
+
+[]GameServerSelector
+
|
- Name is the name of the Fleet being scaled +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. |
||
-namespace
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- Namespace is the namespace associated with the request (if any). +Scheduling strategy. Defaults to “Packed”. |
||
-status
+metadata
-
-FleetStatus
+
+MetaPatch
|
- The Fleet’s status values +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 |
string alias)+(Appears on: +GameServerAllocationStatus) +
++
GameServerAllocationState is the Allocation state
+ +(Appears on: -FleetAutoscaleReview) +GameServerAllocation)
-
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
+GameServerAllocationStatus is the status for an GameServerAllocation resource
-uid
+state
-k8s.io/apimachinery/pkg/types.UID
+
+GameServerAllocationState
+
|
- UID is an identifier for the individual request/response. -This should be copied over from the corresponding FleetAutoscaleRequest. +GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated |
-scale
+gameServerName
-bool
+string
|
- Set to false if no scaling should occur to the Fleet |
-replicas
+ports
-int32
+
+[]GameServerStatusPort
+
|
- The targeted replica count |
-
FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.
- -| Field | -Description | -
|---|---|
-request
+address
-
-FleetAutoscaleRequest
-
+string
|
@@ -383,11 +370,9 @@ FleetAutoscaleReview |
-response
+nodeName
-
-FleetAutoscaleResponse
-
+string
|
@@ -395,14 +380,15 @@ FleetAutoscaleReview |
(Appears on: -FleetAutoscalerSpec) +GameServerAllocationSpec)
-
FleetAutoscalerPolicy describes how to scale a fleet
+GameServerSelector contains all the filter options for selecting +a GameServer for allocation.
-type
+LabelSelector
-
-FleetAutoscalerPolicyType
+
+Kubernetes meta/v1.LabelSelector
|
- Type of autoscaling policy. +See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
-buffer
+gameServerState
-
-BufferPolicy
+
+GameServerState
|
(Optional)
- Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. +[Stage:Beta] +[FeatureFlag:StateAllocationFilter] +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. |
-webhook
+players
-
-WebhookPolicy
+
+PlayerSelector
|
(Optional)
- Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. +[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. |
string alias)-(Appears on: -FleetAutoscalerPolicy) -
--
FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet
- -(Appears on: -FleetAutoscaler) +GameServerAllocationSpec)
-
FleetAutoscalerSpec is the spec for a Fleet Scaler
+MetaPatch is the metadata used to patch the GameServer metadata on allocation
-fleetName
-
-string
-
- |
-- | -
-policy
+labels
-
-FleetAutoscalerPolicy
-
+map[string]string
|
- Autoscaling policy |
-sync
+annotations
-
-FleetAutoscalerSync
-
+map[string]string
|
-(Optional)
- [Stage:Beta] -[FeatureFlag:CustomFasSyncInterval] -Sync defines when FleetAutoscalers runs autoscaling |
(Appears on: -FleetAutoscaler) +GameServerAllocationSpec)
-
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+MultiClusterSetting specifies settings for multi-cluster allocation.
-currentReplicas
-
-int32
-
- |
-
- CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler - |
-
-desiredReplicas
-
-int32
-
- |
-
- DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler - |
-
-lastScaleTime
-
-
-Kubernetes meta/v1.Time
-
-
- |
-
-(Optional)
- lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, - |
-
-ableToScale
+enabled
bool
|
- AbleToScale indicates that we can access the target fleet |
-scalingLimited
+policySelector
-bool
+
+Kubernetes meta/v1.LabelSelector
+
|
- 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: -FleetAutoscalerSpec) +GameServerSelector)
-
FleetAutoscalerSync describes when to sync a fleet
+PlayerSelector is the filter options for a GameServer based on player counts
-type
+minAvailable
-
-FleetAutoscalerSyncType
-
+int64
|
- Type of autoscaling sync. |
-fixedInterval
+maxAvailable
-
-FixedIntervalSync
-
+int64
|
-(Optional)
- FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval. |
string alias)-(Appears on: -FleetAutoscalerSync) -
+-
FleetAutoscalerSyncType is the sync strategy for a given Fleet
+Package v1 is the v1 version of the API.
--(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
+FleetAutoscaler is the data structure for a FleetAutoscaler resource
-url
-
-string
-
+apiVersion
+string |
+
+
+autoscaling.agones.dev/v1
+
|
+
|
-(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. +kind
+string
|
+FleetAutoscaler |
-service
+metadata
-
-Kubernetes admissionregistration/v1.ServiceReference
+
+Kubernetes meta/v1.ObjectMeta
|
-(Optional)
-
If the webhook is running within the cluster, then you should use metadata field.
|
-caBundle
+spec
-[]byte
+
+FleetAutoscalerSpec
+
|
-(Optional)
-
|
-
-
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
-
+fleetName
+
+string
+
|
-||||
-kind
-string
|
-GameServerAllocationPolicy |
||||
-metadata
+policy
-
-Kubernetes meta/v1.ObjectMeta
+
+FleetAutoscalerPolicy
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Autoscaling policy |
||||
-spec
+sync
-
-GameServerAllocationPolicySpec
+
+FleetAutoscalerSync
|
- - -
|
||||
-connectionInfo
+status
-
-ClusterConnectionInfo
+
+FleetAutoscalerStatus
|
(Appears on: -GameServerAllocationPolicySpec) +FleetAutoscalerPolicy)
-
ClusterConnectionInfo defines the connection information for a cluster
+BufferPolicy controls the desired behavior of the buffer policy.
-clusterName
+maxReplicas
-string
+int32
|
- Optional: the name of the targeted cluster +MaxReplicas is the maximum amount of replicas that the fleet may have. +It must be bigger than both MinReplicas and BufferSize |
-allocationEndpoints
+minReplicas
-[]string
+int32
|
- 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 +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 |
-secretName
+bufferSize
-string
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
- The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster +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: +FleetAutoscalerSync) +
++
FixedIntervalSync controls the desired behavior of the fixed interval based sync.
+ +
-namespace
-
-string
-
- |
-
- The cluster namespace from which to allocate gameservers - |
+Field | +Description |
|---|---|---|---|
-serverCa
+seconds
-[]byte
+int32
|
- The PEM encoded server CA, used by the allocator client to authenticate the remote server. +Seconds defines how often we run fleet autoscaling in seconds |
-
ConnectionInfoIterator an iterator on ClusterConnectionInfo
+(Appears on: +FleetAutoscaleReview) + ++
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
-currPriority
+uid
-int
+k8s.io/apimachinery/pkg/types.UID
|
- currPriority Current priority index from the orderedPriorities +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. |
-orderedPriorities
+name
-[]int32
+string
|
- orderedPriorities list of ordered priorities +Name is the name of the Fleet being scaled |
-priorityToCluster
+namespace
-map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
+string
|
- priorityToCluster Map of priority to cluster-policies map +Namespace is the namespace associated with the request (if any). |
-clusterBlackList
+status
-map[string]bool
+
+FleetStatus
+
|
- clusterBlackList the cluster blacklist for the clusters that has already returned +The Fleet’s status values |
(Appears on: -GameServerAllocationPolicy) +FleetAutoscaleReview)
-
GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
+FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
-priority
+uid
-int32
+k8s.io/apimachinery/pkg/types.UID
|
+ UID is an identifier for the individual request/response. +This should be copied over from the corresponding FleetAutoscaleRequest. |
-weight
+scale
-int
+bool
|
+ Set to false if no scaling should occur to the Fleet |
-connectionInfo
+replicas
-
-ClusterConnectionInfo
-
+int32
|
+ The targeted replica count |
-
Package v1 is the v1 version of the API.
- -Resource Types: --
Fleet is the data structure for a Fleet resource
+FleetAutoscaleReview is passed to the webhook with a populated Request value, +and then returned with a populated Response.
-apiVersion
-string |
+
-
-agones.dev/v1
-
|
-kind
-string
- |
-Fleet |
-
-metadata
+response
-
-Kubernetes meta/v1.ObjectMeta
+
+FleetAutoscaleResponse
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
|
-spec
-
-
-FleetSpec
-
-
- |
-
- - + |
+(Appears on: +FleetAutoscalerSpec) +
++
FleetAutoscalerPolicy describes how to scale a fleet
+
-replicas
-
-int32
-
- |
-
- Replicas are the number of GameServers that should be in this set. Defaults to 0. - |
+Field | +Description |
|---|---|---|---|
-strategy
+type
-
-Kubernetes apps/v1.DeploymentStrategy
+
+FleetAutoscalerPolicyType
|
- Deployment strategy - |
-||
-scheduling
-
-agones.dev/agones/pkg/apis.SchedulingStrategy
-
- |
-
- Scheduling strategy. Defaults to “Packed”. +Type of autoscaling policy. |
||
-template
+buffer
-
-GameServerTemplateSpec
+
+BufferPolicy
|
- Template the GameServer template to apply for this Fleet - |
-
Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer.
status
+webhook
-
-FleetStatus
+
+WebhookPolicy
Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook.
string alias)+(Appears on: +FleetAutoscalerPolicy) +
++
FleetAutoscalerPolicyType is the policy for autoscaling +for a given Fleet
+ +-
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.
+
FleetAutoscalerSpec is the spec for a Fleet Scaler
-apiVersion
-string |
-
-
-agones.dev/v1
-
+fleetName
+
+string
+
|
-
-kind
-string
|
-GameServer |
-metadata
+policy
-
-Kubernetes meta/v1.ObjectMeta
+
+FleetAutoscalerPolicy
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Autoscaling policy |
-spec
+sync
-
-GameServerSpec
+
+FleetAutoscalerSync
|
- - +(Optional) + [Stage:Beta] +[FeatureFlag:CustomFasSyncInterval] +Sync defines when FleetAutoscalers runs autoscaling + |
+
+(Appears on: +FleetAutoscaler) +
++
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+| Field | +Description | +
|---|---|
-container
+currentReplicas
-string
+int32
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined +CurrentReplicas is the current number of gameserver replicas +of the fleet managed by this autoscaler, as last seen by the autoscaler |
-ports
+desiredReplicas
-
-[]GameServerPort
-
+int32
|
- Ports are the array of ports that can be exposed via the game server +DesiredReplicas is the desired number of gameserver replicas +of the fleet managed by this autoscaler, as last calculated by the autoscaler |
-health
+lastScaleTime
-
-Health
+
+Kubernetes meta/v1.Time
|
- Health configures health checking +(Optional) +lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, |
-scheduling
+ableToScale
-agones.dev/agones/pkg/apis.SchedulingStrategy
+bool
|
- Scheduling strategy. Defaults to “Packed” +AbleToScale indicates that we can access the target fleet |
-sdkServer
+scalingLimited
-
-SdkServer
-
+bool
|
- SdkServer specifies parameters for the Agones SDK Server sidecar container +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: +FleetAutoscalerSpec) +
++
FleetAutoscalerSync describes when to sync a fleet
+ +
-template
-
-
-Kubernetes core/v1.PodTemplateSpec
-
-
- |
-
- Template describes the Pod that will be created for the GameServer - |
+Field | +Description |
|---|---|---|---|
-players
+type
-
-PlayersSpec
+
+FleetAutoscalerSyncType
|
-(Optional)
- (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. - |
-
Type of autoscaling sync.
status
+fixedInterval
-
-GameServerStatus
+
+FixedIntervalSync
FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval.
string alias)-
GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Deployments and ReplicaSets
+(Appears on: +FleetAutoscalerSync) + ++
FleetAutoscalerSyncType is the sync strategy for a given Fleet
+ ++(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
+
+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
+
+
+Kubernetes admissionregistration/v1.ServiceReference
+
+
+ |
+
+(Optional)
+
If the webhook is running within the cluster, then you should use |
+
+caBundle
+
+[]byte
+
+ |
+
+(Optional)
+
|
+
+
Package v1 is the v1 version of the API.
+ +Resource Types: + ++
GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
-agones.dev/v1
+multicluster.agones.dev/v1
|
@@ -1360,13 +1325,13 @@ GameServerSet |
+GameServerAllocationPolicy |
|||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1380,8 +1345,8 @@ GameServerSet
spec
-
-GameServerSetSpec
+
+GameServerAllocationPolicySpec
|
-replicas
+priority
int32
|
- Replicas are the number of GameServers that should be in this set |
-scheduling
+weight
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int
|
- Scheduling strategy. Defaults to “Packed”. |
-template
+connectionInfo
-
-GameServerTemplateSpec
+
+ClusterConnectionInfo
|
- Template the GameServer template to apply for this GameServerSet |
status
-
-
-GameServerSetStatus
-
-
-(Appears on: -FleetStatus, -GameServerSetStatus) +GameServerAllocationPolicySpec)
-
AggregatedPlayerStatus stores total player tracking values
+ClusterConnectionInfo defines the connection information for a cluster
-count
+clusterName
-int64
+string
|
+ Optional: the name of the targeted cluster |
-capacity
+allocationEndpoints
-int64
+[]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 + |
+
+secretName
+
+string
+
+ |
+
+ The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster + |
+
+namespace
+
+string
+
+ |
+
+ The cluster namespace from which to allocate gameservers + |
+
+serverCa
+
+[]byte
|
+ The PEM encoded server CA, used by the allocator client to authenticate the remote server. |
-(Appears on: -Fleet) -
--
FleetSpec is the spec for a Fleet
+ConnectionInfoIterator an iterator on ClusterConnectionInfo
-replicas
+currPriority
-int32
+int
|
- Replicas are the number of GameServers that should be in this set. Defaults to 0. +currPriority Current priority index from the orderedPriorities |
-strategy
+orderedPriorities
-
-Kubernetes apps/v1.DeploymentStrategy
-
+[]int32
|
- Deployment strategy +orderedPriorities list of ordered priorities |
-scheduling
+priorityToCluster
-agones.dev/agones/pkg/apis.SchedulingStrategy
+map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
|
- Scheduling strategy. Defaults to “Packed”. +priorityToCluster Map of priority to cluster-policies map |
-template
+clusterBlackList
-
-GameServerTemplateSpec
-
+map[string]bool
|
- Template the GameServer template to apply for this Fleet +clusterBlackList the cluster blacklist for the clusters that has already returned |
(Appears on: -Fleet, -FleetAutoscaleRequest) +GameServerAllocationPolicy)
-
FleetStatus is the status of a Fleet
+GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
-replicas
+priority
int32
|
- Replicas the total number of current GameServer replicas |
-readyReplicas
+weight
-int32
+int
|
- ReadyReplicas are the number of Ready GameServer replicas |
-reservedReplicas
+connectionInfo
-int32
+
+ClusterConnectionInfo
+
|
- 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
-
-int32
-
- |
-
- AllocatedReplicas are the number of Allocated GameServer replicas - |
-
-players
-
-
-AggregatedPlayerStatus
-
-
- |
-
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this Fleet |
-(Appears on: -GameServerSpec) +
Package v1 is the v1 version of the API.
+Resource Types: +-
GameServerPort defines a set of Ports that -are to be exposed via the GameServer
+Fleet is the data structure for a Fleet resource
-name
-
-string
-
- |
+
- Name is the descriptive name of the port +
+agones.dev/v1
+
|
|
-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 kind
+string
|
+Fleet |
-container
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(Optional)
- Container is the name of the container on which to open the port. Defaults to the game server container. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-containerPort
+spec
-int32
+
+FleetSpec
+
|
- ContainerPort is the port that is being opened on the specified container’s process - |
-
-hostPort
+replicas
int32
|
- HostPort the port exposed on the host for clients to connect to +Replicas are the number of GameServers that should be in this set. Defaults to 0. |
-protocol
+strategy
-
-Kubernetes core/v1.Protocol
+
+Kubernetes apps/v1.DeploymentStrategy
|
- Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. +Deployment strategy |
-(Appears on: -GameServerSet) -
--
GameServerSetSpec the specification for GameServerSet
- -| Field | -Description | -
|---|---|
-replicas
+scheduling
-int32
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- Replicas are the number of GameServers that should be in this set +Scheduling strategy. Defaults to “Packed”. |
-scheduling
+template
-agones.dev/agones/pkg/apis.SchedulingStrategy
+
+GameServerTemplateSpec
+
|
- Scheduling strategy. Defaults to “Packed”. +Template the GameServer template to apply for this Fleet + |
+
template
+status
-
-GameServerTemplateSpec
+
+FleetStatus
Template the GameServer template to apply for this GameServerSet
-(Appears on: -GameServerSet) -
--
GameServerSetStatus is the status of a GameServerSet
+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.
-replicas
-
-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 +
+agones.dev/v1
+
|
|
-allocatedReplicas
-
-int32
-
- |
-
- AllocatedReplicas is the number of Allocated GameServer replicas +kind
+string
|
+GameServer |
-shutdownReplicas
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
- ShutdownReplicas is the number of Shutdown GameServers replicas +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-players
+spec
-
-AggregatedPlayerStatus
+
+GameServerSpec
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players is the current total player capacity and count for this GameServerSet - |
-
-(Appears on: -GameServer, -GameServerTemplateSpec) -
--
GameServerSpec is the spec for a GameServer resource
- +| Field | -Description | -
|---|---|
container
@@ -1952,7 +1839,7 @@ GameServerSpec
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -1975,26 +1862,29 @@ GameServerSpec(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
status
+
+
+GameServerStatus
+
+
+string alias)-(Appears on: -GameServerSelector, -GameServerStatus) -
--
GameServerState is the state for the GameServer
- --(Appears on: -GameServer) -
--
GameServerStatus is the status for a GameServer resource
+GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Deployments and ReplicaSets
-state
+apiVersion
+string |
+
+
+agones.dev/v1
+
+ |
+
+kind
+string
+ |
+GameServerSet |
+
+metadata
-
-GameServerState
+
+Kubernetes meta/v1.ObjectMeta
|
- GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-ports
+spec
-
-[]GameServerStatusPort
+
+GameServerSetSpec
|
- | -
-address
+replicas
-string
+int32
|
+ Replicas are the number of GameServers that should be in this set |
-nodeName
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-reservedUntil
+template
-
-Kubernetes meta/v1.Time
+
+GameServerTemplateSpec
|
+ Template the GameServer template to apply for this GameServerSet + |
+
players
+status
-
-PlayerStatus
+
+GameServerSetStatus
[Stage:Alpha] -[FeatureFlag:PlayerTracking]
(Appears on: -GameServerAllocationStatus, -GameServerStatus) +FleetStatus, +GameServerSetStatus)
-
GameServerStatusPort shows the port that was allocated to a -GameServer.
+AggregatedPlayerStatus stores total player tracking values
-name
+count
-string
+int64
|
@@ -2109,9 +2020,9 @@ GameServerStatusPort |
-port
+capacity
-int32
+int64
|
@@ -2119,15 +2030,14 @@ GameServerStatusPort |
(Appears on: -FleetSpec, -GameServerSetSpec) +Fleet)
-
GameServerTemplateSpec is a template for GameServers
+FleetSpec is the spec for a Fleet
-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
+strategy
-
-GameServerSpec
+
+Kubernetes apps/v1.DeploymentStrategy
|
- - -
FleetStatus +++(Appears on: +Fleet, +FleetAutoscaleRequest) + ++ FleetStatus is the status of a Fleet + +
[Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players are the current total player capacity and count for this Fleet |
(Appears on: GameServerSpec)
-
Health configures health checking on the GameServer
+GameServerPort defines a set of Ports that +are to be exposed via the GameServer
-disabled
+name
-bool
+string
|
- Disabled is whether health checking is disabled or not +Name is the descriptive name of the port |
-periodSeconds
+portPolicy
-int32
+
+PortPolicy
+
|
- PeriodSeconds is the number of seconds each health ping has to occur in +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 |
-failureThreshold
+container
-int32
+string
|
- FailureThreshold how many failures in a row constitutes unhealthy +(Optional) +Container is the name of the container on which to open the port. Defaults to the game server container. |
-initialDelaySeconds
+containerPort
int32
|
- InitialDelaySeconds initial delay before checking health +ContainerPort is the port that is being opened on the specified container’s process |
-(Appears on: -GameServerStatus) -
--
PlayerStatus stores the current player capacity values
- -| Field | -Description | -
|---|---|
-count
-
-int64
-
- |
-- | -
-capacity
+hostPort
-int64
+int32
|
+ HostPort the port exposed on the host for clients to connect to |
-ids
+protocol
-[]string
+
+Kubernetes core/v1.Protocol
+
|
+ Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. |
(Appears on: -GameServerSpec) +GameServerSet)
-
PlayersSpec tracks the initial player capacity
+GameServerSetSpec the specification for GameServerSet
-initialCapacity
+replicas
-int64
+int32
|
+ Replicas are the number of GameServers that should be in this set + |
+
+scheduling
+
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed”. + |
+
+template
+
+
+GameServerTemplateSpec
+
+
+ |
+
+ Template the GameServer template to apply for this GameServerSet |
string alias)-(Appears on: -GameServerPort) -
--
PortPolicy is the port policy for the GameServer
- -(Appears on: -GameServerSpec) +GameServerSet)
-
SdkServer specifies parameters for the Agones SDK Server sidecar container
+GameServerSetStatus is the status of a GameServerSet
-logLevel
+replicas
-
-SdkServerLogLevel
-
+int32
|
- LogLevel for SDK server (sidecar) logs. Defaults to “Info” +Replicas is the total number of current GameServer replicas |
-grpcPort
+readyReplicas
int32
|
- GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections +ReadyReplicas is the number of Ready GameServer replicas |
-httpPort
+reservedReplicas
int32
|
- HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections +ReservedReplicas is the number of Reserved GameServer replicas |
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
| Field | -Description | -
|---|---|
-apiVersion
-string |
-
-
-allocation.agones.dev/v1
-
+allocatedReplicas
+
+int32
+
|
-
-kind
-string
+AllocatedReplicas is the number of Allocated GameServer replicas |
-GameServerAllocation |
-metadata
+shutdownReplicas
-
-Kubernetes meta/v1.ObjectMeta
-
+int32
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ShutdownReplicas is the number of Shutdown GameServers replicas |
-spec
+players
-
-GameServerAllocationSpec
+
+AggregatedPlayerStatus
|
- - +(Optional) + [Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players is the current total player capacity and count for this GameServerSet + |
+
+(Appears on: +GameServer, +GameServerTemplateSpec) +
++
GameServerSpec is the spec for a GameServer resource
+| Field | +Description | +
|---|---|
-multiClusterSetting
+container
-
-MultiClusterSetting
-
+string
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-required
+ports
-
-GameServerSelector
+
+[]GameServerPort
|
- 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. +Ports are the array of ports that can be exposed via the game server |
-preferred
+health
-
-[]GameServerSelector
+
+Health
|
- 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 Health configures health checking |
-selectors
+scheduling
-
-[]GameServerSelector
-
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- Ordered list of GameServer label selectors. -If the first selector is not matched, the selection attempts the second selector, and so on. -This is useful for things like smoke testing of new game servers. -Note: This field can only be set if neither Required or Preferred is set. +Scheduling strategy. Defaults to “Packed” |
-scheduling
+sdkServer
-agones.dev/agones/pkg/apis.SchedulingStrategy
+
+SdkServer
+
|
- Scheduling strategy. Defaults to “Packed”. +SdkServer specifies parameters for the Agones SDK Server sidecar container |
-metadata
+template
-
-MetaPatch
+
+Kubernetes core/v1.PodTemplateSpec
|
- 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 - |
-
Template describes the Pod that will be created for the GameServer
status
+players
-
-GameServerAllocationStatus
+
+PlayersSpec
(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features.
string alias)(Appears on: -GameServerAllocation) +GameServerSelector, +GameServerStatus)
-
GameServerAllocationSpec is the spec for a GameServerAllocation
+GameServerState is the state for the GameServer
+ ++(Appears on: +GameServer) +
++
GameServerStatus is the status for a GameServer resource
-multiClusterSetting
+state
-
-MultiClusterSetting
+
+GameServerState
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-required
+ports
-
-GameServerSelector
+
+[]GameServerStatusPort
|
- 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
+address
-
-[]GameServerSelector
-
+string
|
- 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 |
-selectors
+nodeName
-
-[]GameServerSelector
-
+string
|
- 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
+reservedUntil
-agones.dev/agones/pkg/apis.SchedulingStrategy
+
+Kubernetes meta/v1.Time
+
|
- Scheduling strategy. Defaults to “Packed”. |
-metadata
+players
-
-MetaPatch
+
+PlayerStatus
|
- 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) +[Stage:Alpha] +[FeatureFlag:PlayerTracking] |
string alias)(Appears on: -GameServerAllocationStatus) +GameServerAllocationStatus, +GameServerStatus)
-
GameServerAllocationState is the Allocation state
+GameServerStatusPort shows the port that was allocated to a +GameServer.
-| Field | +Description | +
|---|---|
+name
+
+string
+
+ |
++ | +
+port
+
+int32
+
+ |
++ | +
(Appears on: -GameServerAllocation) +FleetSpec, +GameServerSetSpec)
-
GameServerAllocationStatus is the status for an GameServerAllocation resource
+GameServerTemplateSpec is a template for GameServers
-state
+metadata
-
-GameServerAllocationState
+
+Kubernetes meta/v1.ObjectMeta
|
- GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||||||||
-gameServerName
+spec
+
+
+GameServerSpec
+
+
+ |
+
+ + +
GameServerSelector ---(Appears on: -GameServerAllocationSpec) - -- GameServerSelector contains all the filter options for selecting -a GameServer for allocation. - -
|
(Appears on: -GameServerAllocationSpec) +GameServerSpec)
-
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+Health configures health checking on the GameServer
-labels
+disabled
-map[string]string
+bool
|
+ Disabled is whether health checking is disabled or not |
-annotations
+periodSeconds
-map[string]string
+int32
|
+ PeriodSeconds is the number of seconds each health ping has to occur in |
-(Appears on: -GameServerAllocationSpec) -
--
MultiClusterSetting specifies settings for multi-cluster allocation.
- -| Field | -Description | -
|---|---|
-enabled
+failureThreshold
-bool
+int32
|
+ FailureThreshold how many failures in a row constitutes unhealthy |
-policySelector
+initialDelaySeconds
-
-Kubernetes meta/v1.LabelSelector
-
+int32
|
+ InitialDelaySeconds initial delay before checking health |
(Appears on: -GameServerSelector) +GameServerStatus)
-
PlayerSelector is the filter options for a GameServer based on player counts
+PlayerStatus stores the current player capacity values
-minAvailable
+count
int64
@@ -3010,7 +2899,46 @@ PlayerSelector | |
-maxAvailable
+capacity
+
+int64
+
+ |
++ | +
+ids
+
+[]string
+
+ |
++ | +
+(Appears on: +GameServerSpec) +
++
PlayersSpec tracks the initial player capacity
+ +| Field | +Description | +
|---|---|
+initialCapacity
int64
@@ -3020,18 +2948,87 @@ PlayerSelector |
string alias)+(Appears on: +GameServerPort) +
++
PortPolicy is the port policy for the GameServer
+ ++(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
FleetAutoscaler is the data structure for a FleetAutoscaler resource
-allocation.agones.dev/v1
+autoscaling.agones.dev/v1
|
@@ -3078,7 +3077,7 @@ GameServerAllocation |
+FleetAutoscaler |
|||||
@@ -3098,8 +3097,8 @@ GameServerAllocation
spec
-
-GameServerAllocationSpec
+
+FleetAutoscalerSpec
|
-multiClusterSetting
+fleetName
-
-MultiClusterSetting
-
+string
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. |
-required
+policy
-
-GameServerSelector
+
+FleetAutoscalerPolicy
|
- 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. +Autoscaling policy |
-preferred
+sync
-
-[]GameServerSelector
+
+FleetAutoscalerSync
|
- 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 [Stage:Beta] +[FeatureFlag:CustomFasSyncInterval] +Sync defines when FleetAutoscalers runs autoscaling + |
+
selectors
+status
-
-[]GameServerSelector
+
+FleetAutoscalerStatus
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: +FleetAutoscalerPolicy) +
++
BufferPolicy controls the desired behavior of the buffer policy.
+ +| Field | +Description | +
|---|---|
-scheduling
+maxReplicas
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int32
|
- Scheduling strategy. Defaults to “Packed”. +MaxReplicas is the maximum amount of replicas that the fleet may have. +It must be bigger than both MinReplicas and BufferSize |
-metadata
+minReplicas
-
-MetaPatch
-
+int32
|
- 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 - |
-
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
status
+bufferSize
-
-GameServerAllocationStatus
-
+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: -GameServerAllocation) +FleetAutoscalerSync)
-
GameServerAllocationSpec is the spec for a GameServerAllocation
+FixedIntervalSync controls the desired behavior of the fixed interval based sync.
-multiClusterSetting
+seconds
-
-MultiClusterSetting
-
+int32
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +Seconds defines how often we run fleet autoscaling in seconds |
+(Appears on: +FleetAutoscaleReview) +
++
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+ +
-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. - |
+Field | +Description |
|---|---|---|---|
-preferred
+uid
-
-[]GameServerSelector
-
+k8s.io/apimachinery/pkg/types.UID
|
- 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 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. |
||
-selectors
+name
-
-[]GameServerSelector
-
+string
|
- 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. +Name is the name of the Fleet being scaled |
||
-scheduling
+namespace
-agones.dev/agones/pkg/apis.SchedulingStrategy
+string
|
- Scheduling strategy. Defaults to “Packed”. +Namespace is the namespace associated with the request (if any). |
||
-metadata
+status
-
-MetaPatch
+
+FleetStatus
|
- 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 Fleet’s status values |
string alias)-(Appears on: -GameServerAllocationStatus) -
--
GameServerAllocationState is the Allocation state
- -(Appears on: -GameServerAllocation) +FleetAutoscaleReview)
-
GameServerAllocationStatus is the status for an GameServerAllocation resource
+FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
-state
+uid
-
-GameServerAllocationState
-
+k8s.io/apimachinery/pkg/types.UID
|
- GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated +UID is an identifier for the individual request/response. +This should be copied over from the corresponding FleetAutoscaleRequest. |
-gameServerName
+scale
-string
+bool
|
+ Set to false if no scaling should occur to the Fleet |
-ports
+replicas
-
-[]GameServerStatusPort
-
+int32
|
+ The targeted replica count |
+
FleetAutoscaleReview is passed to the webhook with a populated Request value, +and then returned with a populated Response.
+ +| Field | +Description | +
|---|---|
-address
+request
-string
+
+FleetAutoscaleRequest
+
|
@@ -3392,9 +3405,11 @@ GameServerAllocatio |
-nodeName
+response
-string
+
+FleetAutoscaleResponse
+
|
@@ -3402,15 +3417,14 @@ GameServerAllocatio |
(Appears on: -GameServerAllocationSpec) +FleetAutoscalerSpec)
-
GameServerSelector contains all the filter options for selecting -a GameServer for allocation.
+FleetAutoscalerPolicy describes how to scale a fleet
-LabelSelector
+type
-
-Kubernetes meta/v1.LabelSelector
+
+FleetAutoscalerPolicyType
|
- See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +Type of autoscaling policy. |
-gameServerState
+buffer
-
-GameServerState
+
+BufferPolicy
|
(Optional)
- [Stage:Beta] -[FeatureFlag:StateAllocationFilter] -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. +Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. |
-players
+webhook
-
-PlayerSelector
+
+WebhookPolicy
|
(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. +Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. |
string alias)+(Appears on: +FleetAutoscalerPolicy) +
++
FleetAutoscalerPolicyType is the policy for autoscaling +for a given Fleet
+ +(Appears on: -GameServerAllocationSpec) +FleetAutoscaler)
-
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+FleetAutoscalerSpec is the spec for a Fleet Scaler
-labels
+fleetName
-map[string]string
+string
|
@@ -3499,24 +3516,43 @@ MetaPatch |
-annotations
+policy
-map[string]string
+
+FleetAutoscalerPolicy
+
+
+ |
+
+ Autoscaling policy + |
+
+sync
+
+
+FleetAutoscalerSync
+
|
+(Optional)
+ [Stage:Beta] +[FeatureFlag:CustomFasSyncInterval] +Sync defines when FleetAutoscalers runs autoscaling |
(Appears on: -GameServerAllocationSpec) +FleetAutoscaler)
-
MultiClusterSetting specifies settings for multi-cluster allocation.
+FleetAutoscalerStatus defines the current status of a FleetAutoscaler
-enabled
+currentReplicas
-bool
+int32
|
+ CurrentReplicas is the current number of gameserver replicas +of the fleet managed by this autoscaler, as last seen by the autoscaler |
-policySelector
+desiredReplicas
-
-Kubernetes meta/v1.LabelSelector
-
+int32
|
+ DesiredReplicas is the desired number of gameserver replicas +of the fleet managed by this autoscaler, as last calculated by the autoscaler |
-(Appears on: -GameServerSelector) -
--
PlayerSelector is the filter options for a GameServer based on player counts
+lastScaleTime
+
+
+Kubernetes meta/v1.Time
+
+
+lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet,
+ableToScale
+
+bool
+
+AbleToScale indicates that we can access the target fleet
+scalingLimited
+
+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: +FleetAutoscalerSpec) +
++
FleetAutoscalerSync describes when to sync a fleet
-minAvailable
+type
-int64
+
+FleetAutoscalerSyncType
+
|
+ Type of autoscaling sync. |
-maxAvailable
+fixedInterval
-int64
+
+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: +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
+
+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
+
+
+Kubernetes admissionregistration/v1.ServiceReference
+
+
+ |
+
+(Optional)
+
If the webhook is running within the cluster, then you should use |
+
+caBundle
+
+[]byte
|
+(Optional)
+
|
Package v1 is the v1 version of the API.
Resource Types: --
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
-autoscaling.agones.dev/v1
+multicluster.agones.dev/v1
|
@@ -3626,7 +3798,7 @@ FleetAutoscaler |
+GameServerAllocationPolicy |
|||||
@@ -3646,8 +3818,8 @@ FleetAutoscaler
spec
-
-FleetAutoscalerSpec
+
+GameServerAllocationPolicySpec
|
-fleetName
+priority
-string
+int32
|
@@ -3667,58 +3839,39 @@ FleetAutoscaler |
-policy
+weight
-
-FleetAutoscalerPolicy
-
+int
|
- Autoscaling policy |
-sync
+connectionInfo
-
-FleetAutoscalerSync
+
+ClusterConnectionInfo
|
-(Optional)
- [Stage:Beta] -[FeatureFlag:CustomFasSyncInterval] -Sync defines when FleetAutoscalers runs autoscaling |
status
-
-
-FleetAutoscalerStatus
-
-
-(Appears on: -FleetAutoscalerPolicy) +GameServerAllocationPolicySpec)
-
BufferPolicy controls the desired behavior of the buffer policy.
+ClusterConnectionInfo defines the connection information for a cluster
-maxReplicas
+clusterName
-int32
+string
|
- MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize +Optional: the name of the targeted cluster |
-minReplicas
+allocationEndpoints
-int32
+[]string
|
- 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 +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 |
-bufferSize
+secretName
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+string
|
- 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) +The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster |
-(Appears on: -FleetAutoscalerSync) -
--
FixedIntervalSync controls the desired behavior of the fixed interval based sync.
- -| Field | -Description | -
+namespace
+
+string
+
+ |
+
+ The cluster namespace from which to allocate gameservers + |
+
|---|---|
-seconds
+serverCa
-int32
+[]byte
|
- Seconds defines how often we run fleet autoscaling in seconds +The PEM encoded server CA, used by the allocator client to authenticate the remote server. |
-(Appears on: -FleetAutoscaleReview) -
--
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+ConnectionInfoIterator an iterator on ClusterConnectionInfo
-uid
+currPriority
-k8s.io/apimachinery/pkg/types.UID
+int
|
- 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. +currPriority Current priority index from the orderedPriorities |
-name
+orderedPriorities
-string
+[]int32
|
- Name is the name of the Fleet being scaled +orderedPriorities list of ordered priorities |
-namespace
+priorityToCluster
-string
+map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
|
- Namespace is the namespace associated with the request (if any). +priorityToCluster Map of priority to cluster-policies map |
-status
+clusterBlackList
-
-FleetStatus
-
+map[string]bool
|
- The Fleet’s status values +clusterBlackList the cluster blacklist for the clusters that has already returned |
(Appears on: -FleetAutoscaleReview) +GameServerAllocationPolicy)
-
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
+GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
-uid
+priority
-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. |
-scale
+weight
-bool
+int
|
- Set to false if no scaling should occur to the Fleet |
-replicas
+connectionInfo
-int32
+
+ClusterConnectionInfo
+
|
- The targeted replica count |
+
Package v1 is the v1 version of the API.
+ +Resource Types: +-
FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.
+Fleet is the data structure for a Fleet resource
-request
-
-
-FleetAutoscaleRequest
-
-
+apiVersion
+string |
+
+
+agones.dev/v1
+
|
+
+kind
+string
|
+Fleet |
-response
+metadata
-
-FleetAutoscaleResponse
+
+Kubernetes meta/v1.ObjectMeta
|
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
-(Appears on: -FleetAutoscalerSpec) -
--
FleetAutoscalerPolicy describes how to scale a fleet
- -| Field | -Description | -
|---|---|
-type
+spec
-
-FleetAutoscalerPolicyType
+
+FleetSpec
|
- Type of autoscaling policy. - |
-
-buffer
+replicas
-
-BufferPolicy
-
+int32
|
-(Optional)
- Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. +Replicas are the number of GameServers that should be in this set. Defaults to 0. |
-webhook
+strategy
-
-WebhookPolicy
+
+Kubernetes apps/v1.DeploymentStrategy
|
-(Optional)
- Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. +Deployment strategy |
string alias)-(Appears on: -FleetAutoscalerPolicy) -
--
FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet
- --(Appears on: -FleetAutoscaler) -
--
FleetAutoscalerSpec is the spec for a Fleet Scaler
- -| Field | -Description | -
|---|---|
-fleetName
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-policy
+template
-
-FleetAutoscalerPolicy
+
+GameServerTemplateSpec
|
- Autoscaling policy +Template the GameServer template to apply for this Fleet + |
+
sync
+status
-
-FleetAutoscalerSync
+
+FleetStatus
[Stage:Beta] -[FeatureFlag:CustomFasSyncInterval] -Sync defines when FleetAutoscalers runs autoscaling
-(Appears on: -FleetAutoscaler) -
--
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+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.
-currentReplicas
-
-int32
-
+apiVersion
+string |
+
+
+agones.dev/v1
+
|
+
|
- CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler +kind
+string
|
+GameServer |
-desiredReplicas
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
- DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-lastScaleTime
+spec
-
-Kubernetes meta/v1.Time
+
+GameServerSpec
|
-(Optional)
- lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, - |
-
-ableToScale
+container
-bool
+string
|
- AbleToScale indicates that we can access the target fleet +Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-scalingLimited
+ports
-bool
+
+[]GameServerPort
+
|
- ScalingLimited indicates that the calculated scale would be above or below the range -defined by MinReplicas and MaxReplicas, and has thus been capped. +Ports are the array of ports that can be exposed via the game server |
-(Appears on: -FleetAutoscalerSpec) -
--
FleetAutoscalerSync describes when to sync a fleet
- -| Field | -Description | -
|---|---|
-type
+health
-
-FleetAutoscalerSyncType
+
+Health
|
- Type of autoscaling sync. +Health configures health checking |
-fixedInterval
+scheduling
-
-FixedIntervalSync
-
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
-(Optional)
- FixedInterval config params. Present only if FleetAutoscalerSyncType = FixedInterval. +Scheduling strategy. Defaults to “Packed” |
string alias)-(Appears on: -FleetAutoscalerSync) -
--
FleetAutoscalerSyncType is the sync strategy for a given Fleet
- --(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
+sdkServer
-string
+
+SdkServer
+
|
-(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. +SdkServer specifies parameters for the Agones SDK Server sidecar container |
-service
+template
-
-Kubernetes admissionregistration/v1.ServiceReference
+
+Kubernetes core/v1.PodTemplateSpec
|
-(Optional)
-
If the webhook is running within the cluster, then you should use Template describes the Pod that will be created for the GameServer |
-caBundle
+players
-[]byte
+
+PlayersSpec
+
|
(Optional)
-
(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
-
Package v1 is the v1 version of the API.
- -Resource Types: - -status
+
+
+GameServerStatus
+
+
+-
GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
+GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Deployments and ReplicaSets
-multicluster.agones.dev/v1
+agones.dev/v1
|
@@ -4347,7 +4382,7 @@ GameServerAllocationPolicy |
+GameServerSet |
|||||
@@ -4367,8 +4402,8 @@ GameServerAllocat
spec
-
-GameServerAllocationPolicySpec
+
+GameServerSetSpec
|
-priority
+replicas
int32
|
+ Replicas are the number of GameServers that should be in this set |
-weight
+scheduling
-int
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-connectionInfo
+template
-
-ClusterConnectionInfo
+
+GameServerTemplateSpec
|
+ Template the GameServer template to apply for this GameServerSet |
status
+
+
+GameServerSetStatus
+
+
+(Appears on: -GameServerAllocationPolicySpec) +FleetStatus, +GameServerSetStatus)
-
ClusterConnectionInfo defines the connection information for a cluster
+AggregatedPlayerStatus stores total player tracking values
-clusterName
+count
-string
+int64
|
- Optional: the name of the targeted cluster |
-allocationEndpoints
+capacity
-[]string
+int64
|
- 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: +Fleet) +
++
FleetSpec is the spec for a Fleet
+ +| Field | +Description | +
|---|---|
+replicas
+
+int32
+
+ |
+
+ Replicas are the number of GameServers that should be in this set. Defaults to 0. |
-secretName
+strategy
-string
+
+Kubernetes apps/v1.DeploymentStrategy
+
|
- The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster +Deployment strategy |
-namespace
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- The cluster namespace from which to allocate gameservers +Scheduling strategy. Defaults to “Packed”. |
-serverCa
+template
-[]byte
+
+GameServerTemplateSpec
+
|
- The PEM encoded server CA, used by the allocator client to authenticate the remote server. +Template the GameServer template to apply for this Fleet |
-
ConnectionInfoIterator an iterator on ClusterConnectionInfo
+(Appears on: +Fleet, +FleetAutoscaleRequest) + ++
FleetStatus is the status of a Fleet
-currPriority
+replicas
-int
+int32
|
- currPriority Current priority index from the orderedPriorities +Replicas the total number of current GameServer replicas |
-orderedPriorities
+readyReplicas
-[]int32
+int32
|
- orderedPriorities list of ordered priorities +ReadyReplicas are the number of Ready GameServer replicas |
-priorityToCluster
+reservedReplicas
-map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
+int32
|
- priorityToCluster Map of priority to cluster-policies map +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. |
-clusterBlackList
+allocatedReplicas
-map[string]bool
+int32
|
- clusterBlackList the cluster blacklist for the clusters that has already returned +AllocatedReplicas are the number of Allocated GameServer replicas + |
+
+players
+
+
+AggregatedPlayerStatus
+
+
+ |
+
+(Optional)
+ [Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players are the current total player capacity and count for this Fleet |
(Appears on: -GameServerAllocationPolicy) +GameServerSpec)
-
GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
+GameServerPort defines a set of Ports that +are to be exposed via the GameServer
-priority
+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
int32
|
+ ContainerPort is the port that is being opened on the specified container’s process |
-weight
+hostPort
-int
+int32
|
+ HostPort the port exposed on the host for clients to connect to |
-connectionInfo
+protocol
-
-ClusterConnectionInfo
+
+Kubernetes core/v1.Protocol
|
+ Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. |
-
Package v1 is the v1 version of the API.
+(Appears on: +GameServerSet) -Resource Types: --
Fleet is the data structure for a Fleet resource
+GameServerSetSpec the specification for GameServerSet
-apiVersion
-string |
-
-
-agones.dev/v1
-
- |
-|
-kind
-string
+replicas
+
+int32
+
+ |
+
+ Replicas are the number of GameServers that should be in this set |
-Fleet |
-metadata
+scheduling
-
-Kubernetes meta/v1.ObjectMeta
-
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Scheduling strategy. Defaults to “Packed”. |
|
-spec
+template
-
-FleetSpec
+
+GameServerTemplateSpec
|
- - + Template the GameServer template to apply for this GameServerSet + |
+
+(Appears on: +GameServerSet) +
++
GameServerSetStatus is the status of a GameServerSet
+| Field | +Description | +
|---|---|
replicas
@@ -4677,71 +4825,80 @@ Fleet |
- Replicas are the number of GameServers that should be in this set. Defaults to 0. +Replicas is the total number of current GameServer replicas |
-strategy
+readyReplicas
-
-Kubernetes apps/v1.DeploymentStrategy
-
+int32
|
- Deployment strategy +ReadyReplicas is the number of Ready GameServer replicas |
-scheduling
+reservedReplicas
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int32
|
- Scheduling strategy. Defaults to “Packed”. +ReservedReplicas is the number of Reserved GameServer replicas |
-template
+allocatedReplicas
-
-GameServerTemplateSpec
-
+int32
|
- Template the GameServer template to apply for this Fleet +AllocatedReplicas is the number of Allocated GameServer replicas |
shutdownReplicas
+
+int32
+
+ShutdownReplicas is the number of Shutdown GameServers replicas
status
+players
-
-FleetStatus
+
+AggregatedPlayerStatus
[Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players is the current total player capacity and count for this GameServerSet
-
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.
+
GameServerSpec is the spec for a GameServer resource
-apiVersion
-string |
-
-
-agones.dev/v1
-
- |
-|
-kind
-string
- |
-GameServer |
-|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-|
-spec
-
-
-GameServerSpec
-
-
- |
-
- - -
|
-|
-status
-
-
-GameServerStatus
-
-
- |
-- | -
string alias)+(Appears on: +GameServerSelector, +GameServerStatus) +
++
GameServerState is the state for the GameServer
+ +-
GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Deployments and ReplicaSets
+(Appears on: +GameServer) + ++
GameServerStatus is the status for a GameServer resource
-apiVersion
-string |
-
-
-agones.dev/v1
-
- |
-||||||
-kind
-string
- |
-GameServerSet |
-||||||
-metadata
+state
-
-Kubernetes meta/v1.ObjectMeta
+
+GameServerState
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
||||||
-spec
+ports
-
-GameServerSetSpec
+
+[]GameServerStatusPort
|
- - -
|
||||||
-status
+players
-
-GameServerSetStatus
+
+PlayerStatus
|
+(Optional)
+ [Stage:Alpha] +[FeatureFlag:PlayerTracking] |
(Appears on: -FleetStatus, -GameServerSetStatus) +GameServerAllocationStatus, +GameServerStatus)
-
AggregatedPlayerStatus stores total player tracking values
+GameServerStatusPort shows the port that was allocated to a +GameServer.
-count
+name
-int64
+string
|
@@ -5042,9 +5131,9 @@ AggregatedPlayerStatus |
-capacity
+port
-int64
+int32
|
@@ -5052,14 +5141,15 @@ AggregatedPlayerStatus |
(Appears on: -Fleet) +FleetSpec, +GameServerSetSpec)
-
FleetSpec is the spec for a Fleet
+GameServerTemplateSpec is a template for GameServers
-replicas
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Replicas are the number of GameServers that should be in this set. Defaults to 0. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-strategy
+spec
-
-Kubernetes apps/v1.DeploymentStrategy
+
+GameServerSpec
|
- Deployment strategy - |
-
-scheduling
+container
-agones.dev/agones/pkg/apis.SchedulingStrategy
+string
|
- Scheduling strategy. Defaults to “Packed”. +Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-template
+ports
-
-GameServerTemplateSpec
+
+[]GameServerPort
|
- Template the GameServer template to apply for this Fleet +Ports are the array of ports that can be exposed via the game server |
-(Appears on: -Fleet, -FleetAutoscaleRequest) -
--
FleetStatus is the status of a Fleet
- -| Field | -Description | -
|---|---|
-replicas
+health
-int32
+
+Health
+
|
- Replicas the total number of current GameServer replicas +Health configures health checking |
-readyReplicas
+scheduling
-int32
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- ReadyReplicas are the number of Ready GameServer replicas +Scheduling strategy. Defaults to “Packed” |
-reservedReplicas
+sdkServer
-int32
+
+SdkServer
+
|
- 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. +SdkServer specifies parameters for the Agones SDK Server sidecar container |
-allocatedReplicas
+template
-int32
+
+Kubernetes core/v1.PodTemplateSpec
+
|
- AllocatedReplicas are the number of Allocated GameServer replicas +Template describes the Pod that will be created for the GameServer |
players
-
-AggregatedPlayerStatus
+
+PlayersSpec
|
(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this Fleet +(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. + |
+
(Appears on: GameServerSpec)
-
GameServerPort defines a set of Ports that -are to be exposed via the GameServer
+Health configures health checking on the GameServer
-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
+disabled
-string
+bool
|
-(Optional)
- Container is the name of the container on which to open the port. Defaults to the game server container. +Disabled is whether health checking is disabled or not |
-containerPort
+periodSeconds
int32
|
- ContainerPort is the port that is being opened on the specified container’s process +PeriodSeconds is the number of seconds each health ping has to occur in |
-hostPort
+failureThreshold
int32
|
- HostPort the port exposed on the host for clients to connect to +FailureThreshold how many failures in a row constitutes unhealthy |
-protocol
+initialDelaySeconds
-
-Kubernetes core/v1.Protocol
-
+int32
|
- Protocol is the network protocol being used. Defaults to UDP. TCP and TCPUDP are other options. +InitialDelaySeconds initial delay before checking health |
(Appears on: -GameServerSet) +GameServerStatus)
-
GameServerSetSpec the specification for GameServerSet
+PlayerStatus stores the current player capacity values
-replicas
+count
-int32
+int64
|
- Replicas are the number of GameServers that should be in this set |
-scheduling
+capacity
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int64
|
- Scheduling strategy. Defaults to “Packed”. |
-template
+ids
-
-GameServerTemplateSpec
-
+[]string
|
- Template the GameServer template to apply for this GameServerSet |
(Appears on: -GameServerSet) +GameServerSpec)
-
GameServerSetStatus is the status of a GameServerSet
+PlayersSpec tracks the initial player capacity
-replicas
-
-int32
-
- |
-
- Replicas is the total number of current GameServer replicas - |
-
-readyReplicas
+initialCapacity
-int32
+int64
|
- ReadyReplicas is the number of Ready GameServer replicas |
string alias)+(Appears on: +GameServerPort) +
++
PortPolicy is the port policy for the GameServer
+ ++(Appears on: +GameServerSpec) +
++
SdkServer specifies parameters for the Agones SDK Server sidecar container
+ +
-reservedReplicas
-
-int32
-
- |
-
- ReservedReplicas is the number of Reserved GameServer replicas - |
+Field | +Description |
|---|---|---|---|
-allocatedReplicas
+logLevel
-int32
+
+SdkServerLogLevel
+
|
- AllocatedReplicas is the number of Allocated GameServer replicas +LogLevel for SDK server (sidecar) logs. Defaults to “Info” |
||
-shutdownReplicas
+grpcPort
int32
|
- ShutdownReplicas is the number of Shutdown GameServers replicas +GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections |
||
-players
+httpPort
-
-AggregatedPlayerStatus
-
+int32
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players is the current total player capacity and count for this GameServerSet +HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections |
string alias)(Appears on: -GameServer, -GameServerTemplateSpec) +SdkServer)
-
GameServerSpec is the spec for a GameServer resource
+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
-container
-
+apiVersion
+string |
+
+
+allocation.agones.dev/v1
+
+ |
+||||||||||||
+kind
string
+ |
+GameServerAllocation |
+||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||||
-ports
+spec
-
-[]GameServerPort
+
+GameServerAllocationSpec
|
- Ports are the array of ports that can be exposed via the game server ++ +
|
||||||||||||
-players
+status
-
-PlayersSpec
+
+GameServerAllocationStatus
|
-(Optional)
- (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
string alias)-(Appears on: -GameServerSelector, -GameServerStatus) -
--
GameServerState is the state for the GameServer
- -(Appears on: -GameServer) +GameServerAllocation)
-
GameServerStatus is the status for a GameServer resource
+GameServerAllocationSpec is the spec for a GameServerAllocation
-state
+multiClusterSetting
-
-GameServerState
+
+MultiClusterSetting
|
- GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-ports
+required
-
-[]GameServerStatusPort
+
+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. |
-address
-
-string
-
- |
-- | -
-nodeName
-
-string
-
- |
-- | -
-reservedUntil
+preferred
-
-Kubernetes meta/v1.Time
+
+[]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 |
-players
+selectors
-
-PlayerStatus
+
+[]GameServerSelector
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] - |
-
-(Appears on: -GameServerAllocationStatus, -GameServerStatus) -
--
GameServerStatusPort shows the port that was allocated to a -GameServer.
- -| Field | -Description | +
|---|---|
-name
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-port
+metadata
-int32
+
+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 |
string alias)+(Appears on: +GameServerAllocationStatus) +
++
GameServerAllocationState is the Allocation state
+ +(Appears on: -FleetSpec, -GameServerSetSpec) +GameServerAllocation)
-
GameServerTemplateSpec is a template for GameServers
+GameServerAllocationStatus is the status for an GameServerAllocation resource
-metadata
+state
-
-Kubernetes meta/v1.ObjectMeta
+
+GameServerAllocationState
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated |
||||||||||||||
-spec
-
-
-GameServerSpec
-
-
- |
-
- - -
If the allocation is from a remote cluster, Source is the endpoint of the remote agones-allocator. +Otherwise, Source is “local” |
(Appears on: -GameServerSpec) +GameServerAllocationSpec)
-
Health configures health checking on the GameServer
+GameServerSelector contains all the filter options for selecting +a GameServer for allocation.
-disabled
-
-bool
-
- |
-
- Disabled is whether health checking is disabled or not - |
-
-periodSeconds
+LabelSelector
-int32
+
+Kubernetes meta/v1.LabelSelector
+
|
- PeriodSeconds is the number of seconds each health ping has to occur in +See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
-failureThreshold
+gameServerState
-int32
+
+GameServerState
+
|
- FailureThreshold how many failures in a row constitutes unhealthy +(Optional) +[Stage:Beta] +[FeatureFlag:StateAllocationFilter] +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. |
-initialDelaySeconds
+players
-int32
+
+PlayerSelector
+
|
- InitialDelaySeconds initial delay before checking health +(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. |
(Appears on: -GameServerStatus) +GameServerAllocationSpec)
-
PlayerStatus stores the current player capacity values
+MetaPatch is the metadata used to patch the GameServer metadata on allocation
-count
-
-int64
-
- |
-- | -
-capacity
+labels
-int64
+map[string]string
|
@@ -5931,9 +5964,9 @@ PlayerStatus |
-ids
+annotations
-[]string
+map[string]string
|
@@ -5941,14 +5974,14 @@ PlayerStatus |
(Appears on: -GameServerSpec) +GameServerAllocationSpec)
-
PlayersSpec tracks the initial player capacity
+MultiClusterSetting specifies settings for multi-cluster allocation.
-initialCapacity
+enabled
-int64
+bool
+
+ |
++ | +
+policySelector
+
+
+Kubernetes meta/v1.LabelSelector
+
|
@@ -5970,23 +6015,14 @@ PlayersSpec |
string alias)-(Appears on: -GameServerPort) -
--
PortPolicy is the port policy for the GameServer
- -(Appears on: -GameServerSpec) +GameServerSelector)
-
SdkServer specifies parameters for the Agones SDK Server sidecar container
+PlayerSelector is the filter options for a GameServer based on player counts
-logLevel
-
-
-SdkServerLogLevel
-
-
- |
-
- LogLevel for SDK server (sidecar) logs. Defaults to “Info” - |
-
-grpcPort
+minAvailable
-int32
+int64
|
- GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections |
-httpPort
+maxAvailable
-int32
+int64
|
- 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.