From 8bc2e2731038c3767ccba37ef2b314f9641e9e8c Mon Sep 17 00:00:00 2001 From: Alexey Date: Wed, 15 Jul 2020 02:17:56 +0300 Subject: [PATCH] Added new gen-install-alpha command (#1673) * Described how to add parameters to yaml using helm * added crd api reference --- .../docs/Installation/Install Agones/yaml.md | 15 + .../Reference/agones_crd_api_reference.html | 1448 ++++++++--------- 2 files changed, 736 insertions(+), 727 deletions(-) diff --git a/site/content/en/docs/Installation/Install Agones/yaml.md b/site/content/en/docs/Installation/Install Agones/yaml.md index 14c29972f7..d337095714 100644 --- a/site/content/en/docs/Installation/Install Agones/yaml.md +++ b/site/content/en/docs/Installation/Install Agones/yaml.md @@ -19,6 +19,21 @@ kubectl create namespace agones-system kubectl apply -f https://raw.githubusercontent.com/googleforgames/agones/{{< release-branch >}}/install/yaml/install.yaml ``` +If you want to change the parameters in the `install.yaml` file, you can use helm directly to generate a custom file locally, but make sure new parameters correspond to the [following ones](https://agones.dev/site/docs/installation/install-agones/helm/#configuration). + +Example of setting `featureGates` and `generateTLS` helm parameters in `install.yaml`: +``` +helm pull --untar https://agones.dev/chart/stable/agones-{{< release-version >}}.tgz && \ +cd agones && \ +helm3 template agones-manual --namespace agones-system . \ + --set agones.controller.generateTLS=false \ + --set agones.allocator.generateTLS=false \ + --set agones.crds.cleanupOnDelete=false \ + --set agones.featureGates="PlayerTracking=true" \ + > install-custom.yaml +``` +Note: `pull` command was introduced in helm 3. + You can also find the install.yaml in the latest `agones-install` zip from the [releases](https://github.com/googleforgames/agones/releases) archive. ## Next Steps 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 5584eecd45..8f16b2c209 100644 --- a/site/content/en/docs/Reference/agones_crd_api_reference.html +++ b/site/content/en/docs/Reference/agones_crd_api_reference.html @@ -3,35 +3,35 @@ description="Detailed list of Agones Custom Resource Definitions available" +++ -{{% feature expiryVersion="1.7.0" %}} +{{% feature expiryVersion="1.8.0" %}}

Packages:

-

agones.dev

+

agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

Fleet +

Fleet

Fleet is the data structure for a Fleet resource

@@ -79,7 +79,7 @@

Fleet spec
- + FleetSpec @@ -127,7 +127,7 @@

Fleet template
- + GameServerTemplateSpec @@ -143,7 +143,7 @@

Fleet status
- + FleetStatus @@ -153,7 +153,7 @@

Fleet -

GameServer +

GameServer

GameServer is the data structure for a GameServer resource. @@ -205,7 +205,7 @@

GameServer spec
- + GameServerSpec @@ -230,7 +230,7 @@

GameServer ports
- + []GameServerPort @@ -243,7 +243,7 @@

GameServer health
- + Health @@ -267,7 +267,7 @@

GameServer sdkServer
- + SdkServer @@ -293,7 +293,7 @@

GameServer players
- + PlayersSpec @@ -310,7 +310,7 @@

GameServer status
- + GameServerStatus @@ -320,7 +320,7 @@

GameServer -

GameServerSet +

GameServerSet

GameServerSet is the data structure for a set of GameServers. @@ -370,7 +370,7 @@

GameServerSet spec
- + GameServerSetSpec @@ -405,7 +405,7 @@

GameServerSet template
- + GameServerTemplateSpec @@ -421,7 +421,7 @@

GameServerSet status
- + GameServerSetStatus @@ -431,12 +431,12 @@

GameServerSet -

AggregatedPlayerStatus +

AggregatedPlayerStatus

(Appears on: -FleetStatus, -GameServerSetStatus) +FleetStatus, +GameServerSetStatus)

