From 315668a643f2155c5e063ffbc9cba7e19105bb05 Mon Sep 17 00:00:00 2001 From: Alfred-Mountfield Date: Wed, 29 Jul 2020 13:29:43 +0100 Subject: [PATCH] Small grammatical changes to gameserverset.go docs --- pkg/apis/agones/v1/gameserverset.go | 18 +- .../Reference/agones_crd_api_reference.html | 2156 ++++++++--------- 2 files changed, 1087 insertions(+), 1087 deletions(-) diff --git a/pkg/apis/agones/v1/gameserverset.go b/pkg/apis/agones/v1/gameserverset.go index 7b70dd2281..322f0f4a30 100644 --- a/pkg/apis/agones/v1/gameserverset.go +++ b/pkg/apis/agones/v1/gameserverset.go @@ -34,7 +34,7 @@ const ( // GameServerSet is the data structure for a set of GameServers. // This matches philosophically with the relationship between -// Depoyments and ReplicaSets +// Deployments and ReplicaSets type GameServerSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` @@ -65,19 +65,19 @@ type GameServerSetSpec struct { // GameServerSetStatus is the status of a GameServerSet type GameServerSetStatus struct { - // Replicas the total number of current GameServer replicas + // Replicas is the total number of current GameServer replicas Replicas int32 `json:"replicas"` - // ReadyReplicas are the number of Ready GameServer replicas + // ReadyReplicas is the number of Ready GameServer replicas ReadyReplicas int32 `json:"readyReplicas"` - // ReservedReplicas are the number of Reserved GameServer replicas + // ReservedReplicas is the number of Reserved GameServer replicas ReservedReplicas int32 `json:"reservedReplicas"` - // AllocatedReplicas are the number of Allocated GameServer replicas + // AllocatedReplicas is the number of Allocated GameServer replicas AllocatedReplicas int32 `json:"allocatedReplicas"` - // ShutdownReplicas are the number of Shutdown GameServers replicas + // ShutdownReplicas is the number of Shutdown GameServers replicas ShutdownReplicas int32 `json:"shutdownReplicas"` // [Stage:Alpha] // [FeatureFlag:PlayerTracking] - // Players are the current total player capacity and count for this GameServerSet + // Players is the current total player capacity and count for this GameServerSet // +optional Players *AggregatedPlayerStatus `json:"players,omitempty"` } @@ -101,7 +101,7 @@ func (gsSet *GameServerSet) ValidateUpdate(newGSS *GameServerSet) ([]metav1.Stat func (gsSet *GameServerSet) Validate() ([]metav1.StatusCause, bool) { causes := validateName(gsSet) - // check Gameserver specification in a Gameserverset + // check GameServer specification in a GameServerSet gsCauses := validateGSSpec(gsSet) if len(gsCauses) > 0 { causes = append(causes, gsCauses...) @@ -115,7 +115,7 @@ func (gsSet *GameServerSet) Validate() ([]metav1.StatusCause, bool) { return causes, len(causes) == 0 } -// GetGameServerSpec get underlying Gameserver specification +// GetGameServerSpec get underlying GameServer specification func (gsSet *GameServerSet) GetGameServerSpec() *GameServerSpec { return &gsSet.Spec.Template.Spec } 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 8f16b2c209..f6ba843652 100644 --- a/site/content/en/docs/Reference/agones_crd_api_reference.html +++ b/site/content/en/docs/Reference/agones_crd_api_reference.html @@ -325,7 +325,7 @@

GameServerSet

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

+Deployments and ReplicaSets

@@ -2763,30 +2763,31 @@

GameServerAll

Packages:

-

multicluster.agones.dev/v1

+

allocation.agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

GameServerAllocationPolicy +

GameServerAllocation

-

GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API

+

GameServerAllocation is the data structure for allocating against a set of +GameServers, defined required and preferred selectors

@@ -2802,7 +2803,7 @@

GameServerAllocat string

@@ -2811,7 +2812,7 @@

GameServerAllocat kind
string -

+ @@ -2842,49 +2843,96 @@

GameServerAllocat

-multicluster.agones.dev/v1 +allocation.agones.dev/v1
GameServerAllocationPolicyGameServerAllocation
@@ -2831,8 +2832,8 @@

GameServerAllocat

spec
- -GameServerAllocationPolicySpec + +GameServerAllocationSpec
+ + + + + + + +
-priority
+multiClusterSetting
-int32 + +MultiClusterSetting + + +		 +

MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally.

+
+required
+ + +Kubernetes meta/v1.LabelSelector + 		+

Required The required allocation. Defaults to all GameServers.
-weight
+preferred
-int + +[]Kubernetes meta/v1.LabelSelector + 		+

Preferred ordered list of preferred allocations out of the required set. +If the first selector is not matched, +the selection attempts the second selector, and so on.
-connectionInfo
+scheduling
- -ClusterConnectionInfo +agones.dev/agones/pkg/apis.SchedulingStrategy + +		 +

Scheduling strategy. Defaults to “Packed”.

+
+metadata
+ + +MetaPatch 		+

MetaPatch is optional custom metadata that is added to the game server at allocation +You can use this to tell the server necessary session data
+ + +status
+ + +GameServerAllocationStatus + + + + + + -

ClusterConnectionInfo +

GameServerAllocationSpec

(Appears on: -GameServerAllocationPolicySpec) +GameServerAllocation)

