baaah

Documentation

Index

• func DefaultRouter(routerName string, scheme *runtime.Scheme) (*router.Router, error)
• func NewRouter(handlerName string, opts *Options) (*router.Router, error)
• type Options
  • func DefaultOptions(routerName string, scheme *runtime.Scheme) (*Options, error)

Functions

func DefaultRouter

func DefaultRouter(routerName string, scheme *runtime.Scheme) (*router.Router, error)

DefaultRouter The routerName is important as this name will be used to assign ownership of objects created by this router. Specifically the routerName is assigned to the sub-context in the apply actions. Additionally, the routerName will be used for the leader election lease lock.

func NewRouter

func NewRouter(handlerName string, opts *Options) (*router.Router, error)

Types

type Options

type Options struct {
	// If the backend is nil, then DefaultRESTConfig, DefaultNamespace, and Scheme are used to create a backend.
	Backend backend.Backend
	// If a Backend is provided, then this is ignored. If not provided and needed, then a default is created with Scheme.
	DefaultRESTConfig *rest.Config
	// If a Backend is provided, then this is ignored.
	DefaultNamespace string
	// If a Backend is provided, then this is ignored.
	Scheme *runtime.Scheme
	// APIGroupConfigs are keyed by an API group. This indicates to the router that all actions on this group should use the
	// given Config. This is useful for routers that watch different objects on different API servers.
	APIGroupConfigs map[string]bruntime.Config
	// ElectionConfig being nil represents no leader election for the router.
	ElectionConfig *leader.ElectionConfig
	// Defaults to 8888
	HealthzPort int
}

func DefaultOptions

func DefaultOptions(routerName string, scheme *runtime.Scheme) (*Options, error)

DefaultOptions represent the standard options for a Router. The default leader election uses a lease lock and a TTL of 15 seconds.