From 780ca22efbb0b9ef71be1cc505b75241cdda70ba Mon Sep 17 00:00:00 2001 From: Robert Bailey Date: Thu, 11 Jul 2019 17:17:36 -0700 Subject: [PATCH] Run `make gen-api-docs`. --- .../Reference/agones_crd_api_reference.html | 1622 ++++++++--------- 1 file changed, 811 insertions(+), 811 deletions(-) diff --git a/site/content/en/docs/Reference/agones_crd_api_reference.html b/site/content/en/docs/Reference/agones_crd_api_reference.html index b5d322e390..00246095b2 100644 --- a/site/content/en/docs/Reference/agones_crd_api_reference.html +++ b/site/content/en/docs/Reference/agones_crd_api_reference.html @@ -2351,28 +2351,31 @@

PortPolicy

Packages:

-

allocation.agones.dev

+

agones.dev

Package v1 is the v1 version of the API.

Resource Types: -

GameServerAllocation +

Fleet

-

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

@@ -2388,7 +2391,7 @@

GameServerAllocation string

@@ -2397,7 +2400,7 @@

GameServerAllocation kind
string -

+ @@ -2428,44 +2431,26 @@

GameServerAllocation

-allocation.agones.dev/v1 +agones.dev/v1
GameServerAllocationFleet
@@ -2417,8 +2420,8 @@

GameServerAllocation

spec
- -GameServerAllocationSpec + +FleetSpec
- - - - @@ -2481,16 +2466,15 @@

GameServerAllocation

-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 required set. -If the first selector is not matched, -the selection attempts the second selector, and so on.

+

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
@@ -2500,8 +2484,8 @@

GameServerAllocation status
- -GameServerAllocationStatus + +FleetStatus @@ -2510,14 +2494,10 @@

GameServerAllocation -

GameServerAllocationSpec +

GameServer

-(Appears on: -GameServerAllocation) -

-

-

GameServerAllocationSpec is the spec for a GameServerAllocation

+

GameServer is the data structure for a GameServer resource

@@ -2529,149 +2509,120 @@

GameServerAllocationSpec

+ + + + - +
+
+
-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 required set. -If the first selector is not matched, -the selection attempts the second selector, and so on.

-
- -
-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
-

GameServerAllocationState -(string alias)

-

-(Appears on: -GameServerAllocationStatus) -

-

-

GameServerAllocationState is the Allocation state

-

-

GameServerAllocationStatus -

-

-(Appears on: -GameServerAllocation) -

-

-

GameServerAllocationStatus is the status for an GameServerAllocation resource

-

- - - - - - - - - - -
FieldDescription
-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 + @@ -2679,14 +2630,12 @@

GameServerAllocationStatus -

MetaPatch +

GameServerSet

-(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

@@ -2698,154 +2647,81 @@

MetaPatch

+apiVersion
+string - + - -
-labels
- -map[string]string - -		 + +agones.dev/v1 +
-annotations
- -map[string]string - -		 +kind
+string 		GameServerSet
-

MultiClusterSetting -

-

-(Appears on: -GameServerAllocationSpec) -

-

-

MultiClusterSetting specifies settings for multi-cluster allocation.

-

- - - - - - - - - - -
FieldDescription
-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 		-
-
-

autoscaling.agones.dev

-

-

Package v1 is the v1 version of the API.

-

-Resource Types: - -

FleetAutoscaler -

-

-

FleetAutoscaler is the data structure for a FleetAutoscaler resource

-

+
+
- - - - - - - - - - - - - - - - @@ -2865,14 +2741,14 @@

FleetAutoscaler

FieldDescription
-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 - - -		 -
-
- - -
-fleetName
+scheduling
-string +agones.dev/agones/pkg/apis.SchedulingStrategy 		+

Scheduling strategy. Defaults to “Packed”.
-policy
+template
- -FleetAutoscalerPolicy + +GameServerTemplateSpec 		-

Autoscaling policy

+

Template the GameServer template to apply for this GameServerSet
@@ -2855,8 +2731,8 @@

FleetAutoscaler

status
- -FleetAutoscalerStatus + +GameServerSetStatus
-

BufferPolicy +

FleetSpec

(Appears on: -FleetAutoscalerPolicy) +Fleet)

-