-

ClusterConnectionInfo defines the connection information for a cluster

+

GameServerAllocationSpec is the spec for a GameServerAllocation

@@ -2896,67 +2944,90 @@

ClusterConnectionInfo

-clusterName
+multiClusterSetting
-string + +MultiClusterSetting + 		-

Optional: the name of the targeted cluster

+

MultiClusterPolicySelector if specified, multi-cluster policies are applied. +Otherwise, allocation will happen locally.
-allocationEndpoints
+required
-[]string + +Kubernetes meta/v1.LabelSelector + 		-

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

+

Required The required allocation. Defaults to all GameServers.
-secretName
+preferred
-string + +[]Kubernetes meta/v1.LabelSelector + 		-

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

+

Preferred ordered list of preferred allocations out of the required set. +If the first selector is not matched, +the selection attempts the second selector, and so on.
-namespace
+scheduling
-string +agones.dev/agones/pkg/apis.SchedulingStrategy 		-

The cluster namespace from which to allocate gameservers

+

Scheduling strategy. Defaults to “Packed”.
-serverCa
+metadata
-[]byte + +MetaPatch + 		-

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

+

MetaPatch is optional custom metadata that is added to the game server at allocation +You can use this to tell the server necessary session data
-

ConnectionInfoIterator +

GameServerAllocationState +(string alias)

+

+(Appears on: +GameServerAllocationStatus) +

+

+

GameServerAllocationState is the Allocation state

+

+

GameServerAllocationStatus

-

ConnectionInfoIterator an iterator on ClusterConnectionInfo

+(Appears on: +GameServerAllocation) +

+

+

GameServerAllocationStatus is the status for an GameServerAllocation resource

@@ -2968,58 +3039,69 @@

ConnectionInfoIterato

+ + + +
-currPriority
+state
-int + +GameServerAllocationState + 		-

currPriority Current priority index from the orderedPriorities

+

GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated
-orderedPriorities
+gameServerName
-[]int32 +string 		-

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

priorityToCluster Map of priority to cluster-policies map
-clusterBlackList
+address
-map[string]bool +string + +		 +
+nodeName
+ +string 		-

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

GameServerAllocationPolicySpec +

MetaPatch

(Appears on: -GameServerAllocationPolicy) +GameServerAllocationSpec)

-

GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy

+

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

@@ -3031,9 +3113,9 @@

GameServerAll

+ +
-priority
+labels
-int32 +map[string]string 		@@ -3041,20 +3123,49 @@

GameServerAll

-weight
+annotations
-int +map[string]string
+

MultiClusterSetting +

+

+(Appears on: +GameServerAllocationSpec) +

+

+

MultiClusterSetting specifies settings for multi-cluster allocation.

+

+ + + + + + + + + + + + @@ -3064,22 +3175,18 @@

GameServerAll

FieldDescription
-connectionInfo
+enabled
- -ClusterConnectionInfo +bool + +		 +
+policySelector
+ + +Kubernetes meta/v1.LabelSelector
-

agones.dev/v1

+

autoscaling.agones.dev/v1

Package v1 is the v1 version of the API.

Resource Types: -

Fleet +

FleetAutoscaler

-

Fleet is the data structure for a Fleet resource

+

FleetAutoscaler is the data structure for a FleetAutoscaler resource

@@ -3095,7 +3202,7 @@

Fleet string

@@ -3104,7 +3211,7 @@

Fleet kind
string -

+ @@ -3198,14 +3280,14 @@

Fleet

-agones.dev/v1 +autoscaling.agones.dev/v1
FleetFleetAutoscaler
@@ -3124,9 +3231,9 @@

Fleet

spec
- -FleetSpec - + +FleetAutoscalerSpec + 		@@ -3135,50 +3242,25 @@

Fleet - - - - - - - -
-replicas
- -int32 - -		 -

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

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

Deployment strategy

-
-scheduling
+fleetName
-agones.dev/agones/pkg/apis.SchedulingStrategy +string 		-

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

Template the GameServer template to apply for this Fleet

+

Autoscaling policy
@@ -3188,8 +3270,8 @@

Fleet