AggregatedPlayerStatus stores total player tracking values

@@ -471,11 +471,11 @@

AggregatedPlayerStatus -

FleetSpec +

FleetSpec

(Appears on: -Fleet) +Fleet)

FleetSpec is the spec for a Fleet

@@ -527,7 +527,7 @@

FleetSpec template
- + GameServerTemplateSpec @@ -538,12 +538,12 @@

FleetSpec -

FleetStatus +

FleetStatus

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

FleetStatus is the status of a Fleet

@@ -605,7 +605,7 @@

FleetStatus players
- + AggregatedPlayerStatus @@ -619,11 +619,11 @@

FleetStatus -

GameServerPort +

GameServerPort

(Appears on: -GameServerSpec) +GameServerSpec)

GameServerPort defines a set of Ports that @@ -652,7 +652,7 @@

GameServerPort portPolicy
- + PortPolicy @@ -675,7 +675,7 @@

GameServerPort (Optional)

Container is the name of the container on which to open the port. Defaults to the game server container. -This field is alpha-level and is only honored by servers that enable the “ContainerPortAllocation” feature.

+This field is beta-level and is enabled by default, could be disabled by the “ContainerPortAllocation” feature.

@@ -715,11 +715,11 @@

GameServerPort -

GameServerSetSpec +

GameServerSetSpec

(Appears on: -GameServerSet) +GameServerSet)

GameServerSetSpec the specification for GameServerSet

@@ -758,7 +758,7 @@

GameServerSetSpec template
- + GameServerTemplateSpec @@ -769,11 +769,11 @@

GameServerSetSpec -

GameServerSetStatus +

GameServerSetStatus

(Appears on: -GameServerSet) +GameServerSet)

GameServerSetStatus is the status of a GameServerSet

@@ -845,7 +845,7 @@

GameServerSetStatus players
- + AggregatedPlayerStatus @@ -859,12 +859,12 @@

GameServerSetStatus -

GameServerSpec +

GameServerSpec

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

GameServerSpec is the spec for a GameServer resource

@@ -893,7 +893,7 @@

GameServerSpec ports
- + []GameServerPort @@ -906,7 +906,7 @@

GameServerSpec health
- + Health @@ -930,7 +930,7 @@

GameServerSpec sdkServer
- + SdkServer @@ -956,7 +956,7 @@

GameServerSpec players
- + PlayersSpec @@ -968,20 +968,20 @@

GameServerSpec -

GameServerState +

GameServerState (string alias)

(Appears on: -GameServerStatus) +GameServerStatus)

GameServerState is the state for the GameServer

-

GameServerStatus +

GameServerStatus

(Appears on: -GameServer) +GameServer)

GameServerStatus is the status for a GameServer resource

@@ -998,7 +998,7 @@

GameServerStatus state
- + GameServerState @@ -1011,7 +1011,7 @@

GameServerStatus ports
- + []GameServerStatusPort @@ -1055,7 +1055,7 @@

GameServerStatus players
- + PlayerStatus @@ -1068,12 +1068,12 @@

GameServerStatus -

GameServerStatusPort +

GameServerStatusPort

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

GameServerStatusPort shows the port that was allocated to a @@ -1109,12 +1109,12 @@

GameServerStatusPort -

GameServerTemplateSpec +

GameServerTemplateSpec

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

GameServerTemplateSpec is a template for GameServers

@@ -1145,7 +1145,7 @@

GameServerTemplateSpec spec
- + GameServerSpec @@ -1170,7 +1170,7 @@

GameServerTemplateSpec ports
- + []GameServerPort @@ -1183,7 +1183,7 @@

GameServerTemplateSpec health
- + Health @@ -1207,7 +1207,7 @@

GameServerTemplateSpec sdkServer
- + SdkServer @@ -1233,7 +1233,7 @@

