router

Documentation

Overview

Package router provides interfaces that need to be satisfied in order to implement a new router on tsuru.

Index

• Variables
• func BuildHealthCheck(routerName string) func() error
• func IsSwapped(name string) (bool, string, error)
• func Register(name string, r routerFactory)
• func Remove(appName string) error
• func Retrieve(appName string) (string, error)
• func Store(appName, routerName, kind string) error
• func Swap(r Router, backend1, backend2 string) error
• func ValidCName(cname, domain string) bool
• type HealthChecker
• type MessageRouter
• type PlanRouter
  • func List() ([]PlanRouter, error)
• type Router
  • func Get(name string) (Router, error)
• type RouterError
  • func (e *RouterError) Error() string

Variables

var (
	ErrBackendExists   = errors.New("Backend already exists")
	ErrBackendNotFound = errors.New("Backend not found")
	ErrBackendSwapped  = errors.New("Backend is swapped cannot remove")
	ErrRouteExists     = errors.New("Route already exists")
	ErrRouteNotFound   = errors.New("Route not found")
	ErrCNameExists     = errors.New("CName already exists")
	ErrCNameNotFound   = errors.New("CName not found")
	ErrCNameNotAllowed = errors.New("CName as router subdomain not allowed")
)

Functions

func BuildHealthCheck

func BuildHealthCheck(routerName string) func() error

BuildHealthCheck creates a healthcheck function for the given routerName.

It will call the HealthCheck() method in the router (only if it's also a HealthChecker), for each instance of it (including the "main" instance and all custom routers).

func IsSwapped

func IsSwapped(name string) (bool, string, error)

func Register

func Register(name string, r routerFactory)

Register registers a new router.

func Remove

func Remove(appName string) error

func Retrieve

func Retrieve(appName string) (string, error)

func Store

func Store(appName, routerName, kind string) error

Store stores the app name related with the router name.

func Swap

func Swap(r Router, backend1, backend2 string) error

func ValidCName

func ValidCName(cname, domain string) bool

validCName returns true if the cname is not a subdomain of the router current domain, false otherwise.

Types

type HealthChecker

type HealthChecker interface {
	HealthCheck() error
}

type MessageRouter

type MessageRouter interface {
	StartupMessage() (string, error)
}

type PlanRouter

type PlanRouter struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

func List

func List() ([]PlanRouter, error)

type Router

type Router interface {
	AddBackend(name string) error
	RemoveBackend(name string) error
	AddRoute(name string, address *url.URL) error
	RemoveRoute(name string, address *url.URL) error
	SetCName(cname, name string) error
	UnsetCName(cname, name string) error
	Addr(name string) (string, error)

	// Swap change the router between two backends.
	Swap(string, string) error

	// Routes returns a list of routes of a backend.
	Routes(name string) ([]*url.URL, error)
}

Router is the basic interface of this package. It provides methods for managing backends and routes. Each backend can have multiple routes.

func Get

func Get(name string) (Router, error)

Get gets the named router from the registry.

type RouterError

type RouterError struct {
	Op  string
	Err error
}

func (*RouterError) Error

func (e *RouterError) Error() string