status
- -FleetStatus + +FleetAutoscalerStatus
-

GameServer +

BufferPolicy

-

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

+

+

BufferPolicy controls the desired behavior of the buffer policy.

@@ -3217,160 +3299,127 @@

GameServer

- - - - - - - - - - - - -
-apiVersion
-string		 - -agones.dev/v1 - -
-kind
-string -		GameServer
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -GameServerSpec - - -		 -
-
- - - + +
-container
+maxReplicas
-string +int32 		-

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

+

MaxReplicas is the maximum amount of replicas that the fleet may have. +It must be bigger than both MinReplicas and BufferSize
-ports
+minReplicas
- -[]GameServerPort - +int32 		-

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

+

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
-health
+bufferSize
- -Health - +k8s.io/apimachinery/pkg/util/intstr.IntOrString 		-

Health configures health checking

+

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

+

+ + - - + + + + - -
-scheduling
- -agones.dev/agones/pkg/apis.SchedulingStrategy - -		 -

Scheduling strategy. Defaults to “Packed”

-		FieldDescription
-sdkServer
+uid
- -SdkServer - +k8s.io/apimachinery/pkg/types.UID 		-

SdkServer specifies parameters for the Agones SDK Server sidecar container

+

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.
-template
+name
- -Kubernetes core/v1.PodTemplateSpec - +string 		-

Template describes the Pod that will be created for the GameServer

+

Name is the name of the Fleet being scaled
-players
+namespace
- -PlayersSpec - +string 		-(Optional) -

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

-
+

Namespace is the namespace associated with the request (if any).
status
- -GameServerStatus + +FleetStatus 		+

The Fleet’s status values
-

GameServerSet +

FleetAutoscaleResponse

-

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

+(Appears on: +FleetAutoscaleReview) +

+

+

FleetAutoscaleResponse defines the response of webhook autoscaler endpoint

@@ -3382,48 +3431,27 @@

GameServerSet

- - - - - - - - @@ -3476,15 +3505,14 @@

GameServerSet

-apiVersion
-string		 - -agones.dev/v1 - -
-kind
-string -		GameServerSet
-metadata
+uid
- -Kubernetes meta/v1.ObjectMeta - +k8s.io/apimachinery/pkg/types.UID 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

UID is an identifier for the individual request/response. +This should be copied over from the corresponding FleetAutoscaleRequest.
-spec
+scale
- -GameServerSetSpec - +bool 		-
-
- +

Set to false if no scaling should occur to the Fleet

+ + + +
replicas
@@ -3432,42 +3460,43 @@

GameServerSet

-

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

+

The targeted replica count
+

FleetAutoscaleReview +

+

+

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

+

+ + - - + + + + - -
-scheduling
- -agones.dev/agones/pkg/apis.SchedulingStrategy - -		 -

Scheduling strategy. Defaults to “Packed”.

-		FieldDescription
-template
+request
- -GameServerTemplateSpec + +FleetAutoscaleRequest 		-

Template the GameServer template to apply for this GameServerSet

-
-status
+response
- -GameServerSetStatus + +FleetAutoscaleResponse
-

AggregatedPlayerStatus +

FleetAutoscalerPolicy

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

-

AggregatedPlayerStatus stores total player tracking values

+

FleetAutoscalerPolicy describes how to scale a fleet

@@ -3496,102 +3524,107 @@

AggregatedPlayerStatus

- -
-count
+type
-int64 + +FleetAutoscalerPolicyType + 		+

Type of autoscaling policy.
-capacity
+buffer
-int64 + +BufferPolicy + 		+(Optional) +

Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer.
-

FleetSpec -

-

-(Appears on: -Fleet) -

-

-

FleetSpec is the spec for a Fleet

-

- - - - - - - - + +
FieldDescription
-replicas
+webhook
-int32 + +WebhookPolicy + 		-

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

+(Optional) +

Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook.
+

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

+

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

Deployment strategy

-		FieldDescription
-scheduling
+fleetName
-agones.dev/agones/pkg/apis.SchedulingStrategy +string 		-

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

Template the GameServer template to apply for this Fleet

+

Autoscaling policy
-

FleetStatus +

FleetAutoscalerStatus

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

-

FleetStatus is the status of a Fleet

+

FleetAutoscalerStatus defines the current status of a FleetAutoscaler

@@ -3603,76 +3636,77 @@

FleetStatus

-replicas
+currentReplicas
int32 		-

Replicas the total number of current GameServer replicas

+

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

ReadyReplicas are the number of Ready GameServer replicas

+

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

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

+(Optional) +

lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet,
-allocatedReplicas
+ableToScale
-int32 +bool 		-

AllocatedReplicas are the number of Allocated GameServer replicas

+

AbleToScale indicates that we can access the target fleet
-players
+scalingLimited
- -AggregatedPlayerStatus - +bool 		-(Optional) -

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