GameServerTemplateSpec players
- + PlayersSpec @@ -1248,11 +1248,11 @@

GameServerTemplateSpec -

Health +

Health

(Appears on: -GameServerSpec) +GameServerSpec)

Health configures health checking on the GameServer

@@ -1311,11 +1311,11 @@

Health -

PlayerStatus +

PlayerStatus

(Appears on: -GameServerStatus) +GameServerStatus)

PlayerStatus stores the current player capacity values

@@ -1360,11 +1360,11 @@

PlayerStatus -

PlayersSpec +

PlayersSpec

(Appears on: -GameServerSpec) +GameServerSpec)

PlayersSpec tracks the initial player capacity

@@ -1389,20 +1389,20 @@

PlayersSpec -

PortPolicy +

PortPolicy (string alias)

(Appears on: -GameServerPort) +GameServerPort)

PortPolicy is the port policy for the GameServer

-

SdkServer +

SdkServer

(Appears on: -GameServerSpec) +GameServerSpec)

SdkServer specifies parameters for the Agones SDK Server sidecar container

@@ -1419,7 +1419,7 @@

SdkServer logLevel
- + SdkServerLogLevel @@ -1452,25 +1452,25 @@

SdkServer -

SdkServerLogLevel +

SdkServerLogLevel (string alias)

(Appears on: -SdkServer) +SdkServer)

SdkServerLogLevel is the log level for SDK server (sidecar) logs

-

allocation.agones.dev

+

allocation.agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

GameServerAllocation +

GameServerAllocation

GameServerAllocation is the data structure for allocating against a set of @@ -1519,7 +1519,7 @@

GameServerAllocation spec
- + GameServerAllocationSpec @@ -1532,7 +1532,7 @@

GameServerAllocation multiClusterSetting
- + MultiClusterSetting @@ -1585,7 +1585,7 @@

GameServerAllocation metadata
- + MetaPatch @@ -1602,7 +1602,7 @@

GameServerAllocation status
- + GameServerAllocationStatus @@ -1612,11 +1612,11 @@

GameServerAllocation -

GameServerAllocationSpec +

GameServerAllocationSpec

(Appears on: -GameServerAllocation) +GameServerAllocation)

GameServerAllocationSpec is the spec for a GameServerAllocation

@@ -1633,7 +1633,7 @@

GameServerAllocationSpec multiClusterSetting
- + MultiClusterSetting @@ -1686,7 +1686,7 @@

GameServerAllocationSpec metadata
- + MetaPatch @@ -1698,20 +1698,20 @@

GameServerAllocationSpec -

GameServerAllocationState +

GameServerAllocationState (string alias)

(Appears on: -GameServerAllocationStatus) +GameServerAllocationStatus)

GameServerAllocationState is the Allocation state

-

GameServerAllocationStatus +

GameServerAllocationStatus

(Appears on: -GameServerAllocation) +GameServerAllocation)

GameServerAllocationStatus is the status for an GameServerAllocation resource

@@ -1728,7 +1728,7 @@

GameServerAllocationStatus state
- + GameServerAllocationState @@ -1751,7 +1751,7 @@

GameServerAllocationStatus ports
- + []GameServerStatusPort @@ -1781,11 +1781,11 @@

GameServerAllocationStatus -

MetaPatch +

MetaPatch

(Appears on: -GameServerAllocationSpec) +GameServerAllocationSpec)

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

@@ -1820,11 +1820,11 @@

MetaPatch -

MultiClusterSetting +

MultiClusterSetting

(Appears on: -GameServerAllocationSpec) +GameServerAllocationSpec)

MultiClusterSetting specifies settings for multi-cluster allocation.

@@ -1862,15 +1862,15 @@

MultiClusterSetting
-

autoscaling.agones.dev

+

autoscaling.agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

FleetAutoscaler +

FleetAutoscaler

FleetAutoscaler is the data structure for a FleetAutoscaler resource

@@ -1918,7 +1918,7 @@