BufferPolicy controls the desired behavior of the buffer policy.

+

FleetSpec is the spec for a Fleet

@@ -2884,59 +2760,63 @@

BufferPolicy

+ + + +
-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
-

FleetAutoscaleRequest +

FleetStatus

(Appears on: -FleetAutoscaleReview) +Fleet, +FleetAutoscaleRequest)

-

FleetAutoscaleRequest defines the request to webhook autoscaler endpoint

+

FleetStatus is the status of a Fleet

@@ -2948,63 +2828,60 @@

FleetAutoscaleRequest

-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
-

FleetAutoscaleResponse +

GameServerPort

(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

@@ -3016,88 +2893,77 @@

FleetAutoscaleResponse

- -
-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 Static portPolicy is specified, HostPort is required, to specify the port that game clients will +connect to
-replicas
+containerPort
int32 		-

The targeted replica count

+

ContainerPort is the port that is being opened on the game server process
-

FleetAutoscaleReview -

-

-

FleetAutoscaleReview is passed to the webhook with a populated Request value, -and then returned with a populated Response.

-

- - - - - - - -
FieldDescription
-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
-

FleetAutoscalerPolicy +

GameServerSetSpec

(Appears on: -FleetAutoscalerSpec) +GameServerSet)

-

FleetAutoscalerPolicy describes how to scale a fleet

+

GameServerSetSpec the specification for GameServerSet

@@ -3109,65 +2975,49 @@

FleetAutoscalerPolicy

-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
-

FleetAutoscalerPolicyType -(string alias)

-

-(Appears on: -FleetAutoscalerPolicy) -

-

-

FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet

-

-

FleetAutoscalerSpec +

GameServerSetStatus

(Appears on: -FleetAutoscaler) +GameServerSet)

-

FleetAutoscalerSpec is the spec for a Fleet Scaler

+

GameServerSetStatus is the status of a GameServerSet

@@ -3179,37 +3029,70 @@

FleetAutoscalerSpec

+ + + + + + + + + + + +
-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
-

FleetAutoscalerStatus +

GameServerSpec

(Appears on: -FleetAutoscaler) +GameServer, +GameServerTemplateSpec)

-

FleetAutoscalerStatus defines the current status of a FleetAutoscaler

+

GameServerSpec is the spec for a GameServer resource

@@ -3221,77 +3104,85 @@

FleetAutoscalerStatus

-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
-

WebhookPolicy +

GameServerState +(string alias)

+

+(Appears on: +GameServerStatus) +

+

+

GameServerState is the state for the GameServer

+

+

GameServerStatus

