allocation

Documentation

Overview

Package allocation contains all the route allocation controllers.

Index

• type RouteAllocationController
  • func (c *RouteAllocationController) AllocateRouterShard(route *routeapi.Route) (*routeapi.RouterShard, error)
  • func (c *RouteAllocationController) GenerateHostname(route *routeapi.Route, shard *routeapi.RouterShard) string
• type RouteAllocationControllerFactory
  • func (factory *RouteAllocationControllerFactory) Create(plugin route.AllocationPlugin) *RouteAllocationController

Types

type RouteAllocationController

type RouteAllocationController struct {
	Plugin route.AllocationPlugin
}

RouteAllocationController abstracts the details of how routes are allocated to router shards.

func (*RouteAllocationController) AllocateRouterShard

func (c *RouteAllocationController) AllocateRouterShard(route *routeapi.Route) (*routeapi.RouterShard, error)

AllocateRouterShard allocates a router shard for the given route.

func (*RouteAllocationController) GenerateHostname

func (c *RouteAllocationController) GenerateHostname(route *routeapi.Route, shard *routeapi.RouterShard) string

GenerateHostname generates a host name for the given route and router shard combination.

type RouteAllocationControllerFactory

type RouteAllocationControllerFactory struct {
	// OSClient is is an OpenShift client.
	OSClient osclient.Interface

	// KubeClient is a Kubernetes client.
	KubeClient kclient.Interface
}

RouteAllocationControllerFactory creates a RouteAllocationController that allocates router shards to specific routes.

func (*RouteAllocationControllerFactory) Create

func (factory *RouteAllocationControllerFactory) Create(plugin route.AllocationPlugin) *RouteAllocationController

Create a RouteAllocationController instance.