FleetAutoscaler spec
- + FleetAutoscalerSpec @@ -1941,7 +1941,7 @@

FleetAutoscaler policy
- + FleetAutoscalerPolicy @@ -1957,7 +1957,7 @@

FleetAutoscaler status
- + FleetAutoscalerStatus @@ -1967,11 +1967,11 @@

FleetAutoscaler -

BufferPolicy +

BufferPolicy

(Appears on: -FleetAutoscalerPolicy) +FleetAutoscalerPolicy)

BufferPolicy controls the desired behavior of the buffer policy.

@@ -2031,11 +2031,11 @@

BufferPolicy -

FleetAutoscaleRequest +

FleetAutoscaleRequest

(Appears on: -FleetAutoscaleReview) +FleetAutoscaleReview)

FleetAutoscaleRequest defines the request to webhook autoscaler endpoint

@@ -2088,7 +2088,7 @@

FleetAutoscaleRequest status
- + FleetStatus @@ -2099,11 +2099,11 @@

FleetAutoscaleRequest -

FleetAutoscaleResponse +

FleetAutoscaleResponse

(Appears on: -FleetAutoscaleReview) +FleetAutoscaleReview)

FleetAutoscaleResponse defines the response of webhook autoscaler endpoint

@@ -2152,7 +2152,7 @@

FleetAutoscaleResponse -

FleetAutoscaleReview +

FleetAutoscaleReview

FleetAutoscaleReview is passed to the webhook with a populated Request value, @@ -2170,7 +2170,7 @@

FleetAutoscaleReview request
- + FleetAutoscaleRequest @@ -2182,7 +2182,7 @@

FleetAutoscaleReview response
- + FleetAutoscaleResponse @@ -2192,11 +2192,11 @@

FleetAutoscaleReview -

FleetAutoscalerPolicy +

FleetAutoscalerPolicy

(Appears on: -FleetAutoscalerSpec) +FleetAutoscalerSpec)

FleetAutoscalerPolicy describes how to scale a fleet

@@ -2213,7 +2213,7 @@

FleetAutoscalerPolicy type
- + FleetAutoscalerPolicyType @@ -2226,7 +2226,7 @@

FleetAutoscalerPolicy buffer
- + BufferPolicy @@ -2240,7 +2240,7 @@

FleetAutoscalerPolicy webhook
- + WebhookPolicy @@ -2252,21 +2252,21 @@

FleetAutoscalerPolicy -

FleetAutoscalerPolicyType +

FleetAutoscalerPolicyType (string alias)

(Appears on: -FleetAutoscalerPolicy) +FleetAutoscalerPolicy)

FleetAutoscalerPolicyType is the policy for autoscaling for a given Fleet

-

FleetAutoscalerSpec +

FleetAutoscalerSpec

(Appears on: -FleetAutoscaler) +FleetAutoscaler)

FleetAutoscalerSpec is the spec for a Fleet Scaler

@@ -2293,7 +2293,7 @@

FleetAutoscalerSpec policy
- + FleetAutoscalerPolicy @@ -2304,11 +2304,11 @@

FleetAutoscalerSpec -

FleetAutoscalerStatus +

FleetAutoscalerStatus

(Appears on: -FleetAutoscaler) +FleetAutoscaler)

FleetAutoscalerStatus defines the current status of a FleetAutoscaler

@@ -2384,11 +2384,11 @@

FleetAutoscalerStatus -

WebhookPolicy +

WebhookPolicy

(Appears on: -FleetAutoscalerPolicy) +FleetAutoscalerPolicy)

WebhookPolicy controls the desired behavior of the webhook policy. @@ -2466,21 +2466,17 @@

WebhookPolicy
-

multicluster.agones.dev

+

multicluster.agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

GameServerAllocationPolicy +

GameServerAllocationPolicy

-(Appears on: -ConnectionInfoIterator) -

-

GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API

@@ -2526,7 +2522,7 @@

