cloudproduct

Documentation

Overview

Package cloudproduct provides an abstraction layer to product specific functionality

Index

• func BindEnv() error
• func BindFlags()
• func Initialize(ctx context.Context, kc *kubernetes.Clientset) (err error)
• type ControllerHooksInterface
  • func ControllerHooks() ControllerHooksInterface

Functions

func BindEnv

func BindEnv() error

BindEnv binds the CLOUD_PRODUCT env variable.

func BindFlags

func BindFlags()

BindFlags binds the --cloud-product flag.

func Initialize

func Initialize(ctx context.Context, kc *kubernetes.Clientset) (err error)

Initialize initializes the cloud product from the viper flag. Caller must use BindFlags and BindEnv prior. If this function returns an error, caller should exit, as calling ControllerHooks() after a bad initialization will return a nil interface

Types

type ControllerHooksInterface

type ControllerHooksInterface interface {
	// SyncPodPortsToGameServer runs after a Pod has been assigned to a Node and before we sync
	// Pod host ports to the GameServer status.
	SyncPodPortsToGameServer(*agonesv1.GameServer, *corev1.Pod) error

	// NewPortAllocator creates a PortAllocator. See gameservers.NewPortAllocator for parameters.
	NewPortAllocator(int32, int32, informers.SharedInformerFactory, externalversions.SharedInformerFactory) portallocator.Interface
}

ControllerHooksInterface provides a generic interface that abstracts cloud product specific functionality for pkg/controller packages.

func ControllerHooks

func ControllerHooks() ControllerHooksInterface

ControllerHooks returns the global cloud product controller hooks. If the global singleton is not set, we initialize the current cloud product to the "generic" product - this should only happen in unit tests.