controller

package
v3.11.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2018 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Overview

Package controller contains the router controller.

Index

Constants

This section is empty.

Variables

View Source 
var LogRejections = logRecorder{}

LogRejections writes rejection messages to the log.

Functions

func HostForRoute added in v1.0.6 

func HostForRoute(route *routev1.Route) string

HostForRoute returns the host set on the route.

func ValidateHostName 

func ValidateHostName(route *routev1.Route) field.ErrorList

ValidateHostName checks that a route's host name satisfies DNS requirements.

Types

type ContentionTracker 

type ContentionTracker interface {
	// IsContended should be invoked when the state of the object in storage differs
	// from the desired state. It will return true if the provided id was recently
	// reset from the correct state to an incorrect state. The current ingress is the
	// expected state of the object at this time and may be used by the tracker to
	// determine if the most recent update was a contention. This method does not
	// update the state of the tracker.
	IsChangeContended(id string, now time.Time, current *routev1.RouteIngress) bool
	// Clear informs the tracker that the provided ingress state was confirmed to
	// match the current state of this process. If a subsequent call to IsChangeContended
	// is made within the expiration window, the object will be considered as contended.
	Clear(id string, current *routev1.RouteIngress)
}

ContentionTracker records modifications to a particular entry to prevent endless loops when multiple routers are configured with conflicting info. A given router process tracks whether the ingress status is change from a correct value to any other value (by invoking IsContended when the state has diverged).

type ExtendedValidator added in v1.3.0 

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

ExtendedValidator implements the router.Plugin interface to provide extended config validation for template based, backend-agnostic routers.

func NewExtendedValidator added in v1.3.0 

func NewExtendedValidator(plugin router.Plugin, recorder RejectionRecorder) *ExtendedValidator

NewExtendedValidator creates a plugin wrapper that ensures only routes that pass extended validation are relayed to the next plugin in the chain. Recorder is an interface for indicating why a route was rejected.

func (*ExtendedValidator) Commit added in v1.5.0 

func (p *ExtendedValidator) Commit() error

func (*ExtendedValidator) HandleEndpoints added in v1.3.0 

func (p *ExtendedValidator) HandleEndpoints(eventType watch.EventType, endpoints *kapi.Endpoints) error

HandleEndpoints processes watch events on the Endpoints resource.

func (*ExtendedValidator) HandleNamespaces added in v1.3.0 

func (p *ExtendedValidator) HandleNamespaces(namespaces sets.String) error

HandleNamespaces limits the scope of valid routes to only those that match the provided namespace list.

func (*ExtendedValidator) HandleNode added in v1.4.0 

func (p *ExtendedValidator) HandleNode(eventType watch.EventType, node *kapi.Node) error

HandleNode processes watch events on the node resource

func (*ExtendedValidator) HandleRoute added in v1.3.0 

func (p *ExtendedValidator) HandleRoute(eventType watch.EventType, route *routev1.Route) error

HandleRoute processes watch events on the Route resource.

type HostAdmitter added in v1.4.0 

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

HostAdmitter implements the router.Plugin interface to add admission control checks for routes in template based, backend-agnostic routers.

func NewHostAdmitter added in v1.4.0 

func NewHostAdmitter(plugin router.Plugin, fn RouteAdmissionFunc, allowWildcards, disableNamespaceCheck bool, recorder RejectionRecorder) *HostAdmitter

NewHostAdmitter creates a plugin wrapper that checks whether or not to admit routes and relay them to the next plugin in the chain. Recorder is an interface for indicating why a route was rejected.

func (*HostAdmitter) Commit added in v1.5.0 

func (p *HostAdmitter) Commit() error

func (*HostAdmitter) HandleEndpoints added in v1.4.0 

func (p *HostAdmitter) HandleEndpoints(eventType watch.EventType, endpoints *kapi.Endpoints) error

HandleEndpoints processes watch events on the Endpoints resource.

func (*HostAdmitter) HandleNamespaces added in v1.4.0 

func (p *HostAdmitter) HandleNamespaces(namespaces sets.String) error

HandleNamespaces limits the scope of valid routes to only those that match the provided namespace list.

func (*HostAdmitter) HandleNode added in v1.4.0 

func (p *HostAdmitter) HandleNode(eventType watch.EventType, node *kapi.Node) error

HandleNode processes watch events on the Node resource.

func (*HostAdmitter) HandleRoute added in v1.4.0 

func (p *HostAdmitter) HandleRoute(eventType watch.EventType, route *routev1.Route) error