GameServerAllocationPolicy

spec
- + GameServerAllocationPolicySpec @@ -2559,7 +2555,7 @@

GameServerAllocationPolicy

connectionInfo
- + ClusterConnectionInfo @@ -2572,11 +2568,11 @@

GameServerAllocationPolicy

-

ClusterConnectionInfo +

ClusterConnectionInfo

(Appears on: -GameServerAllocationPolicySpec) +GameServerAllocationPolicySpec)

ClusterConnectionInfo defines the connection information for a cluster

@@ -2648,7 +2644,7 @@

ClusterConnectionInfo -

ConnectionInfoIterator +

ConnectionInfoIterator

ConnectionInfoIterator an iterator on ClusterConnectionInfo

@@ -2687,9 +2683,7 @@

ConnectionInfoIterator priorityToCluster
- map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy - @@ -2709,11 +2703,11 @@

ConnectionInfoIterator -

GameServerAllocationPolicySpec +

GameServerAllocationPolicySpec

(Appears on: -GameServerAllocationPolicy) +GameServerAllocationPolicy)

GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy

@@ -2750,7 +2744,7 @@

GameServerAllocationPolicySpec connectionInfo
- + ClusterConnectionInfo @@ -2765,10 +2759,13 @@

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

{{% /feature %}} -{{% feature publishVersion="1.7.0" %}} +{{% feature publishVersion="1.8.0" %}}

Packages:

-

agones.dev/v1

+

multicluster.agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

Fleet +

GameServerAllocationPolicy

-

Fleet is the data structure for a Fleet resource

+

GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API

@@ -2812,7 +2802,7 @@

Fleet string

@@ -2821,7 +2811,7 @@

Fleet kind
string -

+ @@ -2852,77 +2842,49 @@

Fleet

-agones.dev/v1 +multicluster.agones.dev/v1
FleetGameServerAllocationPolicy
@@ -2841,8 +2831,8 @@

Fleet

spec
- -FleetSpec + +GameServerAllocationPolicySpec
- - - -
-replicas
+priority
int32 		-

Replicas are the number of GameServers that should be in this set. Defaults to 0.

-
-strategy
- - -Kubernetes apps/v1.DeploymentStrategy - - -		 -

Deployment strategy
-scheduling
+weight
-agones.dev/agones/pkg/apis.SchedulingStrategy +int 		-

Scheduling strategy. Defaults to “Packed”.
-template
+connectionInfo
- -GameServerTemplateSpec + +ClusterConnectionInfo 		-

Template the GameServer template to apply for this Fleet
- - -status
- - -FleetStatus - - - - - - -

GameServer +

ClusterConnectionInfo

-

GameServer is the data structure for a GameServer resource. -It is worth noting that while there is a GameServerStatus Status entry for the GameServer, it is not -defined as a subresource - unlike Fleet and other Agones resources. -This is so that we can retain the ability to change multiple aspects of a GameServer in a single atomic operation, -which is particularly useful for operations such as allocation.

+(Appears on: +GameServerAllocationPolicySpec) +

+

+

ClusterConnectionInfo defines the connection information for a cluster

@@ -2934,146 +2896,165 @@

GameServer

- - - - + + @@ -3082,12 +3063,23 @@

GameServer

-apiVersion
-string		 - -agones.dev/v1 - +clusterName
+ +string +
-kind
-string +

Optional: the name of the targeted cluster

GameServer
-metadata
+allocationEndpoints
- -Kubernetes meta/v1.ObjectMeta - +[]string 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

The endpoints for the allocator service in the targeted cluster. +If the AllocationEndpoints is not set, the allocation happens on local cluster. +If there are multiple endpoints any of the endpoints that can handle allocation request should suffice
-spec
+secretName
- -GameServerSpec - +string 		-
-
- +

The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster

+ + + +
-container
+namespace
string 		-

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

+

The cluster namespace from which to allocate gameservers
-ports
+serverCa
- -[]GameServerPort - +[]byte 		-

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