(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

@@ -3303,84 +3194,73 @@

WebhookPolicy

+ + + + + + + +
-url
+state
-string + +GameServerState + 		-(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.

+

GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc
-service
+ports
- -Kubernetes admissionregistration/v1beta1.ServiceReference + +[]GameServerStatusPort 		-(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
+address
-[]byte +string + +		 +
+nodeName
+ +string + +		 +
+reservedUntil
+ + +Kubernetes meta/v1.Time + 		-

caBundle is a PEM encoded CA bundle which will be used to validate -the webhook’s server certificate. -Required.
-
-

stable.agones.dev

+

GameServerStatusPort +

-

Package v1alpha1 is the v1alpha1 version of the API.

+(Appears on: +GameServerAllocationStatus, +GameServerStatus)

-Resource Types: - -

Fleet -

-

Fleet is the data structure for a Fleet resource

+

GameServerStatusPort shows the port that was allocated to a +GameServer.

@@ -3392,21 +3272,44 @@

Fleet

+name
+ +string + + - + + + +
-apiVersion
-string		 - -stable.agones.dev/v1alpha1 -
-kind
-string +port
+ +int32 + 		Fleet +
+

GameServerTemplateSpec +

+

+(Appears on: +FleetSpec, +GameServerSetSpec) +

+

+

GameServerTemplateSpec is a template for GameServers

+

+ + + + + + + @@ -3436,73 +3339,157 @@

Fleet

FieldDescription
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

+
+ + + + +

Health +

+

+(Appears on: +GameServerSpec) +

+

+

Health configures health checking on the GameServer

+

+ + + + + + + - -
FieldDescription
-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

-

GameServer +

PortPolicy +(string alias)

+

+(Appears on: +GameServerPort) +

+

+

PortPolicy is the port policy for the GameServer

+

+
+

allocation.agones.dev

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

GameServerAllocation

-

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

@@ -3518,7 +3505,7 @@

GameServer string

@@ -3527,7 +3514,7 @@

GameServer kind
string -

+ @@ -3558,40 +3545,44 @@

GameServer

-stable.agones.dev/v1alpha1 +allocation.agones.dev/v1
GameServerGameServerAllocation
@@ -3547,8 +3534,8 @@

GameServer

spec
- -GameServerSpec + +GameServerAllocationSpec
@@ -3607,15 +3598,16 @@

GameServer

-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 required set. +If the first selector is not matched, +the selection attempts the second selector, and so on.
-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
@@ -3625,8 +3617,8 @@

GameServer status
- -GameServerStatus + +GameServerAllocationStatus @@ -3635,12 +3627,14 @@

GameServer -

GameServerSet +

GameServerAllocationSpec

-

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

@@ -3652,57 +3646,44 @@

GameServerSet

- - - - - - - - - - -
-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 		-
-
- +

Required The required allocation. Defaults to all GameServers.

+ + @@ -3718,42 +3699,37 @@

GameServerSet

- - -
-replicas
+preferred
-int32 + +[]Kubernetes meta/v1.LabelSelector + 		-

Replicas are the number of GameServers that should be in this set

+

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.
-template
- - -GameServerTemplateSpec - - -		 -

Template the GameServer template to apply for this GameServerSet

-
-
-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
-

FleetSpec +

GameServerAllocationState +(string alias)

+

+(Appears on: +GameServerAllocationStatus) +

+

+

GameServerAllocationState is the Allocation state

+

+

GameServerAllocationStatus

(Appears on: -Fleet) +GameServerAllocation)

-

FleetSpec is the spec for a Fleet

+

GameServerAllocationStatus is the status for an GameServerAllocation resource

@@ -3765,63 +3741,69 @@

FleetSpec

+ + + +
-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
-

FleetStatus +

MetaPatch

(Appears on: -Fleet, -FleetAutoscaleRequest) +GameServerAllocationSpec)

-

FleetStatus is the status of a Fleet

+

MetaPatch is the metadata used to patch the GameServer metadata on allocation

@@ -3833,60 +3815,80 @@

FleetStatus

+ +
-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
+

MultiClusterSetting +

+

+(Appears on: +GameServerAllocationSpec) +

+

+

MultiClusterSetting specifies settings for multi-cluster allocation.

+

+ + + + + + + +
FieldDescription
-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
-

GameServerPort -

+
+

autoscaling.agones.dev

-(Appears on: -GameServerSpec) +

Package v1 is the v1 version of the API.

+Resource Types: + +

FleetAutoscaler +

-

GameServerPort defines a set of Ports that -are to be exposed via the GameServer

+

FleetAutoscaler is the data structure for a FleetAutoscaler resource

@@ -3898,77 +3900,96 @@

GameServerPort

+ + + + +
-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 Static portPolicy is specified, HostPort is required, to specify the port that game clients will -connect to

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-containerPort
+spec
-int32 + +FleetAutoscalerSpec + + +		 +
+
+ + + + +
+fleetName
+ +string 		-

ContainerPort is the port that is being opened on the game server process
-hostPort
+policy
-int32 + +FleetAutoscalerPolicy + 		-

HostPort the port exposed on the host for clients to connect to

+

Autoscaling policy

+
-protocol
+status
- -Kubernetes core/v1.Protocol + +FleetAutoscalerStatus 		-

Protocol is the network protocol being used. Defaults to UDP. TCP is the only other option
-

GameServerSetSpec +

BufferPolicy

(Appears on: -GameServerSet) +FleetAutoscalerPolicy)

-

GameServerSetSpec the specification for GameServerSet

+

BufferPolicy controls the desired behavior of the buffer policy.

@@ -3980,49 +4001,59 @@

GameServerSetSpec

-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)
-

GameServerSetStatus +

FleetAutoscaleRequest

(Appears on: -GameServerSet) +FleetAutoscaleReview)

-

GameServerSetStatus is the status of a GameServerSet

+

FleetAutoscaleRequest defines the request to webhook autoscaler endpoint

@@ -4034,70 +4065,63 @@

