GameServerSet is the data structure for a set of GameServers. This matches philosophically with the relationship between -Depoyments and ReplicaSets
+Deployments and ReplicaSets
-multicluster.agones.dev/v1
+allocation.agones.dev/v1
|
@@ -2811,7 +2812,7 @@ GameServerAllocationPolicy |
+GameServerAllocation |
|||||||||
@@ -2831,8 +2832,8 @@ GameServerAllocat
spec
-
-GameServerAllocationPolicySpec
+
+GameServerAllocationSpec
|
-priority
+multiClusterSetting
-int32
+
+MultiClusterSetting
+
+
+ |
+
+ MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. + |
+
+required
+
+
+Kubernetes meta/v1.LabelSelector
+
|
+ Required The required allocation. Defaults to all GameServers. |
-weight
+preferred
-int
+
+[]Kubernetes meta/v1.LabelSelector
+
|
+ Preferred ordered list of preferred allocations out of the |
-connectionInfo
+scheduling
-
-ClusterConnectionInfo
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed”. + |
+
+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 |
status
+
+
+GameServerAllocationStatus
+
+
+(Appears on: -GameServerAllocationPolicySpec) +GameServerAllocation)
-
ClusterConnectionInfo defines the connection information for a cluster
+GameServerAllocationSpec is the spec for a GameServerAllocation
-clusterName
+multiClusterSetting
-string
+
+MultiClusterSetting
+
|
- Optional: the name of the targeted cluster +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-allocationEndpoints
+required
-[]string
+
+Kubernetes meta/v1.LabelSelector
+
|
- 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 +Required The required allocation. Defaults to all GameServers. |
-secretName
+preferred
-string
+
+[]Kubernetes meta/v1.LabelSelector
+
|
- The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster +Preferred ordered list of preferred allocations out of the |
-namespace
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- The cluster namespace from which to allocate gameservers +Scheduling strategy. Defaults to “Packed”. |
-serverCa
+metadata
-[]byte
+
+MetaPatch
+
|
- The PEM encoded server CA, used by the allocator client to authenticate the remote server. +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
+ +-
ConnectionInfoIterator an iterator on ClusterConnectionInfo
+(Appears on: +GameServerAllocation) + ++
GameServerAllocationStatus is the status for an GameServerAllocation resource
-currPriority
+state
-int
+
+GameServerAllocationState
+
|
- currPriority Current priority index from the orderedPriorities +GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated |
-orderedPriorities
+gameServerName
-[]int32
+string
|
- orderedPriorities list of ordered priorities |
-priorityToCluster
+ports
-map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
+
+[]GameServerStatusPort
+
|
- priorityToCluster Map of priority to cluster-policies map |
-clusterBlackList
+address
-map[string]bool
+string
+
+ |
++ | +
+nodeName
+
+string
|
- clusterBlackList the cluster blacklist for the clusters that has already returned |
(Appears on: -GameServerAllocationPolicy) +GameServerAllocationSpec)
-
GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
+MetaPatch is the metadata used to patch the GameServer metadata on allocation
-priority
+labels
-int32
+map[string]string
|
@@ -3041,20 +3123,49 @@ GameServerAll |
-weight
+annotations
-int
+map[string]string
|
+(Appears on: +GameServerAllocationSpec) +
++
MultiClusterSetting specifies settings for multi-cluster allocation.
+ +| Field | +Description | +
|---|---|
-connectionInfo
+enabled
-
-ClusterConnectionInfo
+bool
+
+ |
++ | +
+policySelector
+
+
+Kubernetes meta/v1.LabelSelector
|
@@ -3064,22 +3175,18 @@
Package v1 is the v1 version of the API.
Resource Types:-
Fleet is the data structure for a Fleet resource
+FleetAutoscaler is the data structure for a FleetAutoscaler resource
-agones.dev/v1
+autoscaling.agones.dev/v1
|
@@ -3104,7 +3211,7 @@ Fleet |
+FleetAutoscaler |
|||||||||
@@ -3124,9 +3231,9 @@ Fleet
spec
-
-FleetSpec
-
+
+FleetAutoscalerSpec
+
|
-replicas
-
-int32
-
- |
-
- Replicas are the number of GameServers that should be in this set. Defaults to 0. - |
-
-strategy
-
-
-Kubernetes apps/v1.DeploymentStrategy
-
-
- |
-
- Deployment strategy - |
-
-scheduling
+fleetName
-agones.dev/agones/pkg/apis.SchedulingStrategy
+string
|
- Scheduling strategy. Defaults to “Packed”. |
-template
+policy
-
-GameServerTemplateSpec
+
+FleetAutoscalerPolicy
|
- Template the GameServer template to apply for this Fleet +Autoscaling policy |
status
-
-FleetStatus
+
+FleetAutoscalerStatus
-
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.
+
BufferPolicy controls the desired behavior of the buffer policy.
-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
-
-
- |
-
- - -
FleetAutoscaleRequest +++(Appears on: +FleetAutoscaleReview) + ++ FleetAutoscaleRequest defines the request to webhook autoscaler endpoint + +
Namespace is the namespace associated with the request (if any). |
||||||||||||||||
status
-
-GameServerStatus
+
+FleetStatus
|
+ The Fleet’s status values |
-
GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Depoyments and ReplicaSets
+(Appears on: +FleetAutoscaleReview) + ++
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
-apiVersion
-string |
-
-
-agones.dev/v1
-
- |
-||||||||
-kind
-string
- |
-GameServerSet |
-||||||||
-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
+scale
-
-GameServerSetSpec
-
+bool
|
- - -
FleetAutoscaleReview +++ FleetAutoscaleReview is passed to the webhook with a populated Request value, +and then returned with a populated Response. + +
|
||||||||
-status
+response
-
-GameServerSetStatus
+
+FleetAutoscaleResponse
|
@@ -3476,15 +3505,14 @@
(Appears on: -FleetStatus, -GameServerSetStatus) +FleetAutoscalerSpec)
-
AggregatedPlayerStatus stores total player tracking values
+FleetAutoscalerPolicy describes how to scale a fleet
-count
+type
-int64
+
+FleetAutoscalerPolicyType
+
|
+ Type of autoscaling policy. |
-capacity
+buffer
-int64
+
+BufferPolicy
+
|
+(Optional)
+ Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. |
-(Appears on: -Fleet) -
--
FleetSpec is the spec for a Fleet
- -| Field | -Description | -
|---|---|
-replicas
+webhook
-int32
+
+WebhookPolicy
+
|
- Replicas are the number of GameServers that should be in this set. Defaults to 0. +(Optional) +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: +FleetAutoscaler) +
++
FleetAutoscalerSpec is the spec for a Fleet Scaler
+ +
-strategy
-
-
-Kubernetes apps/v1.DeploymentStrategy
-
-
- |
-
- Deployment strategy - |
+Field | +Description |
|---|---|---|---|
-scheduling
+fleetName
-agones.dev/agones/pkg/apis.SchedulingStrategy
+string
|
- Scheduling strategy. Defaults to “Packed”. |
||
-template
+policy
-
-GameServerTemplateSpec
+
+FleetAutoscalerPolicy
|
- Template the GameServer template to apply for this Fleet +Autoscaling policy |
(Appears on: -Fleet, -FleetAutoscaleRequest) +FleetAutoscaler)
-
FleetStatus is the status of a Fleet
+FleetAutoscalerStatus defines the current status of a FleetAutoscaler
-replicas
+currentReplicas
int32
|
- Replicas the total number of current GameServer replicas +CurrentReplicas is the current number of gameserver replicas +of the fleet managed by this autoscaler, as last seen by the autoscaler |
-readyReplicas
+desiredReplicas
int32
|
- ReadyReplicas are the number of Ready GameServer replicas +DesiredReplicas is the desired number of gameserver replicas +of the fleet managed by this autoscaler, as last calculated by the autoscaler |
-reservedReplicas
+lastScaleTime
-int32
+
+Kubernetes meta/v1.Time
+
|
- 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. +(Optional) +lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, |
-allocatedReplicas
+ableToScale
-int32
+bool
|
- AllocatedReplicas are the number of Allocated GameServer replicas +AbleToScale indicates that we can access the target fleet |
-players
+scalingLimited
-
-AggregatedPlayerStatus
-
+bool
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this Fleet +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) +FleetAutoscalerPolicy)
-
GameServerPort defines a set of Ports that -are to be exposed via the GameServer
+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
-name
+url
string
|
- Name is the descriptive name of the port +(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. |
-portPolicy
+service
-
-PortPolicy
+
+Kubernetes admissionregistration/v1beta1.ServiceReference
|
- 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
If the webhook is running within the cluster, then you should use |
-container
+caBundle
-string
+[]byte
|
(Optional)
- Container is the name of the container on which to open the port. Defaults to the game server container. -This field is beta-level and is enabled by default, could be disabled by the “ContainerPortAllocation” feature. +
|
+
Package v1 is the v1 version of the API.
+ +Resource Types: + ++
GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API
+ +| Field | +Description | +
|---|---|
-containerPort
-
-int32
-
+apiVersion
+string |
+
+
+multicluster.agones.dev/v1
+
|
+
|
- ContainerPort is the port that is being opened on the specified container’s process +kind
+string
|
+GameServerAllocationPolicy |
-hostPort
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
- HostPort the port exposed on the host for clients to connect to +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-protocol
+spec
-
-Kubernetes core/v1.Protocol
+
+GameServerAllocationPolicySpec
|
- Protocol is the network protocol being used. Defaults to UDP. TCP is the only other option - |
-
-(Appears on: -GameServerSet) -
--
GameServerSetSpec the specification for GameServerSet
- +| Field | -Description | -
|---|---|
-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 + |
+
(Appears on: -GameServerSet) +GameServerAllocationPolicySpec)
-
GameServerSetStatus is the status of a GameServerSet
+ClusterConnectionInfo defines the connection information for a cluster
-replicas
-
-int32
-
- |
-
- Replicas the total number of current GameServer replicas - |
-
-readyReplicas
+clusterName
-int32
+string
|
- ReadyReplicas are the number of Ready GameServer replicas +Optional: the name of the targeted cluster |
-reservedReplicas
+allocationEndpoints
-int32
+[]string
|
- ReservedReplicas are the number of Reserved GameServer replicas +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 |
-allocatedReplicas
+secretName
-int32
+string
|
- AllocatedReplicas are the number of Allocated GameServer replicas +The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster |
-shutdownReplicas
+namespace
-int32
+string
|
- ShutdownReplicas are the number of Shutdown GameServers replicas +The cluster namespace from which to allocate gameservers |
-players
+serverCa
-
-AggregatedPlayerStatus
-
+[]byte
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this GameServerSet +The PEM encoded server CA, used by the allocator client to authenticate the remote server. |
-(Appears on: -GameServer, -GameServerTemplateSpec) -
--
GameServerSpec is the spec for a GameServer resource
+ConnectionInfoIterator an iterator on ClusterConnectionInfo
-container
+currPriority
-string
+int
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined +currPriority Current priority index from the orderedPriorities |
-ports
+orderedPriorities
-
-[]GameServerPort
-
+[]int32
|
- Ports are the array of ports that can be exposed via the game server +orderedPriorities list of ordered priorities |
-health
+priorityToCluster
-
-Health
-
+map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy
|
- Health configures health checking +priorityToCluster Map of priority to cluster-policies map |
-scheduling
+clusterBlackList
-agones.dev/agones/pkg/apis.SchedulingStrategy
+map[string]bool
|
- Scheduling strategy. Defaults to “Packed” +clusterBlackList the cluster blacklist for the clusters that has already returned |
+(Appears on: +GameServerAllocationPolicy) +
++
GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy
+ +| Field | +Description | +
|---|---|
-sdkServer
+priority
-
-SdkServer
-
+int32
|
- SdkServer specifies parameters for the Agones SDK Server sidecar container |
-template
+weight
-
-Kubernetes core/v1.PodTemplateSpec
-
+int
|
- Template describes the Pod that will be created for the GameServer |
-players
+connectionInfo
-
-PlayersSpec
+
+ClusterConnectionInfo
|
-(Optional)
- (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
string alias)-(Appears on: -GameServerStatus) -
+-
GameServerState is the state for the GameServer
+Package v1 is the v1 version of the API.
--(Appears on: -GameServer) -
--
GameServerStatus is the status for a GameServer resource
+Fleet is the data structure for a Fleet resource
-state
+apiVersion
+string |
+
+
+agones.dev/v1
+
+ |
+||||||||
+kind
+string
+ |
+Fleet |
+||||||||
+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
+
+FleetSpec
|
+ + +
|
||||||||
-players
+status
-
-PlayerStatus
+
+FleetStatus
|
-(Optional)
- [Stage:Alpha] -[FeatureFlag:PlayerTracking] |
-(Appears on: -GameServerAllocationStatus, -GameServerStatus) -
--
GameServerStatusPort shows the port that was allocated to a -GameServer.
+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.
-name
-
-string
-
- |
-- | -
-port
-
-int32
-
- |
+
+
+agones.dev/v1
+
|
-(Appears on: -FleetSpec, -GameServerSetSpec) -
--
GameServerTemplateSpec is a template for GameServers
- -| Field | -Description | +
+kind
+string
+ |
+GameServer |
|---|---|---|---|
metadata
@@ -4291,16 +4355,26 @@ GameServerTemplateSpec |
status
+
+
+GameServerStatus
+
+
+-(Appears on: -GameServerSpec) -
--
Health configures health checking on the GameServer
+GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Deployments and ReplicaSets
-disabled
-
-bool
-
- |
+
- Disabled is whether health checking is disabled or not +
+agones.dev/v1
+
|
|
-periodSeconds
-
-int32
-
- |
-
- PeriodSeconds is the number of seconds each health ping has to occur in +kind
+string
|
+GameServerSet |
-failureThreshold
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
- FailureThreshold how many failures in a row constitutes unhealthy +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-initialDelaySeconds
+spec
-int32
+
+GameServerSetSpec
+
|
- InitialDelaySeconds initial delay before checking health - |
-
-(Appears on: -GameServerStatus) -
--
PlayerStatus stores the current player capacity values
- +| Field | -Description | -
|---|---|
-count
+replicas
-int64
+int32
|
+ Replicas are the number of GameServers that should be in this set |
-capacity
+scheduling
-int64
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-ids
+template
-[]string
+
+GameServerTemplateSpec
+
|
+ Template the GameServer template to apply for this GameServerSet |
-(Appears on: -GameServerSpec) -
--
PlayersSpec tracks the initial player capacity
- -| Field | -Description | +
|---|---|
-initialCapacity
+status
-int64
+
+GameServerSetStatus
+
|
@@ -4434,23 +4480,15 @@ PlayersSpec |
string alias)-(Appears on: -GameServerPort) -
--
PortPolicy is the port policy for the GameServer
- -(Appears on: -GameServerSpec) +FleetStatus, +GameServerSetStatus)
-
SdkServer specifies parameters for the Agones SDK Server sidecar container
+AggregatedPlayerStatus stores total player tracking values
-logLevel
-
-
-SdkServerLogLevel
-
-
- |
-
- LogLevel for SDK server (sidecar) logs. Defaults to “Info” - |
-
-grpcPort
+count
-int32
+int64
|
- GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections |
-httpPort
+capacity
-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
- --
Package v1 is the v1 version of the API.
+Fleet) -Resource Types: - --
GameServerAllocation is the data structure for allocating against a set of
-GameServers, defined required and preferred selectors
FleetSpec is the spec for a Fleet
| Field | -Description | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-allocation.agones.dev/v1
-
- |
-||||||||||
-kind
-string
- |
-GameServerAllocation |
-||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec
-
-
-GameServerAllocationSpec
-
-
- |
-
- - -
|
-||||||||||
-status
+template
-
-GameServerAllocationStatus
+
+GameServerTemplateSpec
|
+ Template the GameServer template to apply for this Fleet |
(Appears on: -GameServerAllocation) +Fleet, +FleetAutoscaleRequest)
-
GameServerAllocationSpec is the spec for a GameServerAllocation
+FleetStatus is the status of a Fleet
-multiClusterSetting
+replicas
-
-MultiClusterSetting
-
+int32
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +Replicas the total number of current GameServer replicas |
-required
+readyReplicas
-
-Kubernetes meta/v1.LabelSelector
-
+int32
|
- Required The required allocation. Defaults to all GameServers. +ReadyReplicas are the number of Ready GameServer replicas |
-preferred
+reservedReplicas
-
-[]Kubernetes meta/v1.LabelSelector
-
+int32
|
- Preferred ordered list of preferred allocations out of the 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. |
-scheduling
+allocatedReplicas
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int32
|
- Scheduling strategy. Defaults to “Packed”. +AllocatedReplicas are the number of Allocated GameServer replicas |
-metadata
+players
-
-MetaPatch
+
+AggregatedPlayerStatus
|
- 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] +Players are the current total player capacity and count for this Fleet |
string alias)-(Appears on: -GameServerAllocationStatus) -
--
GameServerAllocationState is the Allocation state
- -(Appears on: -GameServerAllocation) +GameServerSpec)
-
GameServerAllocationStatus is the status for an GameServerAllocation resource
+GameServerPort defines a set of Ports that +are to be exposed via the GameServer
-state
+name
-
-GameServerAllocationState
+string
+
+ |
+
+ Name is the descriptive name of the port + |
+
+portPolicy
+
+
+PortPolicy
|
- GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated +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 |
-gameServerName
+container
string
|
+(Optional)
+ Container is the name of the container on which to open the port. Defaults to the game server container. +This field is beta-level and is enabled by default, could be disabled by the “ContainerPortAllocation” feature. |
-ports
+containerPort
-
-[]GameServerStatusPort
-
+int32
|
+ ContainerPort is the port that is being opened on the specified container’s process |
-address
+hostPort
-string
+int32
|
+ HostPort the port exposed on the host for clients to connect to |
-nodeName
+protocol
-string
+
+Kubernetes core/v1.Protocol
+
|
+ Protocol is the network protocol being used. Defaults to UDP. TCP is the only other option |
(Appears on: -GameServerAllocationSpec) +GameServerSet)
-
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+GameServerSetSpec the specification for GameServerSet
-labels
+replicas
-map[string]string
+int32
|
+ Replicas are the number of GameServers that should be in this set |
-annotations
+scheduling
-map[string]string
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed”. + |
+
+template
+
+
+GameServerTemplateSpec
+
|
+ Template the GameServer template to apply for this GameServerSet |
(Appears on: -GameServerAllocationSpec) +GameServerSet)
-
MultiClusterSetting specifies settings for multi-cluster allocation.
+GameServerSetStatus is the status of a GameServerSet
-enabled
+replicas
-bool
+int32
|
+ Replicas is the total number of current GameServer replicas |
-policySelector
+readyReplicas
-
-Kubernetes meta/v1.LabelSelector
+int32
+
+ |
+
+ ReadyReplicas is the number of Ready GameServer replicas + |
+
+reservedReplicas
+
+int32
+
+ |
+
+ ReservedReplicas is the number of Reserved GameServer replicas + |
+
+allocatedReplicas
+
+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:PlayerTracking] +Players is the current total player capacity and count for this GameServerSet |
-
Package v1 is the v1 version of the API.
+(Appears on: +GameServer, +GameServerTemplateSpec) -Resource Types: - --
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+GameServerSpec is the spec for a GameServer resource
-apiVersion
-string |
-
-
-autoscaling.agones.dev/v1
-
+container
+
+string
+
|
-||||
-kind
-string
+Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-FleetAutoscaler |
||||
-metadata
+ports
-
-Kubernetes meta/v1.ObjectMeta
+
+[]GameServerPort
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Ports are the array of ports that can be exposed via the game server |
||||
-spec
+health
-
-FleetAutoscalerSpec
+
+Health
|
- - -
| ||||
+template
+
+
+Kubernetes core/v1.PodTemplateSpec
+
+
+ |
+
+ Template describes the Pod that will be created for the GameServer |
||||
-status
+players
-
-FleetAutoscalerStatus
+
+PlayersSpec
|
+(Optional)
+ (Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. |
string alias)+(Appears on: +GameServerStatus) +
++
GameServerState is the state for the GameServer
+ +(Appears on: -FleetAutoscalerPolicy) +GameServer)
-
BufferPolicy controls the desired behavior of the buffer policy.
+GameServerStatus is the status for a GameServer resource
-maxReplicas
+state
-int32
+
+GameServerState
+
|
- MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize +GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-minReplicas
+ports
-int32
+
+[]GameServerStatusPort
+
|
- 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
+address
-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) |
-(Appears on: -FleetAutoscaleReview) -
--
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
- -| Field | -Description | +
+nodeName
+
+string
+
+ |
++ |
|---|---|---|---|
-uid
+reservedUntil
-k8s.io/apimachinery/pkg/types.UID
+
+Kubernetes meta/v1.Time
+
|
- 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
+players
-string
+
+PlayerStatus
+
|
- Name is the name of the Fleet being scaled +(Optional) +[Stage:Alpha] +[FeatureFlag:PlayerTracking] |
+(Appears on: +GameServerAllocationStatus, +GameServerStatus) +
++
GameServerStatusPort shows the port that was allocated to a +GameServer.
+ +| Field | +Description | +
|---|---|
-namespace
+name
string
|
- Namespace is the namespace associated with the request (if any). |
-status
+port
-
-FleetStatus
-
+int32
|
- The Fleet’s status values |
(Appears on: -FleetAutoscaleReview) +FleetSpec, +GameServerSetSpec)
-
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
+GameServerTemplateSpec is a template for GameServers
-uid
+metadata
-k8s.io/apimachinery/pkg/types.UID
+
+Kubernetes meta/v1.ObjectMeta
+
|
- UID is an identifier for the individual request/response. -This should be copied over from the corresponding FleetAutoscaleRequest. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||
-scale
+spec
-bool
+
+GameServerSpec
+
|
- Set to false if no scaling should occur to the Fleet - |
-
-replicas
+container
-int32
+string
|
-
- The targeted replica count - |
-
-
FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.
- -| Field | -Description | +
+ Container specifies which Pod container is the game server. Only required if there is more than one +container defined + |
|---|---|---|
-request
+ports
-
-FleetAutoscaleRequest
+
+[]GameServerPort
|
+ Ports are the array of ports that can be exposed via the game server |
|
-response
+health
-
-FleetAutoscaleResponse
+
+Health
|
+ Health configures health checking |
-(Appears on: -FleetAutoscalerSpec) -
--
FleetAutoscalerPolicy describes how to scale a fleet
- -| Field | -Description | +
+scheduling
+
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed” + |
|---|---|---|---|
-type
+sdkServer
-
-FleetAutoscalerPolicyType
+
+SdkServer
|
- Type of autoscaling policy. +SdkServer specifies parameters for the Agones SDK Server sidecar container |
||
-buffer
+template
-
-BufferPolicy
+
+Kubernetes core/v1.PodTemplateSpec
|
-(Optional)
- Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. +Template describes the Pod that will be created for the GameServer |
||
-webhook
+players
-
-WebhookPolicy
+
+PlayersSpec
|
(Optional)
- Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. +(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features. + |
+
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
+Health configures health checking on the GameServer
-fleetName
+disabled
-string
+bool
|
+ Disabled is whether health checking is disabled or not |
-policy
+periodSeconds
-
-FleetAutoscalerPolicy
-
+int32
|
- Autoscaling policy +PeriodSeconds is the number of seconds each health ping has to occur in + |
+
+failureThreshold
+
+int32
+
+ |
+
+ FailureThreshold how many failures in a row constitutes unhealthy + |
+
+initialDelaySeconds
+
+int32
+
+ |
+
+ InitialDelaySeconds initial delay before checking health |
(Appears on: -FleetAutoscaler) +GameServerStatus)
-
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+PlayerStatus stores the current player capacity values
-currentReplicas
+count
-int32
+int64
|
- CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler |
-desiredReplicas
+capacity
-int32
+int64
|
- DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler |
-lastScaleTime
+ids
-
-Kubernetes meta/v1.Time
-
+[]string
|
-(Optional)
- lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, |
+(Appears on: +GameServerSpec) +
++
PlayersSpec tracks the initial player capacity
+ +
-ableToScale
-
-bool
-
- |
-
- AbleToScale indicates that we can access the target fleet - |
+Field | +Description |
|---|---|---|---|
-scalingLimited
+initialCapacity
-bool
+int64
|
- ScalingLimited indicates that the calculated scale would be above or below the range -defined by MinReplicas and MaxReplicas, and has thus been capped. |
string alias)+(Appears on: +GameServerPort) +
++
PortPolicy is the port policy for the GameServer
+ +(Appears on: -FleetAutoscalerPolicy) +GameServerSpec)
-
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
+SdkServer specifies parameters for the Agones SDK Server sidecar container
-url
+logLevel
-string
+
+SdkServerLogLevel
+
|
-(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. +LogLevel for SDK server (sidecar) logs. Defaults to “Info” |
-service
+grpcPort
-
-Kubernetes admissionregistration/v1beta1.ServiceReference
-
+int32
|
-(Optional)
-
If the webhook is running within the cluster, then you should use GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections |
-caBundle
+httpPort
-[]byte
+int32
|
-(Optional)
-
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.