+

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

GameServerPort +

WebhookPolicy

(Appears on: -GameServerSpec) +FleetAutoscalerPolicy)

-

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

+

WebhookPolicy controls the desired behavior of the webhook policy. +It contains the description of the webhook autoscaler service +used to form url which is accessible inside the cluster

@@ -3684,144 +3718,177 @@

GameServerPort

+ +
-name
+url
string 		-

Name is the descriptive name of the port

+(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.
-portPolicy
+service
- -PortPolicy + +Kubernetes admissionregistration/v1beta1.ServiceReference 		-

PortPolicy defines the policy for how the HostPort is populated. -Dynamic port will allocate a HostPort within the selected MIN_PORT and MAX_PORT range passed to the controller -at installation time. -When Static portPolicy is specified, HostPort is required, to specify the port that game clients will -connect to

+(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.
-container
+caBundle
-string +[]byte 		(Optional) -

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

+

caBundle is a PEM encoded CA bundle which will be used to validate the webhook’s server certificate. +If unspecified, system trust roots on the apiserver are used.
+
+

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
-containerPort
- -int32 - +apiVersion
+string		 + +multicluster.agones.dev/v1 +
-

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

+kind
+string 		GameServerAllocationPolicy
-hostPort
+metadata
-int32 + +Kubernetes meta/v1.ObjectMeta + 		-

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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-protocol
+spec
- -Kubernetes core/v1.Protocol + +GameServerAllocationPolicySpec 		-

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

-
-

GameServerSetSpec -

-

-(Appears on: -GameServerSet) -

-

-

GameServerSetSpec the specification for GameServerSet

-

+
+
- - - - - - - + +
FieldDescription
-replicas
+priority
int32 		-

Replicas are the number of GameServers that should be in this set
-scheduling
+weight
-agones.dev/agones/pkg/apis.SchedulingStrategy +int 		-

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

Template the GameServer template to apply for this GameServerSet

+
-

GameServerSetStatus +

ClusterConnectionInfo

(Appears on: -GameServerSet) +GameServerAllocationPolicySpec)

-

GameServerSetStatus is the status of a GameServerSet

+

ClusterConnectionInfo defines the connection information for a cluster

@@ -3833,86 +3900,67 @@

GameServerSetStatus

- - - -
-replicas
- -int32 - -		 -

Replicas the total number of current GameServer replicas

-
-readyReplicas
+clusterName
-int32 +string 		-

ReadyReplicas are the number of Ready GameServer replicas

+

Optional: the name of the targeted cluster
-reservedReplicas
+allocationEndpoints
-int32 +[]string 		-

ReservedReplicas are the number of Reserved GameServer replicas

+

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

AllocatedReplicas are the number of Allocated GameServer replicas

+

The name of the secret that contains TLS client certificates to connect the allocator server in the targeted cluster
-shutdownReplicas
+namespace
-int32 +string 		-

ShutdownReplicas are the number of Shutdown GameServers replicas

+

The cluster namespace from which to allocate gameservers
-players
+serverCa
- -AggregatedPlayerStatus - +[]byte 		-(Optional) -

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

+

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

GameServerSpec +

ConnectionInfoIterator

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

-

-

GameServerSpec is the spec for a GameServer resource

+

ConnectionInfoIterator an iterator on ClusterConnectionInfo

@@ -3924,112 +3972,118 @@

GameServerSpec

+ +
-container
+currPriority
-string +int 		-

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

+

currPriority Current priority index from the orderedPriorities
-ports
+orderedPriorities
- -[]GameServerPort - +[]int32 		-

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

+

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

Health configures health checking

+

priorityToCluster Map of priority to cluster-policies map
-scheduling
+clusterBlackList
-agones.dev/agones/pkg/apis.SchedulingStrategy +map[string]bool 		-

Scheduling strategy. Defaults to “Packed”

+

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

GameServerAllocationPolicySpec +

+

+(Appears on: +GameServerAllocationPolicy) +

+

+

GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy

+

+ + + + + + + +
FieldDescription
-sdkServer
+priority
- -SdkServer - +int32 		-

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

Template describes the Pod that will be created for the GameServer
-players
+connectionInfo
- -PlayersSpec + +ClusterConnectionInfo 		-(Optional) -

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

GameServerState -(string alias)

-

-(Appears on: -GameServerStatus) -

+
+

agones.dev/v1

-

GameServerState is the state for the GameServer

+

Package v1 is the v1 version of the API.

-

GameServerStatus +Resource Types: + +

Fleet

-(Appears on: -GameServer) -

-

-

GameServerStatus is the status for a GameServer resource

+

Fleet is the data structure for a Fleet resource

@@ -4041,88 +4095,121 @@

GameServerStatus

+ + + + + + + +
-state
+apiVersion
+string		 + +agones.dev/v1 + +
+kind
+string +		Fleet
+metadata
- -GameServerState + +Kubernetes meta/v1.ObjectMeta 		-

GameServerState is the current state of a GameServer, e.g. Creating, Starting, Ready, etc

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-ports
+spec
- -[]GameServerStatusPort + +FleetSpec 		+
+
+ + + + + +
+replicas
+ +int32 + +		 +

Replicas are the number of GameServers that should be in this set. Defaults to 0.
-address
+strategy
-string + +Kubernetes apps/v1.DeploymentStrategy + 		+

Deployment strategy
-nodeName
+scheduling
-string +agones.dev/agones/pkg/apis.SchedulingStrategy 		+

Scheduling strategy. Defaults to “Packed”.
-reservedUntil
+template
- -Kubernetes meta/v1.Time + +GameServerTemplateSpec 		+

Template the GameServer template to apply for this Fleet

+
-players
+status
- -PlayerStatus + +FleetStatus 		-(Optional) -

[Stage:Alpha] -[FeatureFlag:PlayerTracking]
-

GameServerStatusPort +

GameServer

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

-

-

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

+

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

@@ -4134,44 +4221,21 @@

GameServerStatusPort

- - - - +apiVersion
+string - -
-name
- -string - -		 -
-port
- -int32 - -		 + +agones.dev/v1 +
-

GameServerTemplateSpec -

-

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

-

-

GameServerTemplateSpec is a template for GameServers

-

- - - - + + - -
FieldDescription +kind
+string +		GameServer
metadata
@@ -4291,16 +4355,26 @@

GameServerTemplateSpec

+ + +status
+ + +GameServerStatus + + + + + + -

Health +

GameServerSet

-(Appears on: -GameServerSpec) -

-

-

Health configures health checking on the GameServer

+

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

@@ -4312,121 +4386,93 @@

Health

+apiVersion
+string - + - - -
-disabled
- -bool - -		 -

Disabled is whether health checking is disabled or not

+ +agones.dev/v1 +
-periodSeconds
- -int32 - -		 -

PeriodSeconds is the number of seconds each health ping has to occur in

+kind
+string 		GameServerSet
-failureThreshold
+metadata
-int32 + +Kubernetes meta/v1.ObjectMeta + 		-

FailureThreshold how many failures in a row constitutes unhealthy

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

InitialDelaySeconds initial delay before checking health

-
-

PlayerStatus -

-

-(Appears on: -GameServerStatus) -

-

-

PlayerStatus stores the current player capacity values

-

+
+
- - - - - - - -
FieldDescription
-count
+replicas
-int64 +int32 		+

Replicas are the number of GameServers that should be in this set
-capacity
+scheduling
-int64 +agones.dev/agones/pkg/apis.SchedulingStrategy 		+

Scheduling strategy. Defaults to “Packed”.
-ids
+template
-[]string + +GameServerTemplateSpec + 		+

Template the GameServer template to apply for this GameServerSet
-

PlayersSpec -

-

-(Appears on: -GameServerSpec) -

-

-

PlayersSpec tracks the initial player capacity

-

- - - - - + - -
FieldDescription
-initialCapacity
+status
-int64 + +GameServerSetStatus + 		@@ -4434,23 +4480,15 @@

PlayersSpec

-

PortPolicy -(string alias)

-

-(Appears on: -GameServerPort) -

-

-

PortPolicy is the port policy for the GameServer

-

-

SdkServer +

AggregatedPlayerStatus

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

-

SdkServer specifies parameters for the Agones SDK Server sidecar container

+

AggregatedPlayerStatus stores total player tracking values

@@ -4462,157 +4500,65 @@

SdkServer

- - - -
-logLevel
- - -SdkServerLogLevel - - -		 -

LogLevel for SDK server (sidecar) logs. Defaults to “Info”

-
-grpcPort
+count
-int32 +int64 		-

GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections
-httpPort
+capacity
-int32 +int64 		-

HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections
-

SdkServerLogLevel -(string alias)

+

FleetSpec +

(Appears on: -SdkServer) -

-

-

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

-

-
-

allocation.agones.dev/v1

-

-

Package v1 is the v1 version of the API.

+Fleet)

