@@ -6903,3 +6903,2132 @@ PortPolicy
{{% /feature %}}
+
+{{% feature publishVersion="0.12.0" %}}
+
Packages:
+
+allocation.agones.dev
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+
+Resource Types:
+
+GameServerAllocation
+
+
+
GameServerAllocation is the data structure for allocating against a set of
+GameServers, defined required and preferred selectors
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+apiVersion
+string |
+
+
+allocation.agones.dev/v1alpha1
+
+ |
+
+
+
+kind
+string
+ |
+GameServerAllocation |
+
+
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+
+
+spec
+
+
+GameServerAllocationSpec
+
+
+ |
+
+
+
+
+
+
+multiClusterSetting
+
+
+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.
+ |
+
+
+
+preferred
+
+
+[]Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+ Preferred ordered list of preferred allocations out of the required set.
+If the first selector is not matched,
+the selection attempts the second selector, and so on.
+ |
+
+
+
+scheduling
+
+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
+
+
+ |
+
+ |
+
+
+
+GameServerAllocationSpec
+
+
+(Appears on:
+GameServerAllocation)
+
+
+
GameServerAllocationSpec is the spec for a GameServerAllocation
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+multiClusterSetting
+
+
+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.
+ |
+
+
+
+preferred
+
+
+[]Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+ Preferred ordered list of preferred allocations out of the required set.
+If the first selector is not matched,
+the selection attempts the second selector, and so on.
+ |
+
+
+
+scheduling
+
+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
+ |
+
+
+
+GameServerAllocationState
+(string alias)
+
+(Appears on:
+GameServerAllocationStatus)
+
+
+
GameServerAllocationState is the Allocation state
+
+GameServerAllocationStatus
+
+
+(Appears on:
+GameServerAllocation)
+
+
+
GameServerAllocationStatus is the status for an GameServerAllocation resource
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+state
+
+
+GameServerAllocationState
+
+
+ |
+
+ GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated
+ |
+
+
+
+gameServerName
+
+string
+
+ |
+
+ |
+
+
+
+ports
+
+
+[]GameServerStatusPort
+
+
+ |
+
+ |
+
+
+
+address
+
+string
+
+ |
+
+ |
+
+
+
+nodeName
+
+string
+
+ |
+
+ |
+
+
+
+
+
+(Appears on:
+GameServerAllocationSpec)
+
+
+
MetaPatch is the metadata used to patch the GameServer metadata on allocation
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+labels
+
+map[string]string
+
+ |
+
+ |
+
+
+
+annotations
+
+map[string]string
+
+ |
+
+ |
+
+
+
+MultiClusterSetting
+
+
+(Appears on:
+GameServerAllocationSpec)
+
+
+
MultiClusterSetting specifies settings for multi-cluster allocation.
+
+
+
+autoscaling.agones.dev
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+
+Resource Types:
+
+FleetAutoscaler
+
+
+
FleetAutoscaler is the data structure for a FleetAutoscaler resource
+
+
+BufferPolicy
+
+
+(Appears on:
+FleetAutoscalerPolicy)
+
+
+
BufferPolicy controls the desired behavior of the buffer policy.
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+maxReplicas
+
+int32
+
+ |
+
+ MaxReplicas is the maximum amount of replicas that the fleet may have.
+It must be bigger than both MinReplicas and BufferSize
+ |
+
+
+
+minReplicas
+
+int32
+
+ |
+
+ MinReplicas is the minimum amount of replicas that the fleet must have
+If zero, it is ignored.
+If non zero, it must be smaller than MaxReplicas and bigger than BufferSize
+ |
+
+
+
+bufferSize
+
+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)
+ |
+
+
+
+FleetAutoscaleRequest
+
+
+(Appears on:
+FleetAutoscaleReview)
+
+
+
FleetAutoscaleRequest defines the request to webhook autoscaler endpoint
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+uid
+
+k8s.io/apimachinery/pkg/types.UID
+
+ |
+
+ UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
+otherwise identical (parallel requests, requests when earlier requests did not modify etc)
+The UID is meant to track the round trip (request/response) between the Autoscaler and the WebHook, not the user request.
+It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.
+ |
+
+
+
+name
+
+string
+
+ |
+
+ Name is the name of the Fleet being scaled
+ |
+
+
+
+namespace
+
+string
+
+ |
+
+ Namespace is the namespace associated with the request (if any).
+ |
+
+
+
+status
+
+
+FleetStatus
+
+
+ |
+
+ The Fleet’s status values
+ |
+
+
+
+FleetAutoscaleResponse
+
+
+(Appears on:
+FleetAutoscaleReview)
+
+
+
FleetAutoscaleResponse defines the response of webhook autoscaler endpoint
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+uid
+
+k8s.io/apimachinery/pkg/types.UID
+
+ |
+
+ UID is an identifier for the individual request/response.
+This should be copied over from the corresponding FleetAutoscaleRequest.
+ |
+
+
+
+scale
+
+bool
+
+ |
+
+ Set to false if no scaling should occur to the Fleet
+ |
+
+
+
+replicas
+
+int32
+
+ |
+
+ The targeted replica count
+ |
+
+
+
+FleetAutoscaleReview
+
+
+
FleetAutoscaleReview is passed to the webhook with a populated Request value,
+and then returned with a populated Response.
+
+
+FleetAutoscalerPolicy
+
+
+(Appears on:
+FleetAutoscalerSpec)
+
+
+
FleetAutoscalerPolicy describes how to scale a fleet
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+type
+
+
+FleetAutoscalerPolicyType
+
+
+ |
+
+ Type of autoscaling policy.
+ |
+
+
+
+buffer
+
+
+BufferPolicy
+
+
+ |
+
+(Optional)
+ Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer.
+ |
+
+
+
+webhook
+
+
+WebhookPolicy
+
+
+ |
+
+(Optional)
+ Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook.
+ |
+
+
+
+FleetAutoscalerPolicyType
+(string alias)
+
+(Appears on:
+FleetAutoscalerPolicy)
+
+
+
FleetAutoscalerPolicyType is the policy for autoscaling
+for a given Fleet
+
+FleetAutoscalerSpec
+
+
+(Appears on:
+FleetAutoscaler)
+
+
+
FleetAutoscalerSpec is the spec for a Fleet Scaler
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+fleetName
+
+string
+
+ |
+
+ |
+
+
+
+policy
+
+
+FleetAutoscalerPolicy
+
+
+ |
+
+ Autoscaling policy
+ |
+
+
+
+FleetAutoscalerStatus
+
+
+(Appears on:
+FleetAutoscaler)
+
+
+
FleetAutoscalerStatus defines the current status of a FleetAutoscaler
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+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
+
+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.
+ |
+
+
+
+WebhookPolicy
+
+
+(Appears on:
+FleetAutoscalerPolicy)
+
+
+
WebhookPolicy controls the desired behavior of the webhook policy.
+It contains the description of the webhook autoscaler service
+used to form url which is accessible inside the cluster
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+url
+
+string
+
+ |
+
+(Optional)
+ url gives the location of the webhook, in standard URL form
+([scheme://]host:port/path). Exactly one of url or service
+must be specified.
+The host should not refer to a service running in the cluster; use
+the service field instead. The host might be resolved via external
+DNS in some apiservers (e.g., kube-apiserver cannot resolve
+in-cluster DNS as that would be a layering violation). host may
+also be an IP address.
+Please note that using localhost or 127.0.0.1 as a host is
+risky unless you take great care to run this webhook on all hosts
+which run an apiserver which might need to make calls to this
+webhook. Such installs are likely to be non-portable, i.e., not easy
+to turn up in a new cluster.
+The scheme must be “https”; the URL must begin with “https://”.
+A path is optional, and if present may be any string permissible in
+a URL. You may use the path to pass an arbitrary string to the
+webhook, for example, a cluster identifier.
+Attempting to use a user or basic auth e.g. “user:password@” is not
+allowed. Fragments (“#…”) and query parameters (“?…”) are not
+allowed, either.
+ |
+
+
+
+service
+
+
+Kubernetes admissionregistration/v1beta1.ServiceReference
+
+
+ |
+
+(Optional)
+ service is a reference to the service for this webhook. Either
+service or url must be specified.
+If the webhook is running within the cluster, then you should use service.
+Port 443 will be used if it is open, otherwise it is an error.
+ |
+
+
+
+caBundle
+
+[]byte
+
+ |
+
+ caBundle is a PEM encoded CA bundle which will be used to validate
+the webhook’s server certificate.
+Required.
+ |
+
+
+
+
+stable.agones.dev
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+
+Resource Types:
+
+Fleet
+
+
+
Fleet is the data structure for a Fleet resource
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+apiVersion
+string |
+
+
+stable.agones.dev/v1alpha1
+
+ |
+
+
+
+kind
+string
+ |
+Fleet |
+
+
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+
+
+spec
+
+
+FleetSpec
+
+
+ |
+
+
+
+
+
+
+replicas
+
+int32
+
+ |
+
+ Replicas are the number of GameServers that should be in this set
+ |
+
+
+
+strategy
+
+
+Kubernetes apps/v1.DeploymentStrategy
+
+
+ |
+
+ Deployment strategy
+ |
+
+
+
+scheduling
+
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed”.
+ |
+
+
+
+template
+
+
+GameServerTemplateSpec
+
+
+ |
+
+ Template the GameServer template to apply for this Fleet
+ |
+
+
+ |
+
+
+
+status
+
+
+FleetStatus
+
+
+ |
+
+ |
+
+
+
+GameServer
+
+
+
GameServer is the data structure for a gameserver resource
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+apiVersion
+string |
+
+
+stable.agones.dev/v1alpha1
+
+ |
+
+
+
+kind
+string
+ |
+GameServer |
+
+
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+
+
+spec
+
+
+GameServerSpec
+
+
+ |
+
+
+
+
+
+
+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
+
+
+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
+ |
+
+
+ |
+
+
+
+status
+
+
+GameServerStatus
+
+
+ |
+
+ |
+
+
+
+GameServerSet
+
+
+
GameServerSet is the data structure a set of GameServers
+This matches philosophically with the relationship between
+Depoyments and ReplicaSets
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+apiVersion
+string |
+
+
+stable.agones.dev/v1alpha1
+
+ |
+
+
+
+kind
+string
+ |
+GameServerSet |
+
+
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+
+
+spec
+
+
+GameServerSetSpec
+
+
+ |
+
+
+
+
+
+
+replicas
+
+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
+ |
+
+
+ |
+
+
+
+status
+
+
+GameServerSetStatus
+
+
+ |
+
+ |
+
+
+
+FleetSpec
+
+
+(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
+ |
+
+
+
+strategy
+
+
+Kubernetes apps/v1.DeploymentStrategy
+
+
+ |
+
+ Deployment strategy
+ |
+
+
+
+scheduling
+
+agones.dev/agones/pkg/apis.SchedulingStrategy
+
+ |
+
+ Scheduling strategy. Defaults to “Packed”.
+ |
+
+
+
+template
+
+
+GameServerTemplateSpec
+
+
+ |
+
+ Template the GameServer template to apply for this Fleet
+ |
+
+
+
+FleetStatus
+
+
+(Appears on:
+Fleet,
+FleetAutoscaleRequest)
+
+
+
FleetStatus is the status of a Fleet
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+replicas
+
+int32
+
+ |
+
+ Replicas the total number of current GameServer replicas
+ |
+
+
+
+readyReplicas
+
+int32
+
+ |
+
+ ReadyReplicas are the number of Ready GameServer replicas
+ |
+
+
+
+reservedReplicas
+
+int32
+
+ |
+
+ 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
+ |
+
+
+
+GameServerPort
+
+
+(Appears on:
+GameServerSpec)
+
+
+
GameServerPort defines a set of Ports that
+are to be exposed via the GameServer
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+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 Static portPolicy is specified, HostPort is required, to specify the port that game clients will
+connect to
+ |
+
+
+
+containerPort
+
+int32
+
+ |
+
+ ContainerPort is the port that is being opened on the game server process
+ |
+
+
+
+hostPort
+
+int32
+
+ |
+
+ HostPort the port exposed on the host for clients to connect to
+ |
+
+
+
+protocol
+
+
+Kubernetes core/v1.Protocol
+
+
+ |
+
+ Protocol is the network protocol being used. Defaults to UDP. TCP is the only other option
+ |
+
+
+
+GameServerSetSpec
+
+
+(Appears on:
+GameServerSet)
+
+
+
GameServerSetSpec the specification for
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+replicas
+
+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
+ |
+
+
+
+GameServerSetStatus
+
+
+(Appears on:
+GameServerSet)
+
+
+
GameServerSetStatus is the status of a GameServerSet
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+replicas
+
+int32
+
+ |
+
+ Replicas the total number of current GameServer replicas
+ |
+
+
+
+readyReplicas
+
+int32
+
+ |
+
+ 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
+ |
+
+
+
+GameServerSpec
+
+
+(Appears on:
+GameServer,
+GameServerTemplateSpec)
+
+
+
GameServerSpec is the spec for a GameServer resource
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+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
+
+
+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
+ |
+
+
+
+GameServerState
+(string alias)
+
+(Appears on:
+GameServerStatus)
+
+
+
GameServerState is the state for the GameServer
+
+GameServerStatus
+
+
+(Appears on:
+GameServer)
+
+
+
GameServerStatus is the status for a GameServer resource
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+state
+
+
+GameServerState
+
+
+ |
+
+ GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc
+ |
+
+
+
+ports
+
+
+[]GameServerStatusPort
+
+
+ |
+
+ |
+
+
+
+address
+
+string
+
+ |
+
+ |
+
+
+
+nodeName
+
+string
+
+ |
+
+ |
+
+
+
+GameServerStatusPort
+
+
+(Appears on:
+GameServerAllocationStatus,
+GameServerStatus)
+
+
+
GameServerStatusPort shows the port that was allocated to a
+GameServer.
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+name
+
+string
+
+ |
+
+ |
+
+
+
+port
+
+int32
+
+ |
+
+ |
+
+
+
+GameServerTemplateSpec
+
+
+(Appears on:
+FleetSpec,
+GameServerSetSpec)
+
+
+
GameServerTemplateSpec is a template for GameServers
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+
+
+spec
+
+
+GameServerSpec
+
+
+ |
+
+
+
+
+
+
+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
+
+
+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
+ |
+
+
+ |
+
+
+
+Health
+
+
+(Appears on:
+GameServerSpec)
+
+
+
Health configures health checking on the GameServer
+
+
+
+
+| Field |
+Description |
+
+
+
+
+
+disabled
+
+bool
+
+ |
+
+ Disabled is whether health checking is disabled or not
+ |
+
+
+
+periodSeconds
+
+int32
+
+ |
+
+ 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
+ |
+
+
+
+PortPolicy
+(string alias)
+
+(Appears on:
+GameServerPort)
+
+
+
PortPolicy is the port policy for the GameServer
+
+
+
+Generated with gen-crd-api-reference-docs.
+
+{{% /feature %}}
+
diff --git a/test/e2e/fleet_test.go b/test/e2e/fleet_test.go
index 9c6e508851..65fe093312 100644
--- a/test/e2e/fleet_test.go
+++ b/test/e2e/fleet_test.go
@@ -49,82 +49,6 @@ const (
replicasCount = 3
)
-func TestCreateFleetAndFleetAllocate(t *testing.T) {
- t.Parallel()
-
- fixtures := []apis.SchedulingStrategy{apis.Packed, apis.Distributed}
-
- for _, strategy := range fixtures {
- t.Run(string(strategy), func(t *testing.T) {
- fleets := framework.AgonesClient.StableV1alpha1().Fleets(defaultNs)
- fleet := defaultFleet()
- fleet.Spec.Scheduling = strategy
- flt, err := fleets.Create(fleet)
- if assert.Nil(t, err) {
- defer fleets.Delete(flt.ObjectMeta.Name, nil) // nolint:errcheck
- }
-
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(flt.Spec.Replicas))
-
- fa := &v1alpha1.FleetAllocation{
- ObjectMeta: metav1.ObjectMeta{GenerateName: "allocation-", Namespace: defaultNs},
- Spec: v1alpha1.FleetAllocationSpec{
- FleetName: flt.ObjectMeta.Name,
- },
- }
-
- fa, err = framework.AgonesClient.StableV1alpha1().FleetAllocations(defaultNs).Create(fa)
- assert.Nil(t, err)
- assert.Equal(t, v1alpha1.GameServerStateAllocated, fa.Status.GameServer.Status.State)
- })
-
- }
-}
-
-// Can't allocate more GameServers if a fleet is fully used.
-func TestCreateFullFleetAndCantFleetAllocate(t *testing.T) {
- t.Parallel()
-
- fixtures := []apis.SchedulingStrategy{apis.Packed, apis.Distributed}
-
- for _, strategy := range fixtures {
- t.Run(string(strategy), func(t *testing.T) {
- fleets := framework.AgonesClient.StableV1alpha1().Fleets(defaultNs)
- fleet := defaultFleet()
- fleet.Spec.Scheduling = strategy
- flt, err := fleets.Create(fleet)
- if assert.Nil(t, err) {
- defer fleets.Delete(flt.ObjectMeta.Name, nil) // nolint:errcheck
- }
-
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(flt.Spec.Replicas))
-
- fa := &v1alpha1.FleetAllocation{
- ObjectMeta: metav1.ObjectMeta{GenerateName: "allocation-", Namespace: defaultNs},
- Spec: v1alpha1.FleetAllocationSpec{
- FleetName: flt.ObjectMeta.Name,
- },
- }
-
- for i := 0; i < replicasCount; i++ {
- fa2, err := framework.AgonesClient.StableV1alpha1().FleetAllocations(defaultNs).Create(fa)
- assert.Nil(t, err)
- assert.Equal(t, v1alpha1.GameServerStateAllocated, fa2.Status.GameServer.Status.State)
- }
-
- framework.WaitForFleetCondition(t, flt, func(fleet *v1alpha1.Fleet) bool {
- return fleet.Status.AllocatedReplicas == replicasCount
- })
-
- fa2, err := framework.AgonesClient.StableV1alpha1().FleetAllocations(defaultNs).Create(fa)
- assert.NotNil(t, err)
-
- assert.Nil(t, fa2.Status.GameServer)
- })
-
- }
-}
-
func TestFleetScaleUpEditAndScaleDown(t *testing.T) {
t.Parallel()
@@ -158,17 +82,12 @@ func TestFleetScaleUpEditAndScaleDown(t *testing.T) {
framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(targetScale))
// get an allocation
-
- fa := &v1alpha1.FleetAllocation{
- ObjectMeta: metav1.ObjectMeta{GenerateName: "allocation-", Namespace: defaultNs},
- Spec: v1alpha1.FleetAllocationSpec{
- FleetName: flt.ObjectMeta.Name,
- },
+ gsa := getAllocation(flt)
+ gsa, err = framework.AgonesClient.AllocationV1alpha1().GameServerAllocations(flt.ObjectMeta.Namespace).Create(gsa)
+ if !assert.Nil(t, err) {
+ assert.FailNow(t, "gameserverallocation could not be created")
}
-
- fa, err = alpha1.FleetAllocations(defaultNs).Create(fa)
- assert.Nil(t, err)
- assert.Equal(t, v1alpha1.GameServerStateAllocated, fa.Status.GameServer.Status.State)
+ assert.Equal(t, string(allocationv1alpha1.GameServerAllocationAllocated), string(gsa.Status.State))
framework.WaitForFleetCondition(t, flt, func(fleet *v1alpha1.Fleet) bool {
return fleet.Status.AllocatedReplicas == 1
})
@@ -214,7 +133,7 @@ func TestFleetScaleUpEditAndScaleDown(t *testing.T) {
// delete the allocated GameServer
gp := int64(1)
- err = alpha1.GameServers(defaultNs).Delete(fa.Status.GameServer.ObjectMeta.Name, &metav1.DeleteOptions{GracePeriodSeconds: &gp})
+ err = alpha1.GameServers(defaultNs).Delete(gsa.Status.GameServerName, &metav1.DeleteOptions{GracePeriodSeconds: &gp})
assert.Nil(t, err)
framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(1))
@@ -336,75 +255,6 @@ func TestFleetRollingUpdate(t *testing.T) {
}
}
-func TestScaleFleetUpAndDownWithFleetAllocation(t *testing.T) {
- t.Parallel()
-
- //Use scaleFleetPatch (true) or scaleFleetSubresource (false)
- fixtures := []bool{true, false}
-
- for _, usePatch := range fixtures {
- t.Run("Use fleet Patch "+fmt.Sprint(usePatch), func(t *testing.T) {
- alpha1 := framework.AgonesClient.StableV1alpha1()
-
- flt := defaultFleet()
- flt.Spec.Replicas = 1
- flt, err := alpha1.Fleets(defaultNs).Create(flt)
- if assert.Nil(t, err) {
- defer alpha1.Fleets(defaultNs).Delete(flt.ObjectMeta.Name, nil) // nolint:errcheck
- }
-
- assert.Equal(t, int32(1), flt.Spec.Replicas)
-
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(flt.Spec.Replicas))
-
- // scale up
- const targetScale = 3
- if usePatch {
- flt = scaleFleetPatch(t, flt, targetScale)
- assert.Equal(t, int32(targetScale), flt.Spec.Replicas)
- } else {
- flt = scaleFleetSubresource(t, flt, targetScale)
- }
-
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(targetScale))
-
- // get an allocation
- fa := &v1alpha1.FleetAllocation{
- ObjectMeta: metav1.ObjectMeta{GenerateName: "allocation-", Namespace: defaultNs},
- Spec: v1alpha1.FleetAllocationSpec{
- FleetName: flt.ObjectMeta.Name,
- },
- }
-
- fa, err = alpha1.FleetAllocations(defaultNs).Create(fa)
- assert.Nil(t, err)
- assert.Equal(t, v1alpha1.GameServerStateAllocated, fa.Status.GameServer.Status.State)
- framework.WaitForFleetCondition(t, flt, func(fleet *v1alpha1.Fleet) bool {
- return fleet.Status.AllocatedReplicas == 1
- })
-
- // scale down, with allocation
- const scaleDownTarget = 1
- if usePatch {
- flt = scaleFleetPatch(t, flt, scaleDownTarget)
- } else {
- flt = scaleFleetSubresource(t, flt, scaleDownTarget)
- }
-
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(0))
- // delete the allocated GameServer
- gp := int64(1)
- err = alpha1.GameServers(defaultNs).Delete(fa.Status.GameServer.ObjectMeta.Name, &metav1.DeleteOptions{GracePeriodSeconds: &gp})
- assert.Nil(t, err)
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(1))
-
- framework.WaitForFleetCondition(t, flt, func(fleet *v1alpha1.Fleet) bool {
- return fleet.Status.AllocatedReplicas == 0
- })
- })
- }
-}
-
func TestScaleFleetUpAndDownWithGameServerAllocation(t *testing.T) {
t.Parallel()
@@ -637,129 +487,6 @@ func TestReservedGameServerInFleet(t *testing.T) {
assert.NoError(t, err)
}
-// TestFleetAllocationDuringGameServerDeletion is built to specifically
-// test for race conditions of allocations when doing scale up/down,
-// rolling updates, etc. Failures may not happen ALL the time -- as that is the
-// nature of race conditions.
-// nolint: dupl
-func TestFleetAllocationDuringGameServerDeletion(t *testing.T) {
- t.Parallel()
-
- testAllocationRaceCondition := func(t *testing.T, fleet func() *v1alpha1.Fleet, deltaSleep time.Duration, delta func(t *testing.T, flt *v1alpha1.Fleet)) {
- alpha1 := framework.AgonesClient.StableV1alpha1()
-
- flt := fleet()
- flt.ApplyDefaults()
- size := int32(10)
- flt.Spec.Replicas = size
- flt, err := alpha1.Fleets(defaultNs).Create(flt)
- if assert.Nil(t, err) {
- defer alpha1.Fleets(defaultNs).Delete(flt.ObjectMeta.Name, nil) // nolint:errcheck
- }
-
- assert.Equal(t, size, flt.Spec.Replicas)
-
- framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(flt.Spec.Replicas))
-
- var allocs []*v1alpha1.GameServer
-
- wg := sync.WaitGroup{}
- wg.Add(2)
- go func() {
- for {
- // this gives room for fleet scaling to go down - makes it more likely for the race condition to fire
- time.Sleep(100 * time.Millisecond)
- fa := &v1alpha1.FleetAllocation{
- ObjectMeta: metav1.ObjectMeta{GenerateName: "allocation-", Namespace: defaultNs},
- Spec: v1alpha1.FleetAllocationSpec{
- FleetName: flt.ObjectMeta.Name,
- },
- }
- fa, err = framework.AgonesClient.StableV1alpha1().FleetAllocations(defaultNs).Create(fa)
- if err != nil {
- logrus.WithError(err).Info("Allocation ended")
- break
- }
- logrus.WithField("gs", fa.Status.GameServer.ObjectMeta.Name).Info("Allocated")
- allocs = append(allocs, fa.Status.GameServer)
- }
- wg.Done()
- }()
- go func() {
- // this tends to force the scaling to happen as we are fleet allocating
- time.Sleep(deltaSleep)
- // call the function that makes the change to the fleet
- logrus.Info("Applying delta function")
- delta(t, flt)
- wg.Done()
- }()
-
- wg.Wait()
- assert.NotEmpty(t, allocs)
-
- for _, gs := range allocs {
- gsCheck, err := alpha1.GameServers(defaultNs).Get(gs.ObjectMeta.Name, metav1.GetOptions{})
- assert.Nil(t, err)
- assert.True(t, gsCheck.ObjectMeta.DeletionTimestamp.IsZero())
- }
- }
-
- t.Run("scale down", func(t *testing.T) {
- t.Parallel()
-
- testAllocationRaceCondition(t, defaultFleet, time.Second,
- func(t *testing.T, flt *v1alpha1.Fleet) {
- const targetScale = int32(0)
- flt = scaleFleetPatch(t, flt, targetScale)
- assert.Equal(t, targetScale, flt.Spec.Replicas)
- })
- })
-
- t.Run("recreate update", func(t *testing.T) {
- t.Parallel()
-
- fleet := func() *v1alpha1.Fleet {
- flt := defaultFleet()
- flt.Spec.Strategy.Type = appsv1.RecreateDeploymentStrategyType
- flt.Spec.Template.ObjectMeta.Annotations = map[string]string{key: red}
-
- return flt
- }
-
- testAllocationRaceCondition(t, fleet, time.Second,
- func(t *testing.T, flt *v1alpha1.Fleet) {
- flt, err := framework.AgonesClient.StableV1alpha1().Fleets(defaultNs).Get(flt.ObjectMeta.Name, metav1.GetOptions{})
- assert.Nil(t, err)
- fltCopy := flt.DeepCopy()
- fltCopy.Spec.Template.ObjectMeta.Annotations[key] = green
- _, err = framework.AgonesClient.StableV1alpha1().Fleets(defaultNs).Update(fltCopy)
- assertSuccessOrUpdateConflict(t, err)
- })
- })
-
- t.Run("rolling update", func(t *testing.T) {
- t.Parallel()
-
- fleet := func() *v1alpha1.Fleet {
- flt := defaultFleet()
- flt.Spec.Strategy.Type = appsv1.RollingUpdateDeploymentStrategyType
- flt.Spec.Template.ObjectMeta.Annotations = map[string]string{key: red}
-
- return flt
- }
-
- testAllocationRaceCondition(t, fleet, time.Duration(0),
- func(t *testing.T, flt *v1alpha1.Fleet) {
- flt, err := framework.AgonesClient.StableV1alpha1().Fleets(defaultNs).Get(flt.ObjectMeta.Name, metav1.GetOptions{})
- assert.Nil(t, err)
- fltCopy := flt.DeepCopy()
- fltCopy.Spec.Template.ObjectMeta.Annotations[key] = green
- _, err = framework.AgonesClient.StableV1alpha1().Fleets(defaultNs).Update(fltCopy)
- assertSuccessOrUpdateConflict(t, err)
- })
- })
-}
-
// TestFleetGSSpecValidation is built to test Fleet's underlying Gameserver template
// validation. Gameserver Spec contained in a Fleet should be valid to create a fleet.
func TestFleetGSSpecValidation(t *testing.T) {
@@ -862,7 +589,6 @@ func assertSuccessOrUpdateConflict(t *testing.T, err error) {
// test for race conditions of allocations when doing scale up/down,
// rolling updates, etc. Failures may not happen ALL the time -- as that is the
// nature of race conditions.
-// nolint: dupl
func TestGameServerAllocationDuringGameServerDeletion(t *testing.T) {
t.Parallel()
diff --git a/test/e2e/fleetautoscaler_test.go b/test/e2e/fleetautoscaler_test.go
index 25eb610400..b7dcbb4685 100644
--- a/test/e2e/fleetautoscaler_test.go
+++ b/test/e2e/fleetautoscaler_test.go
@@ -21,6 +21,7 @@ import (
"testing"
"time"
+ allocationv1alpha1 "agones.dev/agones/pkg/apis/allocation/v1alpha1"
"agones.dev/agones/pkg/apis/autoscaling/v1alpha1"
stablev1alpha1 "agones.dev/agones/pkg/apis/stable/v1alpha1"
e2e "agones.dev/agones/test/e2e/framework"
@@ -83,10 +84,12 @@ func TestAutoscalerBasicFunctions(t *testing.T) {
framework.WaitForFleetCondition(t, flt, e2e.FleetReadyCount(bufferSize))
// do an allocation and watch the fleet scale up
- fa := getAllocation(flt)
- fa, err = stable.FleetAllocations(defaultNs).Create(fa)
- assert.Nil(t, err)
- assert.Equal(t, stablev1alpha1.GameServerStateAllocated, fa.Status.GameServer.Status.State)
+ gsa := getAllocation(flt)
+ gsa, err = framework.AgonesClient.AllocationV1alpha1().GameServerAllocations(flt.ObjectMeta.Namespace).Create(gsa)
+ if !assert.Nil(t, err) {
+ assert.FailNow(t, "gameserverallocation could not be created")
+ }
+ assert.Equal(t, string(allocationv1alpha1.GameServerAllocationAllocated), string(gsa.Status.State))
framework.WaitForFleetCondition(t, flt, func(fleet *stablev1alpha1.Fleet) bool {
return fleet.Status.AllocatedReplicas == 1
})
@@ -121,7 +124,7 @@ func TestAutoscalerBasicFunctions(t *testing.T) {
// delete the allocated GameServer and watch the fleet scale down
gp := int64(1)
- err = stable.GameServers(defaultNs).Delete(fa.Status.GameServer.ObjectMeta.Name, &metav1.DeleteOptions{GracePeriodSeconds: &gp})
+ err = stable.GameServers(defaultNs).Delete(gsa.Status.GameServerName, &metav1.DeleteOptions{GracePeriodSeconds: &gp})
assert.Nil(t, err)
framework.WaitForFleetCondition(t, flt, func(fleet *stablev1alpha1.Fleet) bool {
return fleet.Status.AllocatedReplicas == 0 &&
@@ -240,16 +243,6 @@ func defaultFleetAutoscaler(f *stablev1alpha1.Fleet) *v1alpha1.FleetAutoscaler {
}
}
-func getAllocation(f *stablev1alpha1.Fleet) *stablev1alpha1.FleetAllocation {
- // get an allocation
- return &stablev1alpha1.FleetAllocation{
- ObjectMeta: metav1.ObjectMeta{GenerateName: "allocation-", Namespace: f.ObjectMeta.Namespace},
- Spec: stablev1alpha1.FleetAllocationSpec{
- FleetName: f.ObjectMeta.Name,
- },
- }
-}
-
//Test fleetautoscaler with webhook policy type
// scaling from Replicas equals to 1 to 2
func TestAutoscalerWebhook(t *testing.T) {
@@ -304,10 +297,13 @@ func TestAutoscalerWebhook(t *testing.T) {
// if we could not create the autoscaler, there is no point going further
assert.FailNow(t, "Failed creating autoscaler, aborting TestAutoscalerWebhook")
}
- fa := getAllocation(flt)
- fa, err = alpha1.FleetAllocations(defaultNs).Create(fa)
- assert.Nil(t, err)
- assert.Equal(t, stablev1alpha1.GameServerStateAllocated, fa.Status.GameServer.Status.State)
+ gsa := getAllocation(flt)
+ gsa, err = framework.AgonesClient.AllocationV1alpha1().GameServerAllocations(flt.ObjectMeta.Namespace).Create(gsa)
+ if !assert.Nil(t, err) {
+ assert.FailNow(t, "gameserverallocation could not be created")
+ }
+ assert.Equal(t, string(allocationv1alpha1.GameServerAllocationAllocated), string(gsa.Status.State))
+
framework.WaitForFleetCondition(t, flt, func(fleet *stablev1alpha1.Fleet) bool {
return fleet.Status.AllocatedReplicas == 1
})
@@ -523,10 +519,12 @@ func TestTlsWebhook(t *testing.T) {
// if we could not create the autoscaler, their is no point going further
assert.FailNow(t, "Failed creating autoscaler, aborting TestTlsWebhook")
}
- fa := getAllocation(flt)
- fa, err = alpha1.FleetAllocations(defaultNs).Create(fa.DeepCopy())
- assert.Nil(t, err)
- assert.Equal(t, stablev1alpha1.GameServerStateAllocated, fa.Status.GameServer.Status.State)
+ gsa := getAllocation(flt)
+ gsa, err = framework.AgonesClient.AllocationV1alpha1().GameServerAllocations(flt.ObjectMeta.Namespace).Create(gsa)
+ if !assert.Nil(t, err) {
+ assert.FailNow(t, "gameserverallocation could not be created")
+ }
+ assert.Equal(t, string(allocationv1alpha1.GameServerAllocationAllocated), string(gsa.Status.State))
framework.WaitForFleetCondition(t, flt, func(fleet *stablev1alpha1.Fleet) bool {
return fleet.Status.AllocatedReplicas == 1
})
diff --git a/test/e2e/framework/framework.go b/test/e2e/framework/framework.go
index 831649337c..6ec0ab6a69 100644
--- a/test/e2e/framework/framework.go
+++ b/test/e2e/framework/framework.go
@@ -262,11 +262,6 @@ func (f *Framework) CleanUp(ns string) error {
return err
}
- err = stable.FleetAllocations(ns).DeleteCollection(deleteOptions, listOptions)
- if err != nil {
- return err
- }
-
err = f.AgonesClient.AutoscalingV1alpha1().FleetAutoscalers(ns).DeleteCollection(deleteOptions, listOptions)
if err != nil {
return err
diff --git a/test/e2e/main_test.go b/test/e2e/main_test.go
index 499dcd1081..72f087428a 100644
--- a/test/e2e/main_test.go
+++ b/test/e2e/main_test.go
@@ -22,8 +22,11 @@ import (
"path/filepath"
"testing"
+ allocationv1alpha1 "agones.dev/agones/pkg/apis/allocation/v1alpha1"
+ stablev1alpha1 "agones.dev/agones/pkg/apis/stable/v1alpha1"
e2eframework "agones.dev/agones/test/e2e/framework"
"github.com/sirupsen/logrus"
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
const defaultNs = "default"
@@ -80,3 +83,13 @@ func TestMain(m *testing.M) {
exitCode = m.Run()
}
+
+// utility functions
+
+func getAllocation(f *stablev1alpha1.Fleet) *allocationv1alpha1.GameServerAllocation {
+ // get an allocation
+ return &allocationv1alpha1.GameServerAllocation{
+ Spec: allocationv1alpha1.GameServerAllocationSpec{
+ Required: metav1.LabelSelector{MatchLabels: map[string]string{stablev1alpha1.FleetNameLabel: f.ObjectMeta.Name}},
+ }}
+}