+

The PEM encoded server CA, used by the allocator client to authenticate the remote server.
+

ConnectionInfoIterator +

+

+

ConnectionInfoIterator an iterator on ClusterConnectionInfo

+

+ + + + + + + + + +
FieldDescription
-health
+currPriority
- -Health - +int 		-

Health configures health checking

+

currPriority Current priority index from the orderedPriorities
-scheduling
+orderedPriorities
-agones.dev/agones/pkg/apis.SchedulingStrategy +[]int32 		-

Scheduling strategy. Defaults to “Packed”

+

orderedPriorities list of ordered priorities
-sdkServer
+priorityToCluster
- -SdkServer - +map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy 		-

SdkServer specifies parameters for the Agones SDK Server sidecar container

+

priorityToCluster Map of priority to cluster-policies map
-template
+clusterBlackList
- -Kubernetes core/v1.PodTemplateSpec - +map[string]bool 		-

Template describes the Pod that will be created for the GameServer

+

clusterBlackList the cluster blacklist for the clusters that has already returned
+

GameServerAllocationPolicySpec +

+

+(Appears on: +GameServerAllocationPolicy) +

+

+

GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy

+

+ + + + + + + + -
FieldDescription
-players
+priority
- -PlayersSpec - +int32 		-(Optional) -

