vulcan

Documentation

Index

• type Config
• type Endpoint
  • func NewEndpoint(name, listenIP string, listenPort int) (*Endpoint, error)
  • func (e *Endpoint) BackendSpec() (string, error)
  • func (e *Endpoint) ServerSpec() (string, error)
  • func (e *Endpoint) String() string
• type Location
  • func NewLocation(host string, methods []string, path, upstream string, ...) *Location
  • func (l *Location) Route() string
  • func (l *Location) Spec() (string, error)
  • func (l *Location) String() string
• type LocationOptions
  • func (o LocationOptions) String() string
• type Registry
  • func NewRegistry(config Config) *Registry
  • func (r *Registry) RegisterBackend(e *Endpoint) error
  • func (r *Registry) RegisterEndpoint(e *Endpoint) error
  • func (r *Registry) RegisterFrontend(l *Location) error
  • func (r *Registry) RegisterLocation(l *Location) error
  • func (r *Registry) RegisterServer(e *Endpoint) error

Types

type Config

type Config struct {
	PublicAPIHost    string
	ProtectedAPIHost string
}

type Endpoint

type Endpoint struct {
	ID   string
	Name string
	URL  string
}

func NewEndpoint

func NewEndpoint(name, listenIP string, listenPort int) (*Endpoint, error)

func (*Endpoint) BackendSpec

func (e *Endpoint) BackendSpec() (string, error)

func (*Endpoint) ServerSpec

func (e *Endpoint) ServerSpec() (string, error)

func (*Endpoint) String

func (e *Endpoint) String() string

type Location

type Location struct {
	ID          string
	Host        string
	Path        string
	URLPath     string
	Methods     []string
	Upstream    string
	Options     LocationOptions
	Middlewares []middleware.Middleware
}

func NewLocation

func NewLocation(host string, methods []string, path, upstream string, middlewares []middleware.Middleware) *Location

func (*Location) Route

func (l *Location) Route() string

func (*Location) Spec

func (l *Location) Spec() (string, error)

func (*Location) String

func (l *Location) String() string

type LocationOptions

type LocationOptions struct {
	FailoverPredicate string `json:"FailoverPredicate"`
}

func (LocationOptions) String

func (o LocationOptions) String() string

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry(config Config) *Registry

func (*Registry) RegisterBackend

func (r *Registry) RegisterBackend(e *Endpoint) error

func (*Registry) RegisterEndpoint

func (r *Registry) RegisterEndpoint(e *Endpoint) error

func (*Registry) RegisterFrontend

func (r *Registry) RegisterFrontend(l *Location) error

func (*Registry) RegisterLocation

func (r *Registry) RegisterLocation(l *Location) error

RegisterLocation registers a provided location in vulcan.

func (*Registry) RegisterServer

func (r *Registry) RegisterServer(e *Endpoint) error