route

package
v3.11.0-alpha.0 Latest Latest
Warning

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

Go to latest
Published: Jun 15, 2018 License: Apache-2.0 Imports: 1 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.

Directories

Path Synopsis
Package allocation contains all the route allocation plugins.
Package allocation contains all the route allocation plugins.
simple
Package simple contains the SimpleAllocation route plugin.
Package simple contains the SimpleAllocation route plugin.
apis
route
+groupName=route.openshift.io Package api is the internal version of the API.
+groupName=route.openshift.io Package api is the internal version of the API.
route/v1
+groupName=route.openshift.io Package v1 is the v1 version of the API.
+groupName=route.openshift.io Package v1 is the v1 version of the API.
Package controller contains all the route handling controllers.
Package controller contains all the route handling controllers.
allocation
Package allocation contains all the route allocation controllers.
Package allocation contains all the route allocation controllers.
generated
internalclientset
This package has the automatically generated clientset.
This package has the automatically generated clientset.
internalclientset/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
internalclientset/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
internalclientset/typed/route/internalversion
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
internalclientset/typed/route/internalversion/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
Package generator implements the Generator interface for routes
Package generator implements the Generator interface for routes
registry

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL