gameservers

Documentation

Overview

Package gameservers handles management of the GameServer Custom Resource Definition

Index

• Variables
• type Controller
  • func NewController(wh *webhooks.WebHook, health healthcheck.Handler, minPort, maxPort int32, ...) *Controller
  • func (c *Controller) Run(workers int, stop <-chan struct{}) error
• type HealthController
  • func NewHealthController(kubeClient kubernetes.Interface, agonesClient versioned.Interface, ...) *HealthController
  • func (hc *HealthController) Run(stop <-chan struct{})
• type LocalSDKServer
  • func (l *LocalSDKServer) GetGameServer(context.Context, *sdk.Empty) (*sdk.GameServer, error)
  • func (l *LocalSDKServer) Health(stream sdk.SDK_HealthServer) error
  • func (l *LocalSDKServer) Ready(context.Context, *sdk.Empty) (*sdk.Empty, error)
  • func (l *LocalSDKServer) Shutdown(context.Context, *sdk.Empty) (*sdk.Empty, error)
• type PortAllocator
  • func NewPortAllocator(minPort, maxPort int32, kubeInformerFactory informers.SharedInformerFactory, ...) *PortAllocator
  • func (pa *PortAllocator) Allocate(gs *v1alpha1.GameServer) (*v1alpha1.GameServer, error)
  • func (pa *PortAllocator) DeAllocate(gs *v1alpha1.GameServer)
  • func (pa *PortAllocator) Run(stop <-chan struct{}) error
• type SDKServer
  • func NewSDKServer(gameServerName, namespace string, healthDisabled bool, ...) (*SDKServer, error)
  • func (s *SDKServer) GetGameServer(context.Context, *sdk.Empty) (*sdk.GameServer, error)
  • func (s *SDKServer) Health(stream sdk.SDK_HealthServer) error
  • func (s *SDKServer) Ready(ctx context.Context, e *sdk.Empty) (*sdk.Empty, error)
  • func (s *SDKServer) Run(stop <-chan struct{})
  • func (s *SDKServer) Shutdown(ctx context.Context, e *sdk.Empty) (*sdk.Empty, error)

Variables

var ErrPortNotFound = errors.New("Unable to allocate a port")

ErrPortNotFound is returns when a port is unable to be allocated

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller is a the main GameServer crd controller

func NewController

func NewController(
	wh *webhooks.WebHook,
	health healthcheck.Handler,
	minPort, maxPort int32,
	sidecarImage string,
	alwaysPullSidecarImage bool,
	kubeClient kubernetes.Interface,
	kubeInformerFactory informers.SharedInformerFactory,
	extClient extclientset.Interface,
	agonesClient versioned.Interface,
	agonesInformerFactory externalversions.SharedInformerFactory) *Controller

NewController returns a new gameserver crd controller

func (*Controller) Run

func (c *Controller) Run(workers int, stop <-chan struct{}) error

Run the GameServer controller. Will block until stop is closed. Runs threadiness number workers to process the rate limited queue

type HealthController

type HealthController struct {
	// contains filtered or unexported fields
}

HealthController watches Pods, and applies an Unhealthy state if the GameServer main container exits when in a Ready state

func NewHealthController

func NewHealthController(kubeClient kubernetes.Interface, agonesClient versioned.Interface, kubeInformerFactory informers.SharedInformerFactory,
	agonesInformerFactory externalversions.SharedInformerFactory) *HealthController

NewHealthController returns a HealthController

func (*HealthController) Run

func (hc *HealthController) Run(stop <-chan struct{})

Run processes the rate limited queue. Will block until stop is closed

type LocalSDKServer

type LocalSDKServer struct {
}

LocalSDKServer type is the SDKServer implementation for when the sidecar is being run for local development, and doesn't connect to the Kubernetes cluster

func (*LocalSDKServer) GetGameServer

func (l *LocalSDKServer) GetGameServer(context.Context, *sdk.Empty) (*sdk.GameServer, error)

GetGameServer returns a dummy game server.

func (*LocalSDKServer) Health

func (l *LocalSDKServer) Health(stream sdk.SDK_HealthServer) error

Health logs each health ping that comes down the stream

func (*LocalSDKServer) Ready

func (l *LocalSDKServer) Ready(context.Context, *sdk.Empty) (*sdk.Empty, error)

Ready logs that the Ready request has been received

func (*LocalSDKServer) Shutdown

func (l *LocalSDKServer) Shutdown(context.Context, *sdk.Empty) (*sdk.Empty, error)

Shutdown logs that the shutdown request has been received

type PortAllocator

type PortAllocator struct {
	// contains filtered or unexported fields
}

PortAllocator manages the dynamic port allocation strategy. Only use exposed methods to ensure appropriate locking is taken. The PortAllocator does not currently support mixing static portAllocations (or any pods with defined HostPort) within the dynamic port range other than the ones it coordinates.

func NewPortAllocator

func NewPortAllocator(minPort, maxPort int32,
	kubeInformerFactory informers.SharedInformerFactory,
	agonesInformerFactory externalversions.SharedInformerFactory) *PortAllocator

NewPortAllocator returns a new dynamic port allocator. minPort and maxPort are the top and bottom portAllocations that can be allocated in the range for the game servers

func (*PortAllocator) Allocate

func (pa *PortAllocator) Allocate(gs *v1alpha1.GameServer) (*v1alpha1.GameServer, error)

Allocate assigns a port to the GameServer and returns it. Return ErrPortNotFound if no port is allocatable

func (*PortAllocator) DeAllocate

func (pa *PortAllocator) DeAllocate(gs *v1alpha1.GameServer)

DeAllocate marks the given port as no longer allocated

func (*PortAllocator) Run

func (pa *PortAllocator) Run(stop <-chan struct{}) error

Run sets up the current state of port allocations and starts tracking Pod and Node changes

type SDKServer

type SDKServer struct {
	// contains filtered or unexported fields
}

SDKServer is a gRPC server, that is meant to be a sidecar for a GameServer that will update the game server status on SDK requests

func NewSDKServer

func NewSDKServer(gameServerName, namespace string,
	healthDisabled bool, healthTimeout time.Duration, healthFailureThreshold int64, healthInitialDelay time.Duration,
	kubeClient kubernetes.Interface,
	agonesClient versioned.Interface) (*SDKServer, error)

NewSDKServer creates a SDKServer that sets up an InClusterConfig for Kubernetes

func (*SDKServer) GetGameServer

func (s *SDKServer) GetGameServer(context.Context, *sdk.Empty) (*sdk.GameServer, error)

GetGameServer returns the current GameServer configuration and state from the backing GameServer CRD

func (*SDKServer) Health

func (s *SDKServer) Health(stream sdk.SDK_HealthServer) error

Health receives each health ping, and tracks the last time the health check was received, to track if a GameServer is healthy

func (*SDKServer) Ready

func (s *SDKServer) Ready(ctx context.Context, e *sdk.Empty) (*sdk.Empty, error)

Ready enters the RequestReady state change for this GameServer into the workqueue so it can be updated

func (*SDKServer) Run

func (s *SDKServer) Run(stop <-chan struct{})

Run processes the rate limited queue. Will block until stop is closed

func (*SDKServer) Shutdown

func (s *SDKServer) Shutdown(ctx context.Context, e *sdk.Empty) (*sdk.Empty, error)

Shutdown enters the Shutdown state change for this GameServer into the workqueue so it can be updated