GameServerSetStatus

- - - -
-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
-

GameServerSpec +

FleetAutoscaleResponse

(Appears on: -GameServer, -GameServerTemplateSpec) +FleetAutoscaleReview)

-

GameServerSpec is the spec for a GameServer resource

+

FleetAutoscaleResponse defines the response of webhook autoscaler endpoint

@@ -4109,85 +4133,45 @@

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
+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
-

GameServerState -(string alias)

-

-(Appears on: -GameServerStatus) -

-

-

GameServerState is the state for the GameServer

-

-

GameServerStatus +

FleetAutoscaleReview

-(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.

@@ -4199,73 +4183,108 @@

GameServerStatus

+ +
-state
+request
- -GameServerState + +FleetAutoscaleRequest 		-

GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc
-ports
+response
- -[]GameServerStatusPort + +FleetAutoscaleResponse
+

FleetAutoscalerPolicy +

+

+(Appears on: +FleetAutoscalerSpec) +

+

+

FleetAutoscalerPolicy describes how to scale a fleet

+

+ + + + + + + +
FieldDescription
-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.
-

GameServerStatusPort +

FleetAutoscalerPolicyType +(string alias)

+

+(Appears on: +FleetAutoscalerPolicy) +

+

+

FleetAutoscalerPolicyType is the policy for autoscaling +for a given Fleet

+

+

FleetAutoscalerSpec

(Appears on: -GameServerAllocationStatus, -GameServerStatus) +FleetAutoscaler)

-

GameServerStatusPort shows the port that was allocated to a -GameServer.

+

FleetAutoscalerSpec is the spec for a Fleet Scaler

@@ -4277,7 +4296,7 @@

GameServerStatusPort

-name
+fleetName
string @@ -4287,25 +4306,27 @@

GameServerStatusPort

-port
+policy
-int32 + +FleetAutoscalerPolicy + 		+

Autoscaling policy
-

GameServerTemplateSpec +

FleetAutoscalerStatus

(Appears on: -FleetSpec, -GameServerSetSpec) +FleetAutoscaler)

-

GameServerTemplateSpec is a template for GameServers

+

FleetAutoscalerStatus defines the current status of a FleetAutoscaler

@@ -4317,106 +4338,77 @@

GameServerTemplateSpec

- - - - -
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -GameServerSpec - - -		 -
-
- - - - -
-container
+currentReplicas
-string +int32 		-

Container specifies which Pod container is the game server. Only required if there is more than one -container defined

+

CurrentReplicas is the current number of gameserver replicas +of the fleet managed by this autoscaler, as last seen by the autoscaler
-ports
+desiredReplicas
- -[]GameServerPort - +int32 		-

Ports are the array of ports that can be exposed via the game server

+

DesiredReplicas is the desired number of gameserver replicas +of the fleet managed by this autoscaler, as last calculated by the autoscaler
-health
+lastScaleTime
- -Health + +Kubernetes meta/v1.Time 		-

Health configures health checking

+(Optional) +

lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet,
-scheduling
+ableToScale
-agones.dev/agones/pkg/apis.SchedulingStrategy +bool 		-

Scheduling strategy. Defaults to “Packed”.

+

AbleToScale indicates that we can access the target fleet
-template
+scalingLimited
- -Kubernetes core/v1.PodTemplateSpec - +bool 		-

Template describes the Pod that will be created for the GameServer

-
+

ScalingLimited indicates that the calculated scale would be above or below the range +defined by MinReplicas and MaxReplicas, and has thus been capped.
-

Health +

WebhookPolicy

(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

@@ -4428,59 +4420,67 @@

Health

- - - -
-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) +

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.
-failureThreshold
+service
-int32 + +Kubernetes admissionregistration/v1beta1.ServiceReference + 		-

FailureThreshold how many failures in a row constitutes unhealthy

+(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.
-initialDelaySeconds
+caBundle
-int32 +[]byte 		-

InitialDelaySeconds initial delay before checking health

+

caBundle is a PEM encoded CA bundle which will be used to validate +the webhook’s server certificate. +Required.
-

PortPolicy -(string alias)

-

-(Appears on: -GameServerPort) -

-

-

PortPolicy is the port policy for the GameServer

-

Generated with gen-crd-api-reference-docs.