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 required and preferred selectors
Fleet is the data structure for a Fleet resource
-allocation.agones.dev/v1
+agones.dev/v1
|
@@ -2397,7 +2400,7 @@ GameServerAllocation |
+Fleet |
||||||||
@@ -2417,8 +2420,8 @@ GameServerAllocation
spec
-
-GameServerAllocationSpec
+
+FleetSpec
|
-multiClusterSetting
-
-
-MultiClusterSetting
-
-
- |
-
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. - |
-
-required
+replicas
-
-Kubernetes meta/v1.LabelSelector
-
+int32
|
- Required The required allocation. Defaults to all GameServers. +Replicas are the number of GameServers that should be in this set |
-preferred
+strategy
-
-[]Kubernetes meta/v1.LabelSelector
+
+Kubernetes apps/v1.DeploymentStrategy
|
- Preferred ordered list of preferred allocations out of the Deployment strategy |
-metadata
+template
-
-MetaPatch
+
+GameServerTemplateSpec
|
- 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 the GameServer template to apply for this Fleet |
status
-
-GameServerAllocationStatus
+
+FleetStatus
-(Appears on: -GameServerAllocation) -
--
GameServerAllocationSpec is the spec for a GameServerAllocation
+GameServer is the data structure for a GameServer resource
-multiClusterSetting
-
-
-MultiClusterSetting
-
-
+apiVersion
+string |
+
+
+agones.dev/v1
+
|
+
|
- MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally. +kind
+string
|
+GameServer |
-required
+metadata
-
-Kubernetes meta/v1.LabelSelector
+
+Kubernetes meta/v1.ObjectMeta
|
- Required The required allocation. Defaults to all GameServers. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-preferred
+spec
-
-[]Kubernetes meta/v1.LabelSelector
+
+GameServerSpec
|
- Preferred ordered list of preferred allocations out of the |
-
-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 |
-metadata
+ports
-
-MetaPatch
+
+[]GameServerPort
|
- 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 +Ports are the array of ports that can be exposed via the game server |
string alias)-(Appears on: -GameServerAllocationStatus) -
--
GameServerAllocationState is the Allocation state
- --(Appears on: -GameServerAllocation) -
--
GameServerAllocationStatus is the status for an GameServerAllocation resource
- -| Field | -Description | -
|---|---|
-state
+health
-
-GameServerAllocationState
+
+Health
|
- GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated +Health configures health checking |
-gameServerName
+scheduling
-string
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
+ Scheduling strategy. Defaults to “Packed”. |
-ports
+template
-
-[]GameServerStatusPort
+
+Kubernetes core/v1.PodTemplateSpec
|
+ Template describes the Pod that will be created for the GameServer |
-address
-
-string
-
- |
-+ |
nodeName
+status
-string
+
+GameServerStatus
+
-(Appears on: -GameServerAllocationSpec) -
--
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Depoyments and ReplicaSets
-labels
-
-map[string]string
-
- |
+
+
+agones.dev/v1
+
|
|
-annotations
-
-map[string]string
-
- |
-
+kind
+string
|
+GameServerSet |
-(Appears on: -GameServerAllocationSpec) -
--
MultiClusterSetting specifies settings for multi-cluster allocation.
- -| Field | -Description | -
|---|---|
-enabled
+metadata
-bool
+
+Kubernetes meta/v1.ObjectMeta
+
|
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
-policySelector
+spec
-
-Kubernetes meta/v1.LabelSelector
+
+GameServerSetSpec
|
- | -
-
Package v1 is the v1 version of the API.
- -Resource Types: - --
FleetAutoscaler is the data structure for a FleetAutoscaler resource
- +| Field | -Description | -|||||
|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-autoscaling.agones.dev/v1
-
- |
-|||||
-kind
-string
- |
-FleetAutoscaler |
-|||||
-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 |
|||||
-spec
-
-
-FleetAutoscalerSpec
-
-
- |
-
- - -
FleetAutoscaler
status
-
-FleetAutoscalerStatus
+
+GameServerSetStatus
|
(Appears on: -FleetAutoscalerPolicy) +Fleet)
-
BufferPolicy controls the desired behavior of the buffer policy.
+FleetSpec is the spec for a Fleet
-maxReplicas
+replicas
int32
|
- MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize +Replicas are the number of GameServers that should be in this set |
-minReplicas
+strategy
-int32
+
+Kubernetes apps/v1.DeploymentStrategy
+
|
- 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 +Deployment strategy |
-bufferSize
+scheduling
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- 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) +Scheduling strategy. Defaults to “Packed”. + |
+
+template
+
+
+GameServerTemplateSpec
+
+
+ |
+
+ Template the GameServer template to apply for this Fleet |
(Appears on: -FleetAutoscaleReview) +Fleet, +FleetAutoscaleRequest)
-
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+FleetStatus is the status of a Fleet
-uid
+replicas
-k8s.io/apimachinery/pkg/types.UID
+int32
|
- 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. +Replicas the total number of current GameServer replicas |
-name
+readyReplicas
-string
+int32
|
- Name is the name of the Fleet being scaled +ReadyReplicas are the number of Ready GameServer replicas |
-namespace
+reservedReplicas
-string
+int32
|
- Namespace is the namespace associated with the request (if any). +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. |
-status
+allocatedReplicas
-
-FleetStatus
-
+int32
|
- The Fleet’s status values +AllocatedReplicas are the number of Allocated GameServer replicas |
(Appears on: -FleetAutoscaleReview) +GameServerSpec)
-
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
+GameServerPort defines a set of Ports that +are to be exposed via the GameServer
-uid
+name
-k8s.io/apimachinery/pkg/types.UID
+string
|
- UID is an identifier for the individual request/response. -This should be copied over from the corresponding FleetAutoscaleRequest. +Name is the descriptive name of the port |
-scale
+portPolicy
-bool
+
+PortPolicy
+
|
- Set to false if no scaling should occur to the Fleet +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 |
-replicas
+containerPort
int32
|
- The targeted replica count +ContainerPort is the port that is being opened on the game server process |
-
FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.
- -| Field | -Description | -
|---|---|
-request
+hostPort
-
-FleetAutoscaleRequest
-
+int32
|
+ HostPort the port exposed on the host for clients to connect to |
-response
+protocol
-
-FleetAutoscaleResponse
+
+Kubernetes core/v1.Protocol
|
+ Protocol is the network protocol being used. Defaults to UDP. TCP is the only other option |
(Appears on: -FleetAutoscalerSpec) +GameServerSet)
-
FleetAutoscalerPolicy describes how to scale a fleet
+GameServerSetSpec the specification for GameServerSet
-type
+replicas
-
-FleetAutoscalerPolicyType
-
+int32
|
- Type of autoscaling policy. +Replicas are the number of GameServers that should be in this set |
-buffer
+scheduling
-
-BufferPolicy
-
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
-(Optional)
- Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. +Scheduling strategy. Defaults to “Packed”. |
-webhook
+template
-
-WebhookPolicy
+
+GameServerTemplateSpec
|
-(Optional)
- Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook. +Template the GameServer template to apply for this GameServerSet |
string alias)-(Appears on: -FleetAutoscalerPolicy) -
--
FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet
- -(Appears on: -FleetAutoscaler) +GameServerSet)
-
FleetAutoscalerSpec is the spec for a Fleet Scaler
+GameServerSetStatus is the status of a GameServerSet
-fleetName
+replicas
-string
+int32
|
+ Replicas the total number of current GameServer replicas |
-policy
+readyReplicas
-
-FleetAutoscalerPolicy
-
+int32
|
- Autoscaling policy +ReadyReplicas are the number of Ready GameServer replicas + |
+
+reservedReplicas
+
+int32
+
+ |
+
+ ReservedReplicas are the number of Reserved GameServer replicas + |
+
+allocatedReplicas
+
+int32
+
+ |
+
+ AllocatedReplicas are the number of Allocated GameServer replicas + |
+
+shutdownReplicas
+
+int32
+
+ |
+
+ ShutdownReplicas are the number of Shutdown GameServers replicas |
(Appears on: -FleetAutoscaler) +GameServer, +GameServerTemplateSpec)
-
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+GameServerSpec is the spec for a GameServer resource
-currentReplicas
+container
-int32
+string
|
- CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler +Container specifies which Pod container is the game server. Only required if there is more than one +container defined |
-desiredReplicas
+ports
-int32
+
+[]GameServerPort
+
|
- DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler +Ports are the array of ports that can be exposed via the game server |
-lastScaleTime
+health
-
-Kubernetes meta/v1.Time
+
+Health
|
-(Optional)
- lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet, +Health configures health checking |
-ableToScale
+scheduling
-bool
+agones.dev/agones/pkg/apis.SchedulingStrategy
|
- AbleToScale indicates that we can access the target fleet +Scheduling strategy. Defaults to “Packed”. |
-scalingLimited
+template
-bool
+
+Kubernetes core/v1.PodTemplateSpec
+
|
- ScalingLimited indicates that the calculated scale would be above or below the range -defined by MinReplicas and MaxReplicas, and has thus been capped. +Template describes the Pod that will be created for the GameServer |
string alias)+(Appears on: +GameServerStatus) +
++
GameServerState is the state for the GameServer
+ +(Appears on: -FleetAutoscalerPolicy) +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
+GameServerStatus is the status for a GameServer resource
-url
+state
-string
+
+GameServerState
+
|
-(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. +GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-service
+ports
-
-Kubernetes admissionregistration/v1beta1.ServiceReference
+
+[]GameServerStatusPort
|
-(Optional)
-
If the webhook is running within the cluster, then you should use Port 443 will be used if it is open, otherwise it is an error. |
-caBundle
+address
-[]byte
+string
+
+ |
++ | +
+nodeName
+
+string
+
+ |
++ | +
+reservedUntil
+
+
+Kubernetes meta/v1.Time
+
|
-
|
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +GameServerAllocationStatus, +GameServerStatus) -Resource Types: --
Fleet is the data structure for a Fleet resource
+GameServerStatusPort shows the port that was allocated to a +GameServer.
-apiVersion
-string |
+
-
-stable.agones.dev/v1alpha1
-
|
|
-kind
-string
+port
+
+int32
+
|
-Fleet |
++ | +
+(Appears on: +FleetSpec, +GameServerSetSpec) +
++
GameServerTemplateSpec is a template for GameServers
+ +| Field | +Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -3425,8 +3328,8 @@ Fleet
spec
-
-FleetSpec
+
+GameServerSpec
|
+
-replicas
+container
-int32
+string
|
- Replicas are the number of GameServers that should be in this set +Container specifies which Pod container is the game server. Only required if there is more than one +container defined + |
+
+ports
+
+
+[]GameServerPort
+
+
+ |
+
+ Ports are the array of ports that can be exposed via the game server + |
+
+health
+
+
+Health
+
+
+ |
+
+ Health configures health checking + |
+
+scheduling
+
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed”. + |
+
+template
+
+
+Kubernetes core/v1.PodTemplateSpec
+
+
|
+
+ Template describes the Pod that will be created for the GameServer + |
+
+(Appears on: +GameServerSpec) +
++
Health configures health checking on the GameServer
+ +| Field | +Description |
|---|---|
-strategy
+disabled
-
-Kubernetes apps/v1.DeploymentStrategy
-
+bool
|
- Deployment strategy +Disabled is whether health checking is disabled or not |
-scheduling
+periodSeconds
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int32
|
- Scheduling strategy. Defaults to “Packed”. +PeriodSeconds is the number of seconds each health ping has to occur in |
-template
+failureThreshold
-
-GameServerTemplateSpec
-
+int32
|
- Template the GameServer template to apply for this Fleet - |
-
FailureThreshold how many failures in a row constitutes unhealthy
status
+initialDelaySeconds
-
-FleetStatus
-
+int32
InitialDelaySeconds initial delay before checking health
string alias)+(Appears on: +GameServerPort) +
++
PortPolicy is the port policy for the GameServer
+ ++
Package v1 is the v1 version of the API.
+ +Resource Types: + +-
GameServer is the data structure for a GameServer resource
+GameServerAllocation is the data structure for allocating against a set of
+GameServers, defined required and preferred selectors
-stable.agones.dev/v1alpha1
+allocation.agones.dev/v1
|
@@ -3527,7 +3514,7 @@ GameServer |
+GameServerAllocation |
||||||||
@@ -3547,8 +3534,8 @@ GameServer
spec
-
-GameServerSpec
+
+GameServerAllocationSpec
|
-container
+multiClusterSetting
-string
+
+MultiClusterSetting
+
|
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined +MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
-ports
+required
-
-[]GameServerPort
+
+Kubernetes meta/v1.LabelSelector
|
- Ports are the array of ports that can be exposed via the game server +Required The required allocation. Defaults to all GameServers. |
-health
+preferred
-
-Health
+
+[]Kubernetes meta/v1.LabelSelector
|
- Health configures health checking +Preferred ordered list of preferred allocations out of the |
-template
+metadata
-
-Kubernetes core/v1.PodTemplateSpec
+
+MetaPatch
|
- Template describes the Pod that will be created for the GameServer +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
-
-GameServerStatus
+
+GameServerAllocationStatus
-
GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Depoyments and ReplicaSets
+(Appears on: +GameServerAllocation) + ++
GameServerAllocationSpec is the spec for a GameServerAllocation
-apiVersion
-string |
-
-
-stable.agones.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-GameServerSet |
-||||
-metadata
+multiClusterSetting
-
-Kubernetes meta/v1.ObjectMeta
+
+MultiClusterSetting
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally. |
||||
-spec
+required
-
-GameServerSetSpec
+
+Kubernetes meta/v1.LabelSelector
|
- - -
|
-||||
-status
+metadata
-
-GameServerSetStatus
+
+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: -Fleet) +GameServerAllocation)
-
FleetSpec is the spec for a Fleet
+GameServerAllocationStatus is the status for an GameServerAllocation resource
-replicas
+state
-int32
+
+GameServerAllocationState
+
|
- Replicas are the number of GameServers that should be in this set +GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated |
-strategy
+gameServerName
-
-Kubernetes apps/v1.DeploymentStrategy
+string
+
+ |
++ | +
+ports
+
+
+[]GameServerStatusPort
|
- Deployment strategy |
-scheduling
+address
-agones.dev/agones/pkg/apis.SchedulingStrategy
+string
|
- Scheduling strategy. Defaults to “Packed”. |
-template
+nodeName
-
-GameServerTemplateSpec
-
+string
|
- Template the GameServer template to apply for this Fleet |
(Appears on: -Fleet, -FleetAutoscaleRequest) +GameServerAllocationSpec)
-
FleetStatus is the status of a Fleet
+MetaPatch is the metadata used to patch the GameServer metadata on allocation
-replicas
+labels
-int32
+map[string]string
|
- Replicas the total number of current GameServer replicas |
-readyReplicas
+annotations
-int32
+map[string]string
|
- ReadyReplicas are the number of Ready GameServer replicas |
+(Appears on: +GameServerAllocationSpec) +
++
MultiClusterSetting specifies settings for multi-cluster allocation.
+ +| Field | +Description | +
|---|---|
-reservedReplicas
+enabled
-int32
+bool
|
- 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
+policySelector
-int32
+
+Kubernetes meta/v1.LabelSelector
+
|
- AllocatedReplicas are the number of Allocated GameServer replicas |
-(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
+FleetAutoscaler is the data structure for a FleetAutoscaler resource
-name
-
-string
-
+apiVersion
+string |
+
+
+autoscaling.agones.dev/v1
+
|
+||||
|
- Name is the descriptive name of the port +kind
+string
|
+FleetAutoscaler |
||||
-portPolicy
+metadata
-
-PortPolicy
+
+Kubernetes meta/v1.ObjectMeta
|
- 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 metadata field.
|
||||
-containerPort
+spec
-int32
+
+FleetAutoscalerSpec
+
+
+ |
+
+ + +
|
||||
-protocol
+status
-
-Kubernetes core/v1.Protocol
+
+FleetAutoscalerStatus
|
- Protocol is the network protocol being used. Defaults to UDP. TCP is the only other option |
(Appears on: -GameServerSet) +FleetAutoscalerPolicy)
-
GameServerSetSpec the specification for GameServerSet
+BufferPolicy controls the desired behavior of the buffer policy.
-replicas
+maxReplicas
int32
|
- Replicas are the number of GameServers that should be in this set +MaxReplicas is the maximum amount of replicas that the fleet may have. +It must be bigger than both MinReplicas and BufferSize |
-scheduling
+minReplicas
-agones.dev/agones/pkg/apis.SchedulingStrategy
+int32
|
- Scheduling strategy. Defaults to “Packed”. +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 |
-template
+bufferSize
-
-GameServerTemplateSpec
-
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
- Template the GameServer template to apply for this GameServerSet +BufferSize defines how many replicas the autoscaler tries to have ready all the time +Value can be an absolute number (ex: 5) or a percentage of desired gs instances (ex: 15%) +Absolute number is calculated from percentage by rounding up. +Example: when this is set to 20%, the autoscaler will make sure that 20% +of the fleet’s game server replicas are ready. When this is set to 20, +the autoscaler will make sure that there are 20 available game servers +Must be bigger than 0 +Note: by “ready” we understand in this case “non-allocated”; this is done to ensure robustness +and computation stability in different edge case (fleet just created, not enough +capacity in the cluster etc) |
(Appears on: -GameServerSet) +FleetAutoscaleReview)
-
GameServerSetStatus is the status of a GameServerSet
+FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
-replicas
-
-int32
-
- |
-
- Replicas the total number of current GameServer replicas - |
-
-readyReplicas
+uid
-int32
+k8s.io/apimachinery/pkg/types.UID
|
- ReadyReplicas are the number of Ready GameServer replicas +UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are +otherwise identical (parallel requests, requests when earlier requests did not modify etc) +The UID is meant to track the round trip (request/response) between the Autoscaler and the WebHook, not the user request. +It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging. |
-reservedReplicas
+name
-int32
+string
|
- ReservedReplicas are the number of Reserved GameServer replicas +Name is the name of the Fleet being scaled |
-allocatedReplicas
+namespace
-int32
+string
|
- AllocatedReplicas are the number of Allocated GameServer replicas +Namespace is the namespace associated with the request (if any). |
-shutdownReplicas
+status
-int32
+
+FleetStatus
+
|
- ShutdownReplicas are the number of Shutdown GameServers replicas +The Fleet’s status values |
(Appears on: -GameServer, -GameServerTemplateSpec) +FleetAutoscaleReview)
-
GameServerSpec is the spec for a GameServer resource
+FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
-container
-
-string
-
- |
-
- Container specifies which Pod container is the game server. Only required if there is more than one -container defined - |
-
-ports
-
-
-[]GameServerPort
-
-
- |
-
- Ports are the array of ports that can be exposed via the game server - |
-
-health
+uid
-
-Health
-
+k8s.io/apimachinery/pkg/types.UID
|
- Health configures health checking +UID is an identifier for the individual request/response. +This should be copied over from the corresponding FleetAutoscaleRequest. |
-scheduling
+scale
-agones.dev/agones/pkg/apis.SchedulingStrategy
+bool
|
- Scheduling strategy. Defaults to “Packed”. +Set to false if no scaling should occur to the Fleet |
-template
-
-
-Kubernetes core/v1.PodTemplateSpec
-
+replicas
+
+int32
|
- Template describes the Pod that will be created for the GameServer +The targeted replica count |
string alias)-(Appears on: -GameServerStatus) -
--
GameServerState is the state for the GameServer
- --(Appears on: -GameServer) -
--
GameServerStatus is the status for a GameServer resource
+FleetAutoscaleReview is passed to the webhook with a populated Request value, +and then returned with a populated Response.
-state
+request
-
-GameServerState
+
+FleetAutoscaleRequest
|
- GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc |
-ports
+response
-
-[]GameServerStatusPort
+
+FleetAutoscaleResponse
|
+(Appears on: +FleetAutoscalerSpec) +
++
FleetAutoscalerPolicy describes how to scale a fleet
+ +| Field | +Description | +
|---|---|
-address
+type
-string
+
+FleetAutoscalerPolicyType
+
|
+ Type of autoscaling policy. |
-nodeName
+buffer
-string
+
+BufferPolicy
+
|
+(Optional)
+ Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer. |
-reservedUntil
+webhook
-
-Kubernetes meta/v1.Time
+
+WebhookPolicy
|
+(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: -GameServerAllocationStatus, -GameServerStatus) +FleetAutoscaler)
-
GameServerStatusPort shows the port that was allocated to a -GameServer.
+FleetAutoscalerSpec is the spec for a Fleet Scaler
-name
+fleetName
string
@@ -4287,25 +4306,27 @@ GameServerStatusPort | |
-port
+policy
-int32
+
+FleetAutoscalerPolicy
+
|
+ Autoscaling policy |
(Appears on: -FleetSpec, -GameServerSetSpec) +FleetAutoscaler)
-
GameServerTemplateSpec is a template for GameServers
+FleetAutoscalerStatus defines the current status of a FleetAutoscaler
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec
-
-
-GameServerSpec
-
-
- |
-
- - -
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)
-
Health configures health checking on 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
-disabled
-
-bool
-
- |
-
- Disabled is whether health checking is disabled or not - |
-
-periodSeconds
+url
-int32
+string
|
- PeriodSeconds is the number of seconds each health ping has to occur in +(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. |
-failureThreshold
+service
-int32
+
+Kubernetes admissionregistration/v1beta1.ServiceReference
+
|
- FailureThreshold how many failures in a row constitutes unhealthy +(Optional) +
If the webhook is running within the cluster, then you should use Port 443 will be used if it is open, otherwise it is an error. |
-initialDelaySeconds
+caBundle
-int32
+[]byte
|
- InitialDelaySeconds initial delay before checking health +
|
string alias)-(Appears on: -GameServerPort) -
--
PortPolicy is the port policy for the GameServer
-
Generated with gen-crd-api-reference-docs.