route

Documentation

Overview

Package route provides support for managing and watching routes. It defines a Route resource type, along with associated storage.

A Route object allows the user to specify a DNS / alias for a Kubernetes service. It stores the ID of the Service (ServiceName) and the DNS/alias (Name). The Route can be used to specify just the DNS/alias or it could also include port and/or the path.

The Route model includes the following attributes to specify the frontend URL:

• Host: Alias/DNS that points to the service. Can be host or host:port
• Path: Path allows the router to perform fine-grained routing

The Route resources can be used by routers and load balancers to route external inbound traffic. The proxy is expected to have frontend mappings for the Route.Name in its configuration. For its endpoints, a proxy could either forward the traffic to the Kubernetes Service port and let it do the load balancing and routing. Alternately, a more meaningful implementation of a router could take the endpoints for the service and route/load balance the incoming requests to the corresponding service endpoints.

Index

• type AllocationPlugin
• type RouteAllocator

Types

type AllocationPlugin

type AllocationPlugin interface {
	Allocate(*api.Route) (*api.RouterShard, error)
	GenerateHostname(*api.Route, *api.RouterShard) string
}

AllocationPlugin is the interface the route controller dispatches requests for RouterShard allocation and name generation.

type RouteAllocator

type RouteAllocator interface {
	AllocateRouterShard(*api.Route) (*api.RouterShard, error)
	GenerateHostname(*api.Route, *api.RouterShard) string
}

RouteAllocator is the interface for the route allocation controller which handles requests for RouterShard allocation and name generation.