api

Documentation

Index

• type Route
  • func (*Route) IsAnAPIObject()
• type RouteList
  • func (*RouteList) IsAnAPIObject()

Types

type Route

type Route struct {
	kapi.TypeMeta `json:",inline" yaml:",inline"`

	// Required: Alias/DNS that points to the service
	// Can be host or host:port
	// host and port are combined to follow the net/url URL struct
	Host string `json:"host" yaml:"host"`
	// Optional: Path that the router watches for, to route traffic for to the service
	Path string `json:"path,omitempty" yaml:"path,omitempty"`

	// the name of the service that this route points to
	ServiceName string            `json:"serviceName" yaml:"serviceName"`
	Labels      map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
}

Route encapsulates the inputs needed to connect a DNS/alias to a service proxy.

func (*Route) IsAnAPIObject

func (*Route) IsAnAPIObject()

type RouteList

type RouteList struct {
	kapi.TypeMeta `json:",inline" yaml:",inline"`
	Items         []Route `json:"items,omitempty" yaml:"items,omitempty"`
}

RouteList is a collection of Routes.

func (*RouteList) IsAnAPIObject

func (*RouteList) IsAnAPIObject()