-Resource Types: - -

GameServerAllocation -

-

GameServerAllocation is the data structure for allocating against a set of -GameServers, defined required and preferred selectors

+

FleetSpec is the spec for a Fleet

- - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -allocation.agones.dev/v1 - -
-kind
-string -		GameServerAllocation
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -GameServerAllocationSpec - - -		 -
-
- - - - + + + + + + @@ -4628,43 +4574,28 @@

GameServerAllocation

- - -
-multiClusterSetting
- - -MultiClusterSetting - - -		 -

MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally.

-
FieldDescription
-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. Defaults to 0.
-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
- - -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
+template
- -GameServerAllocationStatus + +GameServerTemplateSpec 		+

Template the GameServer template to apply for this Fleet
-

GameServerAllocationSpec +

FleetStatus

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

-

GameServerAllocationSpec is the spec for a GameServerAllocation

+

FleetStatus is the status of a Fleet

@@ -4676,90 +4607,76 @@

GameServerAllocationS

-multiClusterSetting
+replicas
- -MultiClusterSetting - +int32 		-

MultiClusterPolicySelector if specified, multi-cluster policies are applied. -Otherwise, allocation will happen locally.

+

Replicas the total number of current GameServer replicas
-required
+readyReplicas
- -Kubernetes meta/v1.LabelSelector - +int32 		-