HandleRoute processes watch events on the Route resource.

type RejectionRecorder added in v1.1.3 

type RejectionRecorder interface {
	RecordRouteRejection(route *routev1.Route, reason, message string)
}

RejectionRecorder is an object capable of recording why a route was rejected

type RouteAdmissionFunc added in v1.4.0 

type RouteAdmissionFunc func(*routev1.Route) error

RouteAdmissionFunc determines whether or not to admit a route.

type RouteHostFunc added in v1.0.6 

type RouteHostFunc func(*routev1.Route) string

RouteHostFunc returns a host for a route. It may return an empty string.

type RouteMap added in v1.4.0 

type RouteMap map[string][]*routev1.Route

RouteMap contains all routes associated with a key

func (RouteMap) InsertRoute added in v1.4.0 

func (srm RouteMap) InsertRoute(key string, route *routev1.Route)

func (RouteMap) RemoveRoute added in v1.4.0 

func (srm RouteMap) RemoveRoute(key string, route *routev1.Route) bool

RemoveRoute removes any existing routes that match the given route's namespace and name for a key

type RouterController 

type RouterController struct {
	Plugin router.Plugin

	FilteredNamespaceNames sets.String
	NamespaceLabels        labels.Selector
	// Holds Namespace --> RouteName --> RouteObject
	NamespaceRoutes map[string]map[string]*routev1.Route
	// Holds Namespace --> EndpointsName --> EndpointsObject
	NamespaceEndpoints map[string]map[string]*kapi.Endpoints

	ProjectClient       projectclient.ProjectInterface
	ProjectLabels       labels.Selector
	ProjectSyncInterval time.Duration
	ProjectWaitInterval time.Duration
	ProjectRetries      int

	WatchNodes bool
	// contains filtered or unexported fields
}

RouterController abstracts the details of watching resources like Routes, Endpoints, etc. used by the plugin implementation.

func (*RouterController) Commit 

func (c *RouterController) Commit()

Commit notifies the plugin that it is safe to commit state.

func (*RouterController) GetFilteredProjectNames 

func (c *RouterController) GetFilteredProjectNames() (sets.String, error)

func (*RouterController) HandleEndpoints 

func (c *RouterController) HandleEndpoints(eventType watch.EventType, obj interface{})

HandleEndpoints handles a single Endpoints event and refreshes the router backend.

func (*RouterController) HandleNamespace 

func (c *RouterController) HandleNamespace(eventType watch.EventType, obj interface{})

func (*RouterController) HandleNode added in v1.4.0 

func (c *RouterController) HandleNode(eventType watch.EventType, obj interface{})

HandleNode handles a single Node event and synchronizes the router backend

func (*RouterController) HandleProjects 

func (c *RouterController) HandleProjects()

func (*RouterController) HandleRoute 

func (c *RouterController) HandleRoute(eventType watch.EventType, obj interface{})

HandleRoute handles a single Route event and synchronizes the router backend.

func (*RouterController) RecordNamespaceEndpoints 

func (c *RouterController) RecordNamespaceEndpoints(eventType watch.EventType, ep *kapi.Endpoints)

func (*RouterController) RecordNamespaceRoutes 

func (c *RouterController) RecordNamespaceRoutes(eventType watch.EventType, rt *routev1.Route)

func (*RouterController) Run 

func (c *RouterController) Run()

Run begins watching and syncing.

func (*RouterController) UpdateNamespaces 

func (c *RouterController) UpdateNamespaces()

type SimpleContentionTracker 

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

SimpleContentionTracker tracks whether a given identifier is changed from a correct state (set by Clear) to an incorrect state (inferred by calling IsContended).

func NewSimpleContentionTracker 

func NewSimpleContentionTracker(informer cache.SharedInformer, routerName string, interval time.Duration) *SimpleContentionTracker

NewSimpleContentionTracker creates a ContentionTracker that will prevent writing to the same route more often than once per interval. A background process will periodically flush old entries (at twice interval) in order to prevent the list growing unbounded if routes are created and deleted frequently. The informer detects changes to ingress records for routerName and will advance the tracker state from candidate to contended if the host, wildcardPolicy, or canonical host name fields are repeatedly updated.

func (*SimpleContentionTracker) Changed 

func (t *SimpleContentionTracker) Changed(id string, current *routev1.RouteIngress)

Changed records that a change to an ingress value was detected. This is called from a separate goroutine and may have seen newer events than the current route controller plugins, so we don't do direct time comparisons. Instead we count edge transitions on a given id.

func (*SimpleContentionTracker) Clear 