(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features.
+
+weight
+ +int + +
-status
+connectionInfo
- -GameServerStatus + +ClusterConnectionInfo
-

GameServerSet +
+

agones.dev/v1

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

Fleet

-

GameServerSet is the data structure for a set of GameServers. -This matches philosophically with the relationship between -Depoyments and ReplicaSets

+

Fleet is the data structure for a Fleet resource

@@ -3112,7 +3104,7 @@

GameServerSet kind
string -

+ @@ -3149,7 +3141,20 @@

GameServerSet

+ + + + @@ -3173,7 +3178,7 @@

GameServerSet

GameServerSetFleet
@@ -3132,8 +3124,8 @@

GameServerSet

spec
- -GameServerSetSpec + +FleetSpec 		-

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

+

Replicas are the number of GameServers that should be in this set. Defaults to 0.

+
+strategy
+ + +Kubernetes apps/v1.DeploymentStrategy + + +		 +

Deployment strategy
-

Template the GameServer template to apply for this GameServerSet

+

Template the GameServer template to apply for this Fleet
@@ -3183,8 +3188,8 @@

GameServerSet status
- -GameServerSetStatus + +FleetStatus @@ -3193,15 +3198,14 @@

GameServerSet -

AggregatedPlayerStatus +

GameServer

-(Appears on: -FleetStatus, -GameServerSetStatus) -

-

-

AggregatedPlayerStatus stores total player tracking values

+

GameServer is the data structure for a GameServer resource. +It is worth noting that while there is a GameServerStatus Status entry for the GameServer, it is not +defined as a subresource - unlike Fleet and other Agones resources. +This is so that we can retain the ability to change multiple aspects of a GameServer in a single atomic operation, +which is particularly useful for operations such as allocation.

@@ -3213,65 +3217,84 @@

AggregatedPlayerStatus

+ + + + - -
-count
- -int64 - +apiVersion
+string		 + +agones.dev/v1 +
+kind
+string 		GameServer
-capacity
+metadata
-int64 + +Kubernetes meta/v1.ObjectMeta + 		+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-

FleetSpec -

-

-(Appears on: -Fleet) -

-

-

FleetSpec is the spec for a Fleet

-

+ + +spec
+ + +GameServerSpec + + + + +
+
- - - + + - - @@ -3282,114 +3305,72 @@

FleetSpec

- - -
FieldDescription +container
+ +string + +		 +

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

+
-replicas
+ports
-int32 + +[]GameServerPort + 		-

Replicas are the number of GameServers that should be in this set. Defaults to 0.

+

Ports are the array of ports that can be exposed via the game server
-strategy
+health
- -Kubernetes apps/v1.DeploymentStrategy + +Health 		-

Deployment strategy

+

Health configures health checking
-

Scheduling strategy. Defaults to “Packed”.

+

Scheduling strategy. Defaults to “Packed”
-template
+sdkServer
- -GameServerTemplateSpec + +SdkServer 		-

Template the GameServer template to apply for this Fleet

-
-

FleetStatus -

-

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

-

-

FleetStatus is the status of a Fleet

-

- - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -

Replicas the total number of current GameServer replicas

+

SdkServer specifies parameters for the Agones SDK Server sidecar container
-readyReplicas
+template
-int32 + +Kubernetes core/v1.PodTemplateSpec + 		-

ReadyReplicas are the number of Ready GameServer replicas

+

Template describes the Pod that will be created for the GameServer
-reservedReplicas
+players
-int32 + +PlayersSpec + 		-

ReservedReplicas are the total number of Reserved GameServer replicas in this fleet. -Reserved instances won’t be deleted on scale down, but won’t cause an autoscaler to scale up.

+(Optional) +

(Alpha, PlayerTracking feature flag) Players provides the configuration for player tracking features.
-allocatedReplicas
- -int32 - -		 -

AllocatedReplicas are the number of Allocated GameServer replicas

+
-players
+status
- -AggregatedPlayerStatus + +GameServerStatus -(Optional) -

[Stage:Alpha] -[FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this Fleet

-

GameServerPort +

GameServerSet

-(Appears on: -GameServerSpec) -

-

-

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

+

GameServerSet is the data structure for a set of GameServers. +This matches philosophically with the relationship between +Depoyments and ReplicaSets

@@ -3401,90 +3382,148 @@

GameServerPort

+ + + + + + + + + + + +
-name
- +apiVersion
+string		 + +agones.dev/v1 + +
+kind
string +		GameServerSet
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + 		-

Name is the descriptive name of the port

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-portPolicy
+spec
- -PortPolicy + +GameServerSetSpec 		-

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

Replicas are the number of GameServers that should be in this set
-container
+scheduling
-string +agones.dev/agones/pkg/apis.SchedulingStrategy 		-(Optional) -

Container is the name of the container on which to open the port. Defaults to the game server container. -This field is beta-level and is enabled by default, could be disabled by the “ContainerPortAllocation” feature.

+

Scheduling strategy. Defaults to “Packed”.
-containerPort
+template
-int32 + +GameServerTemplateSpec + 		-

ContainerPort is the port that is being opened on the specified container’s process

+

Template the GameServer template to apply for this GameServerSet

+
-hostPort
+status
-int32 + +GameServerSetStatus + + +		 +
+

AggregatedPlayerStatus +

+

+(Appears on: +FleetStatus, +GameServerSetStatus) +

+

+

AggregatedPlayerStatus stores total player tracking values

+

+ + + + + + + + + +
FieldDescription
+count
+ +int64 		-

HostPort the port exposed on the host for clients to connect to
-protocol
+capacity
- -Kubernetes core/v1.Protocol - +int64 		-

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

GameServerSetSpec +

FleetSpec

(Appears on: -GameServerSet) +Fleet)

-

GameServerSetSpec the specification for GameServerSet

+

FleetSpec is the spec for a Fleet

@@ -3502,7 +3541,20 @@

GameServerSetSpec

+ + + + @@ -3526,19 +3578,20 @@

GameServerSetSpec

-

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

+

Replicas are the number of GameServers that should be in this set. Defaults to 0.

+
+strategy
+ + +Kubernetes apps/v1.DeploymentStrategy + + +		 +

Deployment strategy
-

Template the GameServer template to apply for this GameServerSet

+

Template the GameServer template to apply for this Fleet
-

GameServerSetStatus +

FleetStatus

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

-

GameServerSetStatus is the status of a GameServerSet

+

FleetStatus is the status of a Fleet

@@ -3578,7 +3631,8 @@

GameServerSetStatus

@@ -3594,17 +3648,6 @@

GameServerSetStatus

- - - -
-

ReservedReplicas are the number of Reserved GameServer replicas

+

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.
-shutdownReplicas
- -int32 - -		 -

ShutdownReplicas are the number of Shutdown GameServers replicas

-
players
@@ -3616,20 +3659,20 @@

GameServerSetStatus (Optional)

[Stage:Alpha] [FeatureFlag:PlayerTracking] -Players are the current total player capacity and count for this GameServerSet

+Players are the current total player capacity and count for this Fleet
-

GameServerSpec +

GameServerPort

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

-

GameServerSpec is the spec for a GameServer resource

+

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

@@ -3641,27 +3684,267 @@

GameServerSpec

+ + + + + + + + + + + + + + + + + + +
-container
+name
string 		-

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

+

Name is the descriptive name of the port
-ports
+portPolicy
- -[]GameServerPort + +PortPolicy 		-

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

+

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

+
+container
+ +string + +		 +(Optional) +

Container is the name of the container on which to open the port. Defaults to the game server container. +This field is beta-level and is enabled by default, could be disabled by the “ContainerPortAllocation” feature.

+
+containerPort
+ +int32 + +		 +

ContainerPort is the port that is being opened on the specified container’s 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 GameServerSet

+

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

+

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

+
+players
+ + +AggregatedPlayerStatus + + +		 +(Optional) +

[Stage:Alpha] +[FeatureFlag:PlayerTracking] +Players are the current total player capacity and count for this GameServerSet

+
+

GameServerSpec +

+

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

+

+

GameServerSpec is the spec for a GameServer resource

+

+ + + + + + + + + + + + + + + @@ -5228,295 +5511,6 @@

WebhookPolicy

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

multicluster.agones.dev/v1

-

-

Package v1 is the v1 version of the API.

-

-Resource Types: - -

GameServerAllocationPolicy -

-

-

GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -multicluster.agones.dev/v1 - -
-kind
-string -		GameServerAllocationPolicy
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -GameServerAllocationPolicySpec - - -		 -
-
- - - - - - - - - - - - - -
-priority
- -int32 - -		 -
-weight
- -int - -		 -
-connectionInfo
- - -ClusterConnectionInfo - - -		 -
-
-

ClusterConnectionInfo -

-

-(Appears on: -GameServerAllocationPolicySpec) -

-

-

ClusterConnectionInfo defines the connection information for a cluster

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-clusterName
- -string - -		 -

Optional: the name of the targeted cluster

-
-allocationEndpoints
- -[]string - -		 -

The endpoints for the allocator service in the targeted cluster. -If the AllocationEndpoints is not set, the allocation happens on local cluster. -If there are multiple endpoints any of the endpoints that can handle allocation request should suffice

-
-secretName
- -string - -		 -

The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster

-
-namespace
- -string - -		 -

The cluster namespace from which to allocate gameservers

-
-serverCa
- -[]byte - -		 -

The PEM encoded server CA, used by the allocator client to authenticate the remote server.

-
-

ConnectionInfoIterator -

-

-

ConnectionInfoIterator an iterator on ClusterConnectionInfo

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-currPriority
- -int - -		 -

currPriority Current priority index from the orderedPriorities

-
-orderedPriorities
- -[]int32 - -		 -

orderedPriorities list of ordered priorities

-
-priorityToCluster
- -map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy - -		 -

priorityToCluster Map of priority to cluster-policies map

-
-clusterBlackList
- -map[string]bool - -		 -

clusterBlackList the cluster blacklist for the clusters that has already returned

-
-

GameServerAllocationPolicySpec -

-

-(Appears on: -GameServerAllocationPolicy) -

-

-

GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-priority
- -int32 - -		 -
-weight
- -int - -		 -
-connectionInfo
- - -ClusterConnectionInfo - - -		 -
-

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