Required The required allocation. Defaults to all GameServers.

+

ReadyReplicas are the number of Ready GameServer replicas
-preferred
+reservedReplicas
- -[]Kubernetes meta/v1.LabelSelector - +int32 		-

Preferred ordered list of preferred allocations out of the required set. -If the first selector is not matched, -the selection attempts the second selector, and so on.

+

ReservedReplicas are the total number of Reserved GameServer replicas in this fleet. +Reserved instances won’t be deleted on scale down, but won’t cause an autoscaler to scale up.
-scheduling
+allocatedReplicas
-agones.dev/agones/pkg/apis.SchedulingStrategy +int32 		-

Scheduling strategy. Defaults to “Packed”.

+

AllocatedReplicas are the number of Allocated GameServer replicas
-metadata
+players
- -MetaPatch + +AggregatedPlayerStatus 		-

MetaPatch is optional custom metadata that is added to the game server at allocation -You can use this to tell the server necessary session data

+(Optional) +

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

GameServerAllocationState -(string alias)

-

-(Appears on: -GameServerAllocationStatus) -

-

-

GameServerAllocationState is the Allocation state

-

-

GameServerAllocationStatus +

GameServerPort

(Appears on: -GameServerAllocation) +GameServerSpec)

-

GameServerAllocationStatus is the status for an GameServerAllocation resource

+

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

@@ -4771,69 +4688,90 @@

GameServerAllocatio

+ + + +
-state
+name
- -GameServerAllocationState +string + +		 +

Name is the descriptive name of the port

+
+portPolicy
+ + +PortPolicy 		-

GameServerState is the current state of an GameServerAllocation, e.g. Allocated, or UnAllocated

+

PortPolicy defines the policy for how the HostPort is populated. +Dynamic port will allocate a HostPort within the selected MIN_PORT and MAX_PORT range passed to the controller +at installation time. +When Static portPolicy is specified, HostPort is required, to specify the port that game clients will +connect to
-gameServerName
+container
string 		+(Optional) +

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

ContainerPort is the port that is being opened on the specified container’s process
-address
+hostPort
-string +int32 		+

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

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

MetaPatch +

GameServerSetSpec

(Appears on: -GameServerAllocationSpec) +GameServerSet)

-

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

+

GameServerSetSpec the specification for GameServerSet

@@ -4845,34 +4783,49 @@

MetaPatch

+ + + +
-labels
+replicas
-map[string]string +int32 		+

Replicas are the number of GameServers that should be in this set
-annotations
+scheduling
-map[string]string +agones.dev/agones/pkg/apis.SchedulingStrategy + +		 +

Scheduling strategy. Defaults to “Packed”.

+
+template
+ + +GameServerTemplateSpec + 		+

Template the GameServer template to apply for this GameServerSet
-

MultiClusterSetting +

GameServerSetStatus

(Appears on: -GameServerAllocationSpec) +GameServerSet)

-

MultiClusterSetting specifies settings for multi-cluster allocation.

+

GameServerSetStatus is the status of a GameServerSet

@@ -4884,41 +4837,86 @@

MultiClusterSetting

+ + + + + + + + + + + + + + + +
-enabled
+replicas
-bool +int32 		+

Replicas is the total number of current GameServer replicas
-policySelector
+readyReplicas
- -Kubernetes meta/v1.LabelSelector +int32 + +		 +

ReadyReplicas is the number of Ready GameServer replicas

+
+reservedReplicas
+ +int32 + +		 +

ReservedReplicas is the number of Reserved GameServer replicas

+
+allocatedReplicas
+ +int32 + +		 +

AllocatedReplicas is the number of Allocated GameServer replicas

+
+shutdownReplicas
+ +int32 + +		 +

ShutdownReplicas is the number of Shutdown GameServers replicas

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

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

autoscaling.agones.dev/v1

+

GameServerSpec +

-

Package v1 is the v1 version of the API.