func (t *SimpleContentionTracker) Clear(id string, current *routev1.RouteIngress)

func (*SimpleContentionTracker) IsChangeContended 

func (t *SimpleContentionTracker) IsChangeContended(id string, now time.Time, current *routev1.RouteIngress) bool

func (*SimpleContentionTracker) Run 

func (t *SimpleContentionTracker) Run(stopCh <-chan struct{})

Run starts the background cleanup process for expired items.

func (*SimpleContentionTracker) SetConflictMessage 

func (t *SimpleContentionTracker) SetConflictMessage(message string)

SetConflictMessage will print message whenever contention with another writer is detected.

type StatusAdmitter added in v1.1.3 

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

StatusAdmitter ensures routes added to the plugin have status set.

func NewStatusAdmitter added in v1.1.3 

func NewStatusAdmitter(plugin router.Plugin, client client.RoutesGetter, lister routelisters.RouteLister, name, hostName string, lease writerlease.Lease, tracker ContentionTracker) *StatusAdmitter

NewStatusAdmitter creates a plugin wrapper that ensures every accepted route has a status field set that matches this router. The admitter manages an LRU of recently seen conflicting updates to handle when two router processes with differing configurations are writing updates at the same time.

func (*StatusAdmitter) Commit added in v1.5.0 

func (a *StatusAdmitter) Commit() error

func (*StatusAdmitter) HandleEndpoints added in v1.1.3 

func (a *StatusAdmitter) HandleEndpoints(eventType watch.EventType, route *kapi.Endpoints) error

func (*StatusAdmitter) HandleNamespaces added in v1.1.3 

func (a *StatusAdmitter) HandleNamespaces(namespaces sets.String) error

func (*StatusAdmitter) HandleNode added in v1.4.0 

func (a *StatusAdmitter) HandleNode(eventType watch.EventType, node *kapi.Node) error

func (*StatusAdmitter) HandleRoute added in v1.1.3 

func (a *StatusAdmitter) HandleRoute(eventType watch.EventType, route *routev1.Route) error

HandleRoute attempts to admit the provided route on watch add / modifications.

func (*StatusAdmitter) RecordRouteRejection added in v1.1.3 

func (a *StatusAdmitter) RecordRouteRejection(route *routev1.Route, reason, message string)

RecordRouteRejection attempts to update the route status with a reason for a route being rejected.

type UniqueHost added in v1.0.6 

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

UniqueHost implements the router.Plugin interface to provide a template based, backend-agnostic router.

func NewUniqueHost added in v1.0.6 

func NewUniqueHost(plugin router.Plugin, disableOwnershipCheck bool, recorder RejectionRecorder) *UniqueHost

NewUniqueHost creates a plugin wrapper that ensures only unique routes are passed into the underlying plugin. Recorder is an interface for indicating why a route was rejected.

func (*UniqueHost) Commit added in v1.5.0 

func (p *UniqueHost) Commit() error

Commit invokes the nested plugin to commit.

func (*UniqueHost) HandleEndpoints added in v1.0.6 

func (p *UniqueHost) HandleEndpoints(eventType watch.EventType, endpoints *kapi.Endpoints) error

HandleEndpoints processes watch events on the Endpoints resource.

func (*UniqueHost) HandleNamespaces added in v1.0.6 

func (p *UniqueHost) HandleNamespaces(namespaces sets.String) error

HandleNamespaces limits the scope of valid routes to only those that match the provided namespace list.

func (*UniqueHost) HandleNode added in v1.4.0 

func (p *UniqueHost) HandleNode(eventType watch.EventType, node *kapi.Node) error

HandleNode processes watch events on the Node resource and calls the router

func (*UniqueHost) HandleRoute added in v1.0.6 

func (p *UniqueHost) HandleRoute(eventType watch.EventType, route *routev1.Route) error

HandleRoute processes watch events on the Route resource. TODO: this function can probably be collapsed with the router itself, as a function that 

determines which component needs to be recalculated (which template) and then does so
on demand.

func (*UniqueHost) HostLen added in v1.0.6 

func (p *UniqueHost) HostLen() int

HostLen returns the number of hosts currently tracked by this plugin.

func (*UniqueHost) RoutesForHost added in v1.0.6 

func (p *UniqueHost) RoutesForHost(host string) ([]*routev1.Route, bool)

RoutesForHost is a helper that allows routes to be retrieved.

Source Files

View all Source files

Directories

Path Synopsis
Package factory contains code used to create the router controller.
 Package factory contains code used to create the router controller.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.