+(Appears on: +GameServer, +GameServerTemplateSpec)

-Resource Types: - -

FleetAutoscaler -

-

FleetAutoscaler is the data structure for a FleetAutoscaler resource

+

GameServerSpec is the spec for a GameServer resource

@@ -4930,96 +4928,112 @@

FleetAutoscaler

- - - - + +
-apiVersion
-string		 - -autoscaling.agones.dev/v1 - +container
+ +string +
-kind
-string +

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

FleetAutoscaler
-metadata
+ports
- -Kubernetes meta/v1.ObjectMeta + +[]GameServerPort 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

Ports are the array of ports that can be exposed via the game server
-spec
+health
- -FleetAutoscalerSpec + +Health 		-
-
- +

Health configures health checking

+ + -
-fleetName
+scheduling
-string +agones.dev/agones/pkg/apis.SchedulingStrategy 		+

Scheduling strategy. Defaults to “Packed”
-policy
+sdkServer
- -FleetAutoscalerPolicy + +SdkServer 		-

Autoscaling policy

+

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

Template describes the Pod that will be created for the GameServer
-status
+players
- -FleetAutoscalerStatus + +PlayersSpec 		+(Optional) +

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

BufferPolicy +

GameServerState +(string alias)

+

+(Appears on: +GameServerStatus) +

+

+

GameServerState is the state for the GameServer

+

+

GameServerStatus

(Appears on: -FleetAutoscalerPolicy) +GameServer)

-

BufferPolicy controls the desired behavior of the buffer policy.

+

GameServerStatus is the status for a GameServer resource

@@ -5031,127 +5045,128 @@

BufferPolicy

- -
-maxReplicas
+state
-int32 + +GameServerState + 		-

MaxReplicas is the maximum amount of replicas that the fleet may have. -It must be bigger than both MinReplicas and BufferSize

+

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

MinReplicas is the minimum amount of replicas that the fleet must have -If zero, it is ignored. -If non zero, it must be smaller than MaxReplicas and bigger than BufferSize
-bufferSize
+address
-k8s.io/apimachinery/pkg/util/intstr.IntOrString +string 		-

BufferSize defines how many replicas the autoscaler tries to have ready all the time -Value can be an absolute number (ex: 5) or a percentage of desired gs instances (ex: 15%) -Absolute number is calculated from percentage by rounding up. -Example: when this is set to 20%, the autoscaler will make sure that 20% -of the fleet’s game server replicas are ready. When this is set to 20, -the autoscaler will make sure that there are 20 available game servers -Must be bigger than 0 -Note: by “ready” we understand in this case “non-allocated”; this is done to ensure robustness -and computation stability in different edge case (fleet just created, not enough -capacity in the cluster etc)
-

FleetAutoscaleRequest -

-

-(Appears on: -FleetAutoscaleReview) -

-

-

FleetAutoscaleRequest defines the request to webhook autoscaler endpoint

-

- - - - + + - - + +
FieldDescription +nodeName
+ +string + +		 +
-uid
+reservedUntil
-k8s.io/apimachinery/pkg/types.UID + +Kubernetes meta/v1.Time + 		-

UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are -otherwise identical (parallel requests, requests when earlier requests did not modify etc) -The UID is meant to track the round trip (request/response) between the Autoscaler and the WebHook, not the user request. -It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.
-name
+players
-string + +PlayerStatus + 		-

Name is the name of the Fleet being scaled

+(Optional) +

[Stage:Alpha] +[FeatureFlag:PlayerTracking]
+

GameServerStatusPort +

+

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

+

+

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

+

+ + + + + + + +
FieldDescription
-namespace
+name
string 		-

Namespace is the namespace associated with the request (if any).
-status
+port
- -FleetStatus - +int32 		-

The Fleet’s status values
-

FleetAutoscaleResponse +

GameServerTemplateSpec

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

-

FleetAutoscaleResponse defines the response of webhook autoscaler endpoint

+

GameServerTemplateSpec is a template for GameServers

@@ -5163,158 +5178,133 @@

FleetAutoscaleResponse

- +
+
+
-uid
+metadata
-k8s.io/apimachinery/pkg/types.UID + +Kubernetes meta/v1.ObjectMeta + 		-

UID is an identifier for the individual request/response. -This should be copied over from the corresponding FleetAutoscaleRequest.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-scale
+spec
-bool + +GameServerSpec + 		-

Set to false if no scaling should occur to the Fleet

-
- - - -
-replicas
+container
-int32 +string 		-

The targeted replica count

-
-

FleetAutoscaleReview -

-

-

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

-

- - - - - + - - - -
FieldDescription +

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

+
-request
+ports
- -FleetAutoscaleRequest + +[]GameServerPort 		+

Ports are the array of ports that can be exposed via the game server
-response
+health
- -FleetAutoscaleResponse + +Health 		+

Health configures health checking
-

FleetAutoscalerPolicy -

-

-(Appears on: -FleetAutoscalerSpec) -

-

-

FleetAutoscalerPolicy describes how to scale a fleet

-

- - - - + + - - + +
FieldDescription +scheduling
+ +agones.dev/agones/pkg/apis.SchedulingStrategy + +		 +

Scheduling strategy. Defaults to “Packed”

+
-type
+sdkServer
- -FleetAutoscalerPolicyType + +SdkServer 		-

Type of autoscaling policy.

+

SdkServer specifies parameters for the Agones SDK Server sidecar container
-buffer
+template
- -BufferPolicy + +Kubernetes core/v1.PodTemplateSpec 		-(Optional) -

Buffer policy config params. Present only if FleetAutoscalerPolicyType = Buffer.

+

Template describes the Pod that will be created for the GameServer
-webhook
+players
- -WebhookPolicy + +PlayersSpec 		(Optional) -

Webhook policy config params. Present only if FleetAutoscalerPolicyType = Webhook.

+

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

+
-

FleetAutoscalerPolicyType -(string alias)

-

-(Appears on: -FleetAutoscalerPolicy) -

-

-

FleetAutoscalerPolicyType is the policy for autoscaling -for a given Fleet

-

-

FleetAutoscalerSpec +

Health

(Appears on: -FleetAutoscaler) +GameServerSpec)

-

FleetAutoscalerSpec is the spec for a Fleet Scaler

+

Health configures health checking on the GameServer

@@ -5326,37 +5316,58 @@

FleetAutoscalerSpec

+ + + + + + + +
-fleetName
+disabled
-string +bool 		+

Disabled is whether health checking is disabled or not
-policy
+periodSeconds
- -FleetAutoscalerPolicy - +int32 		-

Autoscaling policy

+

PeriodSeconds is the number of seconds each health ping has to occur in

+
+failureThreshold
+ +int32 + +		 +

FailureThreshold how many failures in a row constitutes unhealthy

+
+initialDelaySeconds
+ +int32 + +		 +

InitialDelaySeconds initial delay before checking health
-

FleetAutoscalerStatus +

PlayerStatus

(Appears on: -FleetAutoscaler) +GameServerStatus)

-

FleetAutoscalerStatus defines the current status of a FleetAutoscaler

+

PlayerStatus stores the current player capacity values

@@ -5368,77 +5379,82 @@

FleetAutoscalerStatus

+ +
-currentReplicas
+count
-int32 +int64 		-

CurrentReplicas is the current number of gameserver replicas -of the fleet managed by this autoscaler, as last seen by the autoscaler
-desiredReplicas
+capacity
-int32 +int64 		-

DesiredReplicas is the desired number of gameserver replicas -of the fleet managed by this autoscaler, as last calculated by the autoscaler
-lastScaleTime
+ids
- -Kubernetes meta/v1.Time - +[]string 		-(Optional) -

lastScaleTime is the last time the FleetAutoscaler scaled the attached fleet,
+

PlayersSpec +

+

+(Appears on: +GameServerSpec) +

+

+

PlayersSpec tracks the initial player capacity

+

+ + - - + + + +
-ableToScale
- -bool - -		 -

AbleToScale indicates that we can access the target fleet

-		FieldDescription
-scalingLimited
+initialCapacity
-bool +int64 		-

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

WebhookPolicy +

PortPolicy +(string alias)

+

+(Appears on: +GameServerPort) +

+

+

PortPolicy is the port policy for the GameServer

+

+

SdkServer

(Appears on: -FleetAutoscalerPolicy) +GameServerSpec)

-

WebhookPolicy controls the desired behavior of the webhook policy. -It contains the description of the webhook autoscaler service -used to form url which is accessible inside the cluster

+

SdkServer specifies parameters for the Agones SDK Server sidecar container

@@ -5450,66 +5466,50 @@

WebhookPolicy

-url
+logLevel
-string + +SdkServerLogLevel + 		-(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.

+

LogLevel for SDK server (sidecar) logs. Defaults to “Info”
-service
+grpcPort
- -Kubernetes admissionregistration/v1beta1.ServiceReference - +int32 		-(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.

+

GRPCPort is the port on which the SDK Server binds the gRPC server to accept incoming connections
-caBundle
+httpPort
-[]byte +int32 		-(Optional) -

caBundle is a PEM encoded CA bundle which will be used to validate the webhook’s server certificate. -If unspecified, system trust roots on the apiserver are used.

+

HTTPPort is the port on which the SDK Server binds the HTTP gRPC gateway server to accept incoming connections
+

SdkServerLogLevel +(string alias)

+

+(Appears on: +SdkServer) +

+